magic-comments-loader 2.0.5 → 2.1.0

package/README.md

@@ -46,6 +46,7 @@ The `webpackChunkName` comment is added by default when registering the loader.
 * [`verbose`](#verbose)
 * [`mode`](#mode)
 * [`match`](#match)
+* [`comments`](#comments)
 * `[magicCommentName: string]: MagicCommentValue` see `magic-comments` [options](https://github.com/morganney/magic-comments#options) for details
 
 ### `verbose`
@@ -75,6 +76,18 @@ Sets how the loader finds dynamic import expressions in your source code, either
 
 Sets how globs are matched, either the module file path, or the `import()` specifier.
 
+### `comments`
+**type**
+```ts
+'ignore' | 'prepend' | 'append' | 'replace'
+| (cmts: Array<{ start: number; end: number; text: string }>, magicComment: string) => string
+```
+**default** `'ignore'`
+
+_Note, this option only considers block comments that precede the dynamic imports specifier, and any comments coming after are ignored and left intact._
+
+Sets how dynamic imports with block comments are handled. If `ignore` is used, then it will be skipped and no magic comments from your configuration will be applied. If `replace` is used, then all found comments will be replaced with the magic comments. `append` and `prepend` add the magic comments before, or after the found comments, respectively. If a function is used it will be passed the found comments, and the magic comment string that is to be applied. The return value has the same effect as `replace`.
+
 ## Examples
 
 Below are examples for some of the supported magic comments. Consult the [loader specification](https://github.com/morganney/magic-comments-loader/blob/main/__tests__/loader.spec.js) for a comprehensive usage example.

package/dist/cjs/formatter.cjs

@@ -10,24 +10,21 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 const format = ({
   match,
   source,
-  filepath,
   comments,
+  filepath,
+  astComments,
   magicCommentOptions,
   importExpressionNodes
 }) => {
   const magicImports = [];
-  const cmts = [...comments];
   const src = new _magicString.default(source);
-  const hasComment = node => {
-    const idx = cmts.findIndex(cmt => cmt.start > node.start && cmt.end < node.end);
-    const wasFound = idx > -1;
-    if (wasFound) {
-      cmts.splice(idx, 1);
-    }
-    return wasFound;
+  const getComments = node => {
+    // This ignores comments that come after the imports specifier.
+    return astComments.filter(cmt => cmt.start > node.start && cmt.end < node.end && cmt.start < node.source.end);
   };
   for (const node of importExpressionNodes) {
-    if (!hasComment(node)) {
+    const cmts = getComments(node);
+    if (!cmts.length || comments !== 'ignore') {
       const specifier = source.substring(node.source.start, node.source.end);
       const magicComment = (0, _magicComments.getMagicComment)({
         match,
@@ -36,8 +33,36 @@ const format = ({
         options: magicCommentOptions
       });
       if (magicComment) {
-        magicImports.push(src.snip(node.start, node.end).toString().replace(specifier, `${magicComment} ${specifier}`));
-        src.appendLeft(node.source.start, `${magicComment} `);
+        const clone = src.snip(node.start, node.end);
+        if (!cmts.length) {
+          magicImports.push(clone.toString().replace(specifier, `${magicComment} ${specifier}`));
+          src.appendLeft(node.source.start, `${magicComment} `);
+        } else {
+          /**
+           * Get the minimum start and maximum end.
+           * Assumption is that comment nodes are sorted
+           * in ascending order of `node.start`.
+           */
+          const minStart = cmts[0].start;
+          const maxEnd = cmts[cmts.length - 1].end;
+          if (comments === 'replace') {
+            magicImports.push(clone.overwrite(minStart, maxEnd, magicComment).toString());
+            src.overwrite(minStart, maxEnd, magicComment);
+          } else if (comments === 'append') {
+            magicImports.push(clone.appendRight(maxEnd, ` ${magicComment}`).toString());
+            src.appendRight(maxEnd, ` ${magicComment}`);
+          } else if (comments === 'prepend') {
+            magicImports.push(clone.prependLeft(minStart, `${magicComment} `).toString());
+            src.prependLeft(minStart, `${magicComment} `);
+          } else {
+            // Has to be a function or the schema validator is broken
+            const replacement = comments(cmts, magicComment);
+            if (typeof replacement === 'string') {
+              magicImports.push(clone.overwrite(minStart, maxEnd, replacement).toString());
+              src.overwrite(minStart, maxEnd, replacement);
+            }
+          }
+        }
       }
     }
   }

package/dist/cjs/loader.cjs

@@ -20,6 +20,7 @@ const loader = function (source) {
   const {
     mode = 'parser',
     match = 'module',
+    comments = 'ignore',
     verbose = false,
     ...rest
   } = options;
@@ -32,6 +33,7 @@ const loader = function (source) {
       ...(0, _parser.parse)(source),
       match,
       filepath,
+      comments,
       magicCommentOptions
     });
     if (verbose) {

package/dist/cjs/parser.cjs

@@ -21,7 +21,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 (0, _acornJsxWalk.extend)(_acornWalk.base);
 const jsxParser = _acorn.Parser.extend((0, _acornJsx.default)());
 const parse = source => {
-  const comments = [];
+  const astComments = [];
   const importExpressionNodes = [];
   const ast = jsxParser.parse(source, {
     locations: false,
@@ -30,12 +30,12 @@ const parse = source => {
     allowAwaitOutsideFunction: true,
     allowReturnOutsideFunction: true,
     allowImportExportEverywhere: true,
-    onComment: (isBlock, commentText, start, end) => {
+    onComment: (isBlock, text, start, end) => {
       if (isBlock) {
-        comments.push({
+        astComments.push({
           start,
           end,
-          commentText
+          text
         });
       }
     }
@@ -47,7 +47,7 @@ const parse = source => {
   });
   return {
     ast,
-    comments,
+    astComments,
     importExpressionNodes,
     source
   };

package/dist/cjs/schema.cjs

@@ -5,14 +5,29 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.schema = void 0;
 var _magicComments = require("magic-comments");
-const schema = {
+const schema = exports.schema = {
   type: 'object',
   properties: {
     ..._magicComments.schema.properties,
     mode: {
       enum: ['parser', 'regexp']
+    },
+    comments: {
+      /**
+       * How to apply magic comments when the dynamic import already includes a block-level comment.
+       *
+       * - ignore: Default. Skip adding magic comments.
+       * - replace: Replace the found comment with any applied magic commments.
+       * - append: Add any applied magic comments after the comment.
+       * - preprend: Add any applied magic comments before the comment.
+       * - Function: (cmts: {}[], magicComment: string) => string
+       */
+      oneOf: [{
+        enum: ['ignore', 'replace', 'prepend', 'append']
+      }, {
+        instanceof: 'Function'
+      }]
     }
   },
   additionalProperties: false
-};
-exports.schema = schema;
+};

package/dist/formatter.js

@@ -3,24 +3,21 @@ import MagicString from 'magic-string';
 const format = ({
   match,
   source,
-  filepath,
   comments,
+  filepath,
+  astComments,
   magicCommentOptions,
   importExpressionNodes
 }) => {
   const magicImports = [];
-  const cmts = [...comments];
   const src = new MagicString(source);
-  const hasComment = node => {
-    const idx = cmts.findIndex(cmt => cmt.start > node.start && cmt.end < node.end);
-    const wasFound = idx > -1;
-    if (wasFound) {
-      cmts.splice(idx, 1);
-    }
-    return wasFound;
+  const getComments = node => {
+    // This ignores comments that come after the imports specifier.
+    return astComments.filter(cmt => cmt.start > node.start && cmt.end < node.end && cmt.start < node.source.end);
   };
   for (const node of importExpressionNodes) {
-    if (!hasComment(node)) {
+    const cmts = getComments(node);
+    if (!cmts.length || comments !== 'ignore') {
       const specifier = source.substring(node.source.start, node.source.end);
       const magicComment = getMagicComment({
         match,
@@ -29,8 +26,36 @@ const format = ({
         options: magicCommentOptions
       });
       if (magicComment) {
-        magicImports.push(src.snip(node.start, node.end).toString().replace(specifier, `${magicComment} ${specifier}`));
-        src.appendLeft(node.source.start, `${magicComment} `);
+        const clone = src.snip(node.start, node.end);
+        if (!cmts.length) {
+          magicImports.push(clone.toString().replace(specifier, `${magicComment} ${specifier}`));
+          src.appendLeft(node.source.start, `${magicComment} `);
+        } else {
+          /**
+           * Get the minimum start and maximum end.
+           * Assumption is that comment nodes are sorted
+           * in ascending order of `node.start`.
+           */
+          const minStart = cmts[0].start;
+          const maxEnd = cmts[cmts.length - 1].end;
+          if (comments === 'replace') {
+            magicImports.push(clone.overwrite(minStart, maxEnd, magicComment).toString());
+            src.overwrite(minStart, maxEnd, magicComment);
+          } else if (comments === 'append') {
+            magicImports.push(clone.appendRight(maxEnd, ` ${magicComment}`).toString());
+            src.appendRight(maxEnd, ` ${magicComment}`);
+          } else if (comments === 'prepend') {
+            magicImports.push(clone.prependLeft(minStart, `${magicComment} `).toString());
+            src.prependLeft(minStart, `${magicComment} `);
+          } else {
+            // Has to be a function or the schema validator is broken
+            const replacement = comments(cmts, magicComment);
+            if (typeof replacement === 'string') {
+              magicImports.push(clone.overwrite(minStart, maxEnd, replacement).toString());
+              src.overwrite(minStart, maxEnd, replacement);
+            }
+          }
+        }
       }
     }
   }

package/dist/loader.js

@@ -14,6 +14,7 @@ const loader = function (source) {
   const {
     mode = 'parser',
     match = 'module',
+    comments = 'ignore',
     verbose = false,
     ...rest
   } = options;
@@ -26,6 +27,7 @@ const loader = function (source) {
       ...parse(source),
       match,
       filepath,
+      comments,
       magicCommentOptions
     });
     if (verbose) {

package/dist/parser.js

@@ -15,7 +15,7 @@ import jsx from 'acorn-jsx';
 extend(base);
 const jsxParser = Parser.extend(jsx());
 const parse = source => {
-  const comments = [];
+  const astComments = [];
   const importExpressionNodes = [];
   const ast = jsxParser.parse(source, {
     locations: false,
@@ -24,12 +24,12 @@ const parse = source => {
     allowAwaitOutsideFunction: true,
     allowReturnOutsideFunction: true,
     allowImportExportEverywhere: true,
-    onComment: (isBlock, commentText, start, end) => {
+    onComment: (isBlock, text, start, end) => {
       if (isBlock) {
-        comments.push({
+        astComments.push({
           start,
           end,
-          commentText
+          text
         });
       }
     }
@@ -41,7 +41,7 @@ const parse = source => {
   });
   return {
     ast,
-    comments,
+    astComments,
     importExpressionNodes,
     source
   };

package/dist/schema.js

@@ -5,6 +5,22 @@ const schema = {
     ...magicSchema.properties,
     mode: {
       enum: ['parser', 'regexp']
+    },
+    comments: {
+      /**
+       * How to apply magic comments when the dynamic import already includes a block-level comment.
+       *
+       * - ignore: Default. Skip adding magic comments.
+       * - replace: Replace the found comment with any applied magic commments.
+       * - append: Add any applied magic comments after the comment.
+       * - preprend: Add any applied magic comments before the comment.
+       * - Function: (cmts: {}[], magicComment: string) => string
+       */
+      oneOf: [{
+        enum: ['ignore', 'replace', 'prepend', 'append']
+      }, {
+        instanceof: 'Function'
+      }]
     }
   },
   additionalProperties: false

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "magic-comments-loader",
-  "version": "2.0.5",
+  "version": "2.1.0",
   "description": "Add webpack magic comments to your dynamic imports at build time.",
   "main": "dist",
   "type": "module",
@@ -26,7 +26,7 @@
     "prepack": "npm run build",
     "build": "babel-dual-package src --out-dir dist",
     "lint": "eslint . src __tests__ --ext .js,.cjs",
-    "lint:fix": "npm run lint -- --fix",
+    "prettier": "prettier src __tests__ -w",
     "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"
@@ -35,8 +35,8 @@
     "webpack",
     "magic comments",
     "loader",
-    "dynamic",
-    "import",
+    "dynamic import",
+    "webpackChunkName",
     "build",
     "config"
   ],
@@ -46,21 +46,18 @@
     "dist"
   ],
   "devDependencies": {
-    "@babel/cli": "^7.22.5",
-    "@babel/core": "^7.22.5",
-    "@babel/eslint-parser": "^7.22.5",
-    "@babel/preset-env": "^7.22.5",
-    "babel-dual-package": "^1.0.0-rc.1",
+    "@babel/cli": "^7.23.9",
+    "@babel/core": "^7.23.9",
+    "@babel/eslint-parser": "^7.23.9",
+    "@babel/preset-env": "^7.23.9",
+    "babel-dual-package": "^1.1.3",
     "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",
+    "jest": "^29.7.0",
+    "jest-light-runner": "^0.6.0",
+    "memfs": "^4.6.0",
+    "prettier": "^3.2.4",
     "webpack": "^5.87.0"
   },
   "dependencies": {
@@ -68,9 +65,19 @@
     "acorn-jsx": "^5.3.2",
     "acorn-jsx-walk": "^2.0.0",
     "acorn-walk": "^8.2.0",
-    "magic-comments": "^2.1.11",
+    "magic-comments": "^2.1.12",
     "magic-string": "^0.30.0",
     "micromatch": "^4.0.4",
-    "schema-utils": "^4.1.0"
+    "schema-utils": "^4.2.0"
+  },
+  "prettier": {
+    "printWidth": 90,
+    "tabWidth": 2,
+    "useTabs": false,
+    "semi": false,
+    "singleQuote": true,
+    "trailingComma": "none",
+    "bracketSpacing": true,
+    "arrowParens": "avoid"
   }
 }