magic-comments-loader 1.4.2 → 1.5.0

package/package.json

@@ -1,11 +1,19 @@
 {
   "name": "magic-comments-loader",
-  "version": "1.4.2",
-  "description": "Add webpack magic comments to your dynamic imports during build time",
+  "version": "1.5.0",
+  "description": "Add webpack magic comments to your dynamic imports at build time",
   "main": "dist",
   "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/cjs/index.cjs",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
   "engines": {
-    "node": ">=10.3.0"
+    "node": ">=12.17.0"
   },
   "repository": {
     "type": "git",
@@ -15,10 +23,15 @@
     "url": "https://github.com/morganney/magic-comments-loader/issues"
   },
   "scripts": {
-    "prepack": "node --experimental-json-modules ./prepack.js",
+    "prepack": "npm run build",
+    "build": "npm run build:esm && npm run build:cjs",
+    "build:esm": "babel src --out-dir dist",
+    "build:cjs": "BABEL_ENV=cjs babel src --out-dir dist/cjs --out-file-extension .cjs && node cjs.js",
     "lint": "eslint . src __tests__ --ext .js,.cjs",
     "lint:fix": "npm run lint -- --fix",
-    "test": "node --experimental-vm-modules ./node_modules/.bin/jest"
+    "test:unit": "node --experimental-vm-modules --no-warnings ./node_modules/.bin/jest",
+    "test:spec": "NODE_OPTIONS='--loader=babel-register-esm --no-warnings' BABEL_ENV=test jest -c jest.config.spec.js",
+    "test": "npm run test:unit && npm run test:spec"
   },
   "keywords": [
     "webpack",
@@ -34,23 +47,25 @@
     "dist"
   ],
   "devDependencies": {
-    "@babel/cli": "^7.14.8",
-    "@babel/core": "^7.15.0",
-    "@babel/eslint-parser": "^7.15.4",
-    "@babel/preset-env": "^7.15.0",
-    "codecov": "^3.8.3",
-    "eslint": "^7.32.0",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-jest": "^24.4.0",
-    "eslint-plugin-prettier": "^4.0.0",
-    "jest": "^27.1.1",
-    "memfs": "^3.2.4",
-    "prettier": "^2.3.2",
-    "webpack": "^5.52.0"
+    "@babel/cli": "^7.22.5",
+    "@babel/core": "^7.22.5",
+    "@babel/eslint-parser": "^7.22.5",
+    "@babel/preset-env": "^7.22.5",
+    "babel-register-esm": "^1.2.4",
+    "codecov": "^4.0.0-0",
+    "eslint": "^8.42.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-jest": "^27.2.1",
+    "eslint-plugin-prettier": "^4.2.0",
+    "jest": "^29.5.0",
+    "jest-light-runner": "^0.5.0",
+    "memfs": "^4.0.0",
+    "prettier": "^2.8.8",
+    "webpack": "^5.87.0"
   },
   "dependencies": {
-    "loader-utils": "^2.0.0",
+    "loader-utils": "^3.2.1",
     "micromatch": "^4.0.4",
-    "schema-utils": "^3.1.1"
+    "schema-utils": "^4.1.0"
   }
 }

package/dist/booleanComment.js

@@ -1,107 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getConfig = exports.getSchema = void 0;
-
-var _util = require("./util");
-
-const defaultSchema = {
-  type: 'object',
-  properties: {
-    active: {
-      oneOf: [{
-        type: 'boolean'
-      }, {
-        instanceof: 'Function'
-      }]
-    }
-  },
-  additionalProperties: false
-};
-
-const getSchema = (commentSchema = defaultSchema) => ({
-  oneOf: [{
-    type: 'boolean'
-  }, {
-    type: 'string'
-  }, {
-    type: 'array',
-    items: {
-      type: 'string'
-    }
-  }, {
-    instanceof: 'Function'
-  }, {
-    type: 'object',
-    properties: {
-      config: commentSchema,
-      overrides: (0, _util.getOverrideSchema)(commentSchema)
-    },
-    required: ['config'],
-    additionalProperties: false
-  }]
-});
-
-exports.getSchema = getSchema;
-
-const getConfig = (value, match, filepath, importPath, defaultConfig = {
-  active: true
-}) => {
-  const path = match === 'import' ? importPath.replace(_util.importPrefix, '') : filepath;
-
-  if (value === true) {
-    return defaultConfig;
-  }
-
-  if (value === false) {
-    return { ...defaultConfig,
-      active: false
-    };
-  }
-
-  if (Array.isArray(value) || typeof value === 'string') {
-    return { ...defaultConfig,
-      active: (0, _util.pathIsMatch)(path, value)
-    };
-  }
-
-  if (typeof value === 'function') {
-    const configValue = value(filepath, importPath);
-
-    if (configValue) {
-      return { ...defaultConfig,
-        active: true,
-        dynamic: configValue
-      };
-    }
-
-    return { ...defaultConfig,
-      active: false
-    };
-  }
-
-  let config = { ...defaultConfig,
-    ...value.config
-  };
-
-  if (Array.isArray(value.overrides)) {
-    const {
-      overrides
-    } = value;
-    const length = overrides.length;
-
-    for (let i = 0; i < length; i++) {
-      if ((0, _util.pathIsMatch)(path, overrides[i].files)) {
-        return { ...config,
-          ...overrides[i].config
-        };
-      }
-    }
-  }
-
-  return config;
-};
-
-exports.getConfig = getConfig;

package/dist/comment.js

@@ -1,36 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getCommenter = void 0;
-
-var _strategy = require("./strategy.js");
-
-const getCommenter = (filepath, options, logger = console) => (rgxMatch, capturedImportPath) => {
-  const importPath = capturedImportPath.trim();
-  const bareImportPath = importPath.replace(/['"`]/g, '');
-  const {
-    verbose,
-    match,
-    ...magicCommentOptions
-  } = options;
-  const magicComment = Object.keys(magicCommentOptions).map(key => {
-    const option = magicCommentOptions[key];
-
-    if (option) {
-      return _strategy.commentFor[key](filepath, bareImportPath, option, match);
-    }
-
-    return null;
-  }).filter(comment => comment);
-  const magicImport = rgxMatch.replace(capturedImportPath, magicComment.length > 0 ? `/* ${magicComment.join(', ')} */ ${importPath}` : `${importPath}`);
-
-  if (verbose) {
-    logger.info('[MCL]', `${filepath} : ${magicImport}`);
-  }
-
-  return magicImport;
-};
-
-exports.getCommenter = getCommenter;

package/dist/index.js

@@ -1,13 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-Object.defineProperty(exports, "default", {
-  enumerable: true,
-  get: function () {
-    return _loader.loader;
-  }
-});
-
-var _loader = require("./loader.js");

package/dist/loader.js

@@ -1,33 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.loader = void 0;
-
-var _loaderUtils = require("loader-utils");
-
-var _schemaUtils = require("schema-utils");
-
-var _schema = require("./schema.js");
-
-var _comment = require("./comment.js");
-
-var _util = require("./util.js");
-
-const loader = function (source, map, meta) {
-  const options = (0, _loaderUtils.getOptions)(this);
-  const optionKeys = Object.keys(options);
-  const logger = this.getLogger('MCL');
-  (0, _schemaUtils.validate)(_schema.schema, options, {
-    name: 'magic-comments-loader'
-  });
-  const filepath = this.utils.contextify(this.rootContext, this.resourcePath);
-  const magicComments = (0, _comment.getCommenter)(filepath.replace(/^\.\/?/, ''), optionKeys.length > 0 ? options : {
-    match: 'module',
-    webpackChunkName: true
-  }, logger);
-  this.callback(null, source.replace(_util.dynamicImportsWithoutComments, magicComments), map, meta);
-};
-
-exports.loader = loader;

package/dist/package.json

@@ -1,55 +0,0 @@
-{
-  "name": "magic-comments-loader",
-  "version": "1.4.2",
-  "description": "Add webpack magic comments to your dynamic imports during build time",
-  "main": "index.js",
-  "engines": {
-    "node": ">=10.3.0"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/morganney/magic-comments-loader.git"
-  },
-  "bugs": {
-    "url": "https://github.com/morganney/magic-comments-loader/issues"
-  },
-  "scripts": {
-    "prepack": "node --experimental-json-modules ./prepack.js",
-    "lint": "eslint . src __tests__ --ext .js,.cjs",
-    "lint:fix": "npm run lint -- --fix",
-    "test": "node --experimental-vm-modules ./node_modules/.bin/jest"
-  },
-  "keywords": [
-    "webpack",
-    "magic",
-    "comments",
-    "loader",
-    "dynamic",
-    "import"
-  ],
-  "author": "Morgan Ney <morganney@gmail.com>",
-  "license": "MIT",
-  "files": [
-    "dist"
-  ],
-  "devDependencies": {
-    "@babel/cli": "^7.14.8",
-    "@babel/core": "^7.15.0",
-    "@babel/eslint-parser": "^7.15.4",
-    "@babel/preset-env": "^7.15.0",
-    "codecov": "^3.8.3",
-    "eslint": "^7.32.0",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-jest": "^24.4.0",
-    "eslint-plugin-prettier": "^4.0.0",
-    "jest": "^27.1.1",
-    "memfs": "^3.2.4",
-    "prettier": "^2.3.2",
-    "webpack": "^5.52.0"
-  },
-  "dependencies": {
-    "loader-utils": "^2.0.0",
-    "micromatch": "^4.0.4",
-    "schema-utils": "^3.1.1"
-  }
-}

package/dist/regexComment.js

@@ -1,109 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getRegexComment = void 0;
-
-var _util = require("./util");
-
-const getRegexComment = type => {
-  const configSchema = {
-    type: 'object',
-    properties: {
-      active: {
-        oneOf: [{
-          type: 'boolean'
-        }, {
-          instanceof: 'Function'
-        }]
-      },
-      include: {
-        oneOf: [{
-          instanceof: 'Function'
-        }, {
-          instanceof: 'RegExp'
-        }]
-      }
-    },
-    required: [type],
-    additionalProperties: false
-  };
-  const schema = {
-    oneOf: [{
-      instanceof: 'Function'
-    }, {
-      type: 'object',
-      properties: {
-        config: configSchema,
-        overrides: (0, _util.getOverrideSchema)(configSchema)
-      },
-      required: ['config'],
-      additionalProperties: false
-    }]
-  };
-
-  const getConfig = (value, filepath) => {
-    if (typeof value === 'function') {
-      return {
-        active: true,
-        [type]: value
-      };
-    }
-
-    let config = {
-      active: true,
-      ...value.config
-    };
-
-    if (Array.isArray(value.overrides)) {
-      config = (0, _util.getOverrideConfig)(value.overrides, filepath, config);
-    }
-
-    return config;
-  };
-
-  const comment = (filepath, importPath, value) => {
-    const config = getConfig(value, filepath);
-    const isActive = typeof config.active === 'function' ? config.active(filepath, importPath) : config.active;
-    let regex = null;
-
-    if (!isActive) {
-      return '';
-    }
-
-    if (typeof config[type] === 'function') {
-      regex = config[type](filepath, importPath);
-    }
-
-    if (config[type] instanceof RegExp) {
-      regex = config[type];
-    }
-
-    if (!(regex instanceof RegExp)) {
-      return '';
-    }
-
-    const source = regex.source;
-    const typeName = `${type[0].toUpperCase()}${type.slice(1)}`;
-    /**
-     * Check if the provided RegExp ends in one or more '*'
-     * and if so be sure to escape the ending '/' in the
-     * comments regular expression so as not to break the
-     * comment and cause a SyntaxError.
-     */
-
-    if (/(\*+)$/.test(source)) {
-      return `webpack${typeName}: /${source}\\/${regex.flags}`;
-    }
-
-    return `webpack${typeName}: /${source}/${regex.flags}`;
-  };
-
-  return {
-    comment,
-    schema
-  };
-};
-
-exports.getRegexComment = getRegexComment;

package/dist/schema.js

@@ -1,44 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.schema = void 0;
-
-var _webpackChunkName = require("./webpackChunkName.js");
-
-var _webpackMode = require("./webpackMode.js");
-
-var _webpackIgnore = require("./webpackIgnore.js");
-
-var _webpackPrefetch = require("./webpackPrefetch.js");
-
-var _webpackPreload = require("./webpackPreload.js");
-
-var _webpackExports = require("./webpackExports.js");
-
-var _webpackInclude = require("./webpackInclude.js");
-
-var _webpackExclude = require("./webpackExclude.js");
-
-const schema = {
-  type: 'object',
-  properties: {
-    verbose: {
-      type: 'boolean'
-    },
-    match: {
-      enum: ['module', 'import']
-    },
-    webpackChunkName: _webpackChunkName.schema,
-    webpackMode: _webpackMode.schema,
-    webpackIgnore: _webpackIgnore.schema,
-    webpackPrefetch: _webpackPrefetch.schema,
-    webpackPreload: _webpackPreload.schema,
-    webpackExports: _webpackExports.schema,
-    webpackInclude: _webpackInclude.schema,
-    webpackExclude: _webpackExclude.schema
-  },
-  additionalProperties: false
-};
-exports.schema = schema;

package/dist/strategy.js

@@ -1,34 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.commentFor = void 0;
-
-var _webpackChunkName = require("./webpackChunkName.js");
-
-var _webpackMode = require("./webpackMode.js");
-
-var _webpackIgnore = require("./webpackIgnore.js");
-
-var _webpackPreload = require("./webpackPreload.js");
-
-var _webpackPrefetch = require("./webpackPrefetch.js");
-
-var _webpackExports = require("./webpackExports.js");
-
-var _webpackInclude = require("./webpackInclude.js");
-
-var _webpackExclude = require("./webpackExclude.js");
-
-const commentFor = {
-  webpackChunkName: _webpackChunkName.webpackChunkName,
-  webpackMode: _webpackMode.webpackMode,
-  webpackIgnore: _webpackIgnore.webpackIgnore,
-  webpackPreload: _webpackPreload.webpackPreload,
-  webpackPrefetch: _webpackPrefetch.webpackPrefetch,
-  webpackExports: _webpackExports.webpackExports,
-  webpackInclude: _webpackInclude.webpackInclude,
-  webpackExclude: _webpackExclude.webpackExclude
-};
-exports.commentFor = commentFor;

package/dist/util.js

@@ -1,73 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.dynamicImportsWithoutComments = exports.importPrefix = exports.pathIsMatch = exports.getOverrideSchema = exports.getOverrideConfig = void 0;
-
-var _micromatch = _interopRequireDefault(require("micromatch"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-const pathIsMatch = (path, files) => {
-  const globs = [];
-  const notglobs = [];
-
-  if (!Array.isArray(files)) {
-    files = [files];
-  }
-
-  files.forEach(file => {
-    if (/^!/.test(file)) {
-      notglobs.push(file);
-    } else {
-      globs.push(file);
-    }
-  });
-  return (globs.length === 0 || globs.some(glob => _micromatch.default.isMatch(path, glob))) && notglobs.every(notglob => _micromatch.default.isMatch(path, notglob));
-};
-
-exports.pathIsMatch = pathIsMatch;
-
-const getOverrideSchema = commentSchema => ({
-  type: 'array',
-  items: {
-    type: 'object',
-    properties: {
-      config: commentSchema,
-      files: {
-        oneOf: [{
-          type: 'string'
-        }, {
-          type: 'array',
-          items: {
-            type: 'string'
-          }
-        }]
-      }
-    },
-    additionalProperties: false
-  }
-});
-
-exports.getOverrideSchema = getOverrideSchema;
-
-const getOverrideConfig = (overrides, filepath, config) => {
-  const length = overrides.length;
-
-  for (let i = 0; i < length; i++) {
-    if (pathIsMatch(filepath, overrides[i].files)) {
-      return { ...config,
-        ...overrides[i].config
-      };
-    }
-  }
-
-  return config;
-};
-
-exports.getOverrideConfig = getOverrideConfig;
-const importPrefix = /^(?:(\.{1,2}\/)+)|^\/|^.+:\/\/\/?[.-\w]+\//;
-exports.importPrefix = importPrefix;
-const dynamicImportsWithoutComments = /(?<![\w.]|#!|\*[\s\w]*?|\/\/\s*|['"`][^)$]*)import\s*\((?!\s*\/\*)(?<path>\s*?['"`][^)]+['"`]\s*)\)(?!\s*?\*\/)/g;
-exports.dynamicImportsWithoutComments = dynamicImportsWithoutComments;

package/dist/webpackChunkName.js

@@ -1,70 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.schema = exports.webpackChunkName = void 0;
-
-var _path = require("path");
-
-var _booleanComment = require("./booleanComment.js");
-
-const schema = (0, _booleanComment.getSchema)({
-  type: 'object',
-  properties: {
-    active: {
-      oneOf: [{
-        type: 'boolean'
-      }, {
-        instanceof: 'Function'
-      }]
-    },
-    basename: {
-      type: 'boolean'
-    }
-  },
-  additionalProperties: false
-});
-exports.schema = schema;
-
-const webpackChunkName = (filepath, importPath, value, match) => {
-  const config = (0, _booleanComment.getConfig)(value, match, filepath, importPath, {
-    active: true,
-    basename: false
-  });
-  const isActive = typeof config.active === 'function' ? config.active(filepath, importPath) : config.active;
-
-  if (!isActive) {
-    return '';
-  }
-
-  if (typeof config.dynamic === 'string') {
-    return `webpackChunkName: "${config.dynamic}"`;
-  }
-
-  const {
-    basename
-  } = config;
-  const {
-    dir,
-    name
-  } = (0, _path.parse)(importPath);
-  const segments = `${dir}/${name}`.split('/').filter(segment => /\w/.test(segment));
-  const chunkName = basename ? name : segments.reduce((prev, curr) => {
-    /**
-     * Check for dynamic expressions in imports.
-     * If it exists, it has to be at least the second path
-     * segment or greater, i.e. can not be the first.
-     *
-     * @see https://webpack.js.org/api/module-methods/#dynamic-expressions-in-import
-     */
-    if (/^\${/.test(curr)) {
-      return prev ? `${prev}-[request]` : '[request]';
-    }
-
-    return prev ? `${prev}-${curr}` : curr;
-  }, '');
-  return `webpackChunkName: "${chunkName}"`;
-};
-
-exports.webpackChunkName = webpackChunkName;

package/dist/webpackExclude.js

@@ -1,15 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.schema = exports.webpackExclude = void 0;
-
-var _regexComment = require("./regexComment.js");
-
-const {
-  comment: webpackExclude,
-  schema
-} = (0, _regexComment.getRegexComment)('exclude');
-exports.schema = schema;
-exports.webpackExclude = webpackExclude;