utils.js 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585
  1. "use strict";
  2. Object.defineProperty(exports, "__esModule", {
  3. value: true
  4. });
  5. exports.createEvaluator = createEvaluator;
  6. exports.getStylusImplementation = getStylusImplementation;
  7. exports.getStylusOptions = getStylusOptions;
  8. exports.normalizeSourceMap = normalizeSourceMap;
  9. exports.readFile = readFile;
  10. exports.resolveFilename = resolveFilename;
  11. exports.urlResolver = urlResolver;
  12. var _url = require("url");
  13. var _path = _interopRequireDefault(require("path"));
  14. var _stylus = require("stylus");
  15. var _depsResolver = _interopRequireDefault(require("stylus/lib/visitor/deps-resolver"));
  16. var _full = require("klona/full");
  17. var _fastGlob = _interopRequireDefault(require("fast-glob"));
  18. var _normalizePath = _interopRequireDefault(require("normalize-path"));
  19. function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
  20. // Examples:
  21. // - ~package
  22. // - ~package/
  23. // - ~@org
  24. // - ~@org/
  25. // - ~@org/package
  26. // - ~@org/package/
  27. const IS_MODULE_IMPORT = /^~([^/]+|[^/]+\/|@[^/]+[/][^/]+|@[^/]+\/?|@[^/]+[/][^/]+\/)$/;
  28. const MODULE_REQUEST_REGEX = /^[^?]*~/;
  29. function isProductionLikeMode(loaderContext) {
  30. return loaderContext.mode === "production" || !loaderContext.mode;
  31. }
  32. function getStylusOptions(loaderContext, loaderOptions) {
  33. const stylusOptions = (0, _full.klona)(typeof loaderOptions.stylusOptions === "function" ? loaderOptions.stylusOptions(loaderContext) || {} : loaderOptions.stylusOptions || {});
  34. stylusOptions.filename = loaderContext.resourcePath;
  35. stylusOptions.dest = _path.default.dirname(loaderContext.resourcePath); // Keep track of imported files (used by Stylus CLI watch mode)
  36. // eslint-disable-next-line no-underscore-dangle
  37. stylusOptions._imports = []; // https://github.com/stylus/stylus/issues/2119
  38. stylusOptions.resolveURL = typeof stylusOptions.resolveURL === "boolean" && !stylusOptions.resolveURL ? false : typeof stylusOptions.resolveURL === "object" ? stylusOptions.resolveURL : {
  39. nocheck: true
  40. };
  41. if (typeof stylusOptions.compress === "undefined" && isProductionLikeMode(loaderContext)) {
  42. stylusOptions.compress = true;
  43. }
  44. return stylusOptions;
  45. }
  46. function getStylusImplementation(loaderContext, implementation) {
  47. let resolvedImplementation = implementation;
  48. if (!implementation || typeof implementation === "string") {
  49. const stylusImplPkg = implementation || "stylus";
  50. try {
  51. // eslint-disable-next-line import/no-dynamic-require, global-require
  52. resolvedImplementation = require(stylusImplPkg);
  53. } catch (error) {
  54. loaderContext.emitError(error); // eslint-disable-next-line consistent-return
  55. return;
  56. }
  57. } // eslint-disable-next-line consistent-return
  58. return resolvedImplementation;
  59. }
  60. function getPossibleRequests(loaderContext, filename) {
  61. let request = filename; // A `~` makes the url an module
  62. if (MODULE_REQUEST_REGEX.test(filename)) {
  63. request = request.replace(MODULE_REQUEST_REGEX, "");
  64. }
  65. if (IS_MODULE_IMPORT.test(filename)) {
  66. request = request[request.length - 1] === "/" ? request : `${request}/`;
  67. }
  68. return [...new Set([request, filename])];
  69. }
  70. async function resolveFilename(loaderContext, fileResolver, globResolver, isGlob, context, filename) {
  71. const possibleRequests = getPossibleRequests(loaderContext, filename);
  72. let result;
  73. try {
  74. result = await resolveRequests(context, possibleRequests, fileResolver);
  75. } catch (error) {
  76. if (isGlob) {
  77. const [globTask] = _fastGlob.default.generateTasks(filename);
  78. if (globTask.base === ".") {
  79. throw new Error('Glob resolving without a glob base ("~**/*") is not supported, please specify a glob base ("~package/**/*")');
  80. }
  81. const possibleGlobRequests = getPossibleRequests(loaderContext, globTask.base);
  82. let globResult;
  83. try {
  84. globResult = await resolveRequests(context, possibleGlobRequests, globResolver);
  85. } catch (globError) {
  86. throw globError;
  87. }
  88. loaderContext.addContextDependency(globResult);
  89. const patterns = filename.replace(new RegExp(`^${globTask.base}`), (0, _normalizePath.default)(globResult));
  90. const paths = await (0, _fastGlob.default)(patterns, {
  91. absolute: true,
  92. cwd: globResult
  93. });
  94. return paths.sort().filter(file => /\.styl$/i.test(file));
  95. }
  96. throw error;
  97. }
  98. return result;
  99. }
  100. async function resolveRequests(context, possibleRequests, resolve) {
  101. if (possibleRequests.length === 0) {
  102. return Promise.reject();
  103. }
  104. let result;
  105. try {
  106. result = await resolve(context, possibleRequests[0]);
  107. } catch (error) {
  108. const [, ...tailPossibleRequests] = possibleRequests;
  109. if (tailPossibleRequests.length === 0) {
  110. throw error;
  111. }
  112. result = await resolveRequests(context, tailPossibleRequests, resolve);
  113. }
  114. return result;
  115. }
  116. const URL_RE = /^(?:url\s*\(\s*)?['"]?(?:[#/]|(?:https?:)?\/\/)/i;
  117. async function getDependencies(resolvedDependencies, loaderContext, fileResolver, globResolver, seen, code, filename, options) {
  118. seen.add(filename); // See https://github.com/stylus/stylus/issues/2108
  119. const newOptions = (0, _full.klona)({ ...options,
  120. filename,
  121. cache: false
  122. });
  123. const parser = new _stylus.Parser(code, newOptions);
  124. let ast;
  125. try {
  126. ast = parser.parse();
  127. } catch (error) {
  128. loaderContext.emitError(error);
  129. return;
  130. }
  131. const dependencies = [];
  132. class ImportVisitor extends _depsResolver.default {
  133. // eslint-disable-next-line class-methods-use-this
  134. visitImport(node) {
  135. let firstNode = node.path.first;
  136. if (firstNode.name === "url") {
  137. return;
  138. }
  139. if (!firstNode.val) {
  140. const evaluator = new _stylus.Evaluator(ast);
  141. firstNode = evaluator.visit.call(evaluator, firstNode).first;
  142. }
  143. const originalNodePath = !firstNode.val.isNull && firstNode.val || firstNode.name;
  144. let nodePath = originalNodePath;
  145. if (!nodePath) {
  146. return;
  147. }
  148. let found;
  149. let oldNodePath;
  150. const literal = /\.css(?:"|$)/.test(nodePath);
  151. if (!literal && !/\.styl$/i.test(nodePath)) {
  152. oldNodePath = nodePath;
  153. nodePath += ".styl";
  154. }
  155. const isGlob = _fastGlob.default.isDynamicPattern(nodePath);
  156. found = _stylus.utils.find(nodePath, this.paths, this.filename);
  157. if (found && isGlob) {
  158. const [globTask] = _fastGlob.default.generateTasks(nodePath);
  159. const context = globTask.base === "." ? _path.default.dirname(this.filename) : _path.default.join(_path.default.dirname(this.filename), globTask.base);
  160. loaderContext.addContextDependency(context);
  161. }
  162. if (!found && oldNodePath) {
  163. found = _stylus.utils.lookupIndex(oldNodePath, this.paths, this.filename);
  164. }
  165. if (found) {
  166. dependencies.push({
  167. originalLineno: firstNode.lineno,
  168. originalColumn: firstNode.column,
  169. originalNodePath,
  170. resolved: found.map(item => _path.default.isAbsolute(item) ? item : _path.default.join(process.cwd(), item))
  171. });
  172. return;
  173. }
  174. dependencies.push({
  175. originalLineno: firstNode.lineno,
  176. originalColumn: firstNode.column,
  177. originalNodePath,
  178. resolved: resolveFilename(loaderContext, fileResolver, globResolver, isGlob, _path.default.dirname(this.filename), originalNodePath)
  179. });
  180. }
  181. }
  182. new ImportVisitor(ast, newOptions).visit(ast);
  183. await Promise.all(Array.from(dependencies).map(async result => {
  184. let {
  185. resolved
  186. } = result;
  187. try {
  188. resolved = await resolved;
  189. } catch (ignoreError) {
  190. // eslint-disable-next-line no-param-reassign
  191. delete result.resolved; // eslint-disable-next-line no-param-reassign
  192. result.error = ignoreError;
  193. return;
  194. }
  195. const isArray = Array.isArray(resolved); // `stylus` returns forward slashes on windows
  196. // eslint-disable-next-line no-param-reassign
  197. result.resolved = isArray ? resolved.map(item => _path.default.normalize(item)) : _path.default.normalize(resolved);
  198. const dependenciesOfDependencies = [];
  199. for (const dependency of isArray ? result.resolved : [result.resolved]) {
  200. // Avoid loop, the file is imported by itself
  201. if (seen.has(dependency)) {
  202. return;
  203. } // Avoid search nested imports in .css
  204. if (_path.default.extname(dependency) === ".css") {
  205. return;
  206. }
  207. loaderContext.addDependency(dependency);
  208. dependenciesOfDependencies.push((async () => {
  209. let dependencyCode;
  210. try {
  211. dependencyCode = (await readFile(loaderContext.fs, dependency)).toString();
  212. } catch (error) {
  213. loaderContext.emitError(error);
  214. }
  215. await getDependencies(resolvedDependencies, loaderContext, fileResolver, globResolver, seen, dependencyCode, dependency, options);
  216. })());
  217. }
  218. await Promise.all(dependenciesOfDependencies);
  219. }));
  220. if (dependencies.length > 0) {
  221. resolvedDependencies.set(filename, dependencies);
  222. }
  223. }
  224. function mergeBlocks(blocks) {
  225. let finalBlock;
  226. const adding = item => {
  227. finalBlock.push(item);
  228. };
  229. for (const block of blocks) {
  230. if (finalBlock) {
  231. block.nodes.forEach(adding);
  232. } else {
  233. finalBlock = block;
  234. }
  235. }
  236. return finalBlock;
  237. }
  238. async function createEvaluator(loaderContext, code, options) {
  239. const fileResolve = loaderContext.getResolve({
  240. dependencyType: "stylus",
  241. conditionNames: ["styl", "stylus", "style"],
  242. mainFields: ["styl", "style", "stylus", "main", "..."],
  243. mainFiles: ["index", "..."],
  244. extensions: [".styl", ".css"],
  245. restrictions: [/\.(css|styl)$/i],
  246. preferRelative: true
  247. }); // Get cwd for `fastGlob()`
  248. // No need extra options, because they do not used when `resolveToContext` is `true`
  249. const globResolve = loaderContext.getResolve({
  250. conditionNames: ["styl", "stylus", "style"],
  251. resolveToContext: true,
  252. preferRelative: true
  253. });
  254. const resolvedImportDependencies = new Map();
  255. const resolvedDependencies = new Map();
  256. const seen = new Set();
  257. await getDependencies(resolvedDependencies, loaderContext, fileResolve, globResolve, seen, code, loaderContext.resourcePath, options);
  258. const optionsImports = [];
  259. for (const importPath of options.imports) {
  260. const isGlob = _fastGlob.default.isDynamicPattern(importPath);
  261. optionsImports.push({
  262. importPath,
  263. resolved: resolveFilename(loaderContext, fileResolve, globResolve, isGlob, _path.default.dirname(loaderContext.resourcePath), importPath)
  264. });
  265. }
  266. await Promise.all(optionsImports.map(async result => {
  267. const {
  268. importPath
  269. } = result;
  270. let {
  271. resolved
  272. } = result;
  273. try {
  274. resolved = await resolved;
  275. } catch (ignoreError) {
  276. return;
  277. }
  278. const isArray = Array.isArray(resolved); // `stylus` returns forward slashes on windows
  279. // eslint-disable-next-line no-param-reassign
  280. result.resolved = isArray ? resolved.map(item => _path.default.normalize(item)) : _path.default.normalize(resolved);
  281. resolvedImportDependencies.set(importPath, result);
  282. const dependenciesOfImportDependencies = [];
  283. for (const dependency of isArray ? result.resolved : [result.resolved]) {
  284. dependenciesOfImportDependencies.push((async () => {
  285. let dependencyCode;
  286. try {
  287. dependencyCode = (await readFile(loaderContext.fs, dependency)).toString();
  288. } catch (error) {
  289. loaderContext.emitError(error);
  290. }
  291. await getDependencies(resolvedDependencies, loaderContext, fileResolve, globResolve, seen, dependencyCode, dependency, options);
  292. })());
  293. }
  294. await Promise.all(dependenciesOfImportDependencies);
  295. }));
  296. return class CustomEvaluator extends _stylus.Evaluator {
  297. visitImport(imported) {
  298. this.return += 1;
  299. const node = this.visit(imported.path).first;
  300. const nodePath = !node.val.isNull && node.val || node.name;
  301. this.return -= 1;
  302. let webpackResolveError;
  303. if (node.name !== "url" && nodePath && !URL_RE.test(nodePath)) {
  304. let dependency;
  305. const isEntrypoint = loaderContext.resourcePath === node.filename;
  306. if (isEntrypoint) {
  307. dependency = resolvedImportDependencies.get(nodePath);
  308. }
  309. if (!dependency) {
  310. const dependencies = resolvedDependencies.get(_path.default.normalize(node.filename));
  311. if (dependencies) {
  312. dependency = dependencies.find(item => {
  313. if (item.originalLineno === node.lineno && item.originalColumn === node.column && item.originalNodePath === nodePath) {
  314. if (item.error) {
  315. webpackResolveError = item.error;
  316. } else {
  317. return item.resolved;
  318. }
  319. }
  320. return false;
  321. });
  322. }
  323. }
  324. if (dependency) {
  325. const {
  326. resolved
  327. } = dependency;
  328. if (!Array.isArray(resolved)) {
  329. // Avoid re globbing when resolved import contains glob characters
  330. node.string = _fastGlob.default.escapePath(resolved);
  331. } else if (resolved.length > 0) {
  332. let hasError = false;
  333. const blocks = resolved.map(item => {
  334. const clonedImported = imported.clone();
  335. const clonedNode = this.visit(clonedImported.path).first; // Avoid re globbing when resolved import contains glob characters
  336. clonedNode.string = _fastGlob.default.escapePath(item);
  337. let result;
  338. try {
  339. result = super.visitImport(clonedImported);
  340. } catch (error) {
  341. hasError = true;
  342. }
  343. return result;
  344. });
  345. if (!hasError) {
  346. return mergeBlocks(blocks);
  347. }
  348. }
  349. }
  350. }
  351. let result;
  352. try {
  353. result = super.visitImport(imported);
  354. } catch (error) {
  355. loaderContext.emitError(new Error(`Stylus resolver error: ${error.message}${webpackResolveError ? `\n\nWebpack resolver error: ${webpackResolveError.message}${webpackResolveError.details ? `\n\nWebpack resolver error details:\n${webpackResolveError.details}` : ""}${webpackResolveError.missing ? `\n\nWebpack resolver error missing:\n${webpackResolveError.missing.join("\n")}` : ""}` : ""}`));
  356. return imported;
  357. }
  358. return result;
  359. }
  360. };
  361. }
  362. function urlResolver(options = {}) {
  363. function resolver(url) {
  364. const compiler = new _stylus.Compiler(url);
  365. const {
  366. filename
  367. } = url;
  368. compiler.isURL = true;
  369. const visitedUrl = url.nodes.map(node => compiler.visit(node)).join("");
  370. const splitted = visitedUrl.split("!");
  371. const parsedUrl = (0, _url.parse)(splitted.pop()); // Parse literal
  372. const literal = new _stylus.nodes.Literal(`url("${parsedUrl.href}")`);
  373. let {
  374. pathname
  375. } = parsedUrl;
  376. let {
  377. dest
  378. } = this.options;
  379. let tail = "";
  380. let res; // Absolute or hash
  381. if (parsedUrl.protocol || !pathname || pathname[0] === "/") {
  382. return literal;
  383. } // Check that file exists
  384. if (!options.nocheck) {
  385. // eslint-disable-next-line no-underscore-dangle
  386. const _paths = options.paths || [];
  387. pathname = _stylus.utils.lookup(pathname, _paths.concat(this.paths));
  388. if (!pathname) {
  389. return literal;
  390. }
  391. }
  392. if (this.includeCSS && _path.default.extname(pathname) === ".css") {
  393. return new _stylus.nodes.Literal(parsedUrl.href);
  394. }
  395. if (parsedUrl.search) {
  396. tail += parsedUrl.search;
  397. }
  398. if (parsedUrl.hash) {
  399. tail += parsedUrl.hash;
  400. }
  401. if (dest && _path.default.extname(dest) === ".css") {
  402. dest = _path.default.dirname(dest);
  403. }
  404. res = _path.default.relative(dest || _path.default.dirname(this.filename), options.nocheck ? _path.default.join(_path.default.dirname(filename), pathname) : pathname) + tail;
  405. if (_path.default.sep === "\\") {
  406. res = res.replace(/\\/g, "/");
  407. }
  408. splitted.push(res);
  409. return new _stylus.nodes.Literal(`url("${splitted.join("!")}")`);
  410. }
  411. resolver.options = options;
  412. resolver.raw = true;
  413. return resolver;
  414. }
  415. function readFile(inputFileSystem, filepath) {
  416. return new Promise((resolve, reject) => {
  417. inputFileSystem.readFile(filepath, (error, stats) => {
  418. if (error) {
  419. reject(error);
  420. }
  421. resolve(stats);
  422. });
  423. });
  424. }
  425. const IS_NATIVE_WIN32_PATH = /^[a-z]:[/\\]|^\\\\/i;
  426. const ABSOLUTE_SCHEME = /^[A-Za-z0-9+\-.]+:/;
  427. function getURLType(source) {
  428. if (source[0] === "/") {
  429. if (source[1] === "/") {
  430. return "scheme-relative";
  431. }
  432. return "path-absolute";
  433. }
  434. if (IS_NATIVE_WIN32_PATH.test(source)) {
  435. return "path-absolute";
  436. }
  437. return ABSOLUTE_SCHEME.test(source) ? "absolute" : "path-relative";
  438. }
  439. function normalizeSourceMap(map, rootContext) {
  440. const newMap = map; // result.map.file is an optional property that provides the output filename.
  441. // Since we don't know the final filename in the webpack build chain yet, it makes no sense to have it.
  442. // eslint-disable-next-line no-param-reassign
  443. delete newMap.file; // eslint-disable-next-line no-param-reassign
  444. newMap.sourceRoot = ""; // eslint-disable-next-line no-param-reassign
  445. newMap.sources = newMap.sources.map(source => {
  446. const sourceType = getURLType(source); // Do no touch `scheme-relative`, `path-absolute` and `absolute` types
  447. if (sourceType === "path-relative") {
  448. return _path.default.resolve(rootContext, _path.default.normalize(source));
  449. }
  450. return source;
  451. });
  452. return newMap;
  453. }