pkgprn 0.3.1 → 0.4.0

package/README.md

@@ -58,18 +58,20 @@ Additional optional features can be enabled via flags:
 
 - **Flatten** dist directories into the package root.
 - **Remove sourcemaps** and their `//# sourceMappingURL=` references.
+- **Strip comments** from JavaScript files, with automatic sourcemap line-mapping adjustment.
 
 ## Options
 
-| Flag                  | Type                | Default   | Description                                                                                                                    |
-| --------------------- | ------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------ |
-| `--profile`           | `string`            | `library` | Script-retention profile (`library` or `app`).                                                                                 |
-| `--flatten`           | `string \| boolean` | `false`   | Flatten dist directories to the package root. Pass without a value to auto-detect, or provide comma-separated directory names. |
-| `--remove-sourcemaps` | `boolean`           | `false`   | Delete `.map` files and strip `sourceMappingURL` comments from source files.                                                   |
-| `--optimize-files`    | `boolean`           | `true`    | Optimize the `files` array by collapsing entries.                                                                              |
-| `--cleanup-files`     | `boolean`           | `true`    | Remove files not listed in the `files` array.                                                                                  |
-| `--version`           |                     |           | Show version number.                                                                                                           |
-| `--help`              |                     |           | Show help message.                                                                                                             |
+| Flag                  | Type                | Default   | Description                                                                                                                       |
+| --------------------- | ------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------- |
+| `--profile`           | `string`            | `library` | Script-retention profile (`library` or `app`).                                                                                    |
+| `--flatten`           | `string \| boolean` | `false`   | Flatten dist directories to the package root. Pass without a value to auto-detect, or provide comma-separated directory names.    |
+| `--remove-sourcemaps` | `boolean`           | `false`   | Delete `.map` files and strip `sourceMappingURL` comments from source files.                                                      |
+| `--strip-comments`    | `string \| boolean` | `false`   | Strip comments from JS files. Pass without a value to strip all, or provide comma-separated types: `jsdoc`, `license`, `regular`. |
+| `--optimize-files`    | `boolean`           | `true`    | Optimize the `files` array by collapsing entries.                                                                                 |
+| `--cleanup-files`     | `boolean`           | `true`    | Remove files not listed in the `files` array.                                                                                     |
+| `--version`           |                     |           | Show version number.                                                                                                              |
+| `--help`              |                     |           | Show help message.                                                                                                                |
 
 ## Profiles
 
@@ -124,6 +126,32 @@ pkgprn --flatten dist,lib
 7. Updates the `files` array.
 8. Cleans up any leftover export-map stub directories that only contain a `package.json`.
 
+## Comment Stripping
+
+The `--strip-comments` flag removes comments from `.js`, `.mjs`, and `.cjs` files. You can target specific comment types or strip them all at once.
+
+### Usage
+
+```sh
+pkgprn --strip-comments            # strip all comments
+pkgprn --strip-comments jsdoc      # strip only JSDoc comments
+pkgprn --strip-comments license,regular  # strip license and regular comments
+```
+
+### Comment types
+
+| Type      | Description                                        |
+| --------- | -------------------------------------------------- |
+| `jsdoc`   | `/** … */` documentation comments                  |
+| `license` | Comments containing "license", "copyright", or "©" |
+| `regular` | All other `//` and `/* … */` comments              |
+
+Passing `--strip-comments` without a value (or with `all`) strips every type.
+
+### Sourcemap adjustment
+
+When comments are stripped, line numbers in the affected files change. If any `.d.ts.map` files reference a stripped JS file in their `sources`, `pkgprn` automatically rewrites the sourcemap `mappings` so that line numbers stay correct. This ensures that declaration-map "Go to Definition" navigation continues to point to the right lines after comment removal.
+
 ## Examples
 
 ### Basic library
@@ -156,6 +184,19 @@ After packing, `build` and `test` are removed; `devDependencies` and `packageMan
 
 After packing, `dist/index.js` becomes `index.js`, `main` points to `index.js`, and the `dist` directory is gone.
 
+### Library with comment stripping
+
+```json
+{
+    "scripts": {
+        "build": "tsc",
+        "prepack": "pkgprn --strip-comments jsdoc"
+    }
+}
+```
+
+After packing, all JSDoc comments are removed from JS files and any `.d.ts.map` sourcemaps are adjusted to reflect the new line numbers.
+
 ### Application with sourcemap removal
 
 ```sh
@@ -185,6 +226,7 @@ await prunePkg(
         profile: "library",
         flatten: false,
         removeSourcemaps: false,
+        stripComments: false, // or "all", "jsdoc", "license,regular", etc.
         optimizeFiles: true,
         cleanupFiles: true,
     },

package/index.d.ts

@@ -25,6 +25,7 @@ declare module 'pkgprn' {
 		profile: string;
 		flatten: string | boolean;
 		removeSourcemaps: boolean;
+		stripComments: string | boolean;
 		optimizeFiles: boolean;
 		cleanupFiles: boolean;
 	};

package/index.d.ts.map

@@ -11,6 +11,6 @@
   "sourcesContent": [
     null
   ],
-  "mappings": ";;;;iBAmEsBA,QAAQA;aA/BUC,MAAMA",
+  "mappings": ";;;;iBAsEsBA,QAAQA;aAhCUC,MAAMA",
   "ignoreList": []
 }

package/index.js

@@ -43,6 +43,11 @@ try {
                 description: 'remove sourcemaps',
                 default: false,
             },
+            stripComments: {
+                type: StripCommentsParam,
+                description: 'strip comments: all (default), jsdoc, license, regular (comma-separated)',
+                default: false,
+            },
             optimizeFiles: {
                 type: Boolean,
                 description: 'optimize files array',
@@ -99,6 +104,16 @@ async function writePackage(pkg) {
     await writeFile('./package.json', `${JSON.stringify(pkg, null, 2)}\n`);
 }
 
+/**
+ * @param {string | false} value
+ */
+function StripCommentsParam(value) {
+    if (value === '') {
+        return 'all';
+    }
+    return value;
+}
+
 /**
  * @param {string | false} value
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pkgprn",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "license": "MIT",
   "author": "Konstantin Shutkin",
   "bin": "./index.js",
@@ -31,8 +31,9 @@
   },
   "main": "prune.js",
   "dependencies": {
+    "@jridgewell/sourcemap-codec": "^1.5.5",
+    "@niceties/logger": "^1.1.13",
     "cleye": "2.2.1",
-    "jsonata": "^2.1.0",
-    "@niceties/logger": "^1.1.13"
+    "jsonata": "^2.1.0"
   }
 }

package/prune.js

@@ -1,6 +1,8 @@
 import { access, mkdir, readdir, readFile, rename, rm, stat, writeFile } from 'node:fs/promises';
 import path from 'node:path';
 
+import { adjustSourcemapLineMappings, isStrippableFile, parseCommentTypes, stripCommentsWithLineMap } from './strip-comments.js';
+
 /**
  * Files always included by npm regardless of the `files` array.
  * README & LICENSE/LICENCE are matched case-insensitively by basename (without extension).
@@ -55,6 +57,7 @@ const hardIgnored = new Set(['.git', '.npmrc', 'node_modules', 'package-lock.jso
  * @property {string} profile
  * @property {string|boolean} flatten
  * @property {boolean} removeSourcemaps
+ * @property {string|boolean} stripComments
  * @property {boolean} optimizeFiles
  * @property {boolean} cleanupFiles
  */
@@ -117,6 +120,54 @@ export async function prunePkg(pkg, options, logger) {
         }
     }
 
+    if (options.stripComments) {
+        const typesToStrip = parseCommentTypes(/** @type {string | true} */ (options.stripComments));
+        logger.update('stripping comments...');
+        const allFiles = await walkDir('.', ['node_modules']);
+        const jsFiles = allFiles.filter(isStrippableFile);
+        const dtsMapFiles = allFiles.filter(f => f.endsWith('.d.ts.map'));
+
+        // Strip comments from JS files and collect line maps keyed by file path.
+        /** @type {Map<string, Int32Array>} */
+        const lineMaps = new Map();
+        for (const file of jsFiles) {
+            const content = await readFile(file, 'utf8');
+            const { result: stripped, lineMap } = stripCommentsWithLineMap(content, typesToStrip);
+            if (lineMap) {
+                await writeFile(file, stripped, 'utf8');
+                lineMaps.set(path.normalize(file), lineMap);
+            }
+        }
+
+        // Adjust .d.ts.map files that reference any of the stripped JS files.
+        if (lineMaps.size > 0 && dtsMapFiles.length > 0) {
+            for (const mapFile of dtsMapFiles) {
+                const mapContent = await readFile(mapFile, 'utf8');
+                let map;
+                try {
+                    map = JSON.parse(mapContent);
+                } catch {
+                    continue;
+                }
+                if (map.version !== 3 || !Array.isArray(map.sources)) continue;
+
+                const mapDir = path.dirname(mapFile) || '.';
+                let adjusted = false;
+                for (let si = 0; si < map.sources.length; si++) {
+                    const resolved = path.normalize(path.join(mapDir, map.sourceRoot || '', map.sources[si]));
+                    const lineMap = lineMaps.get(resolved);
+                    if (lineMap) {
+                        adjustSourcemapLineMappings(map, si, lineMap);
+                        adjusted = true;
+                    }
+                }
+                if (adjusted) {
+                    await writeFile(mapFile, `${JSON.stringify(map, null, '\t')}\n`, 'utf8');
+                }
+            }
+        }
+    }
+
     if (pkg.files && Array.isArray(pkg.files) && options.optimizeFiles) {
         const filterFiles = getAlwaysIncludedFiles(pkg);
 
@@ -532,7 +583,7 @@ async function adjustSourcemapPaths(newMapPath, oldMapPath, oldToNew) {
         delete map.sourceRoot;
     }
 
-    await writeFile(newMapPath, JSON.stringify(map, null, 2) + '\n', 'utf8');
+    await writeFile(newMapPath, `${JSON.stringify(map, null, 2)}\n`, 'utf8');
 }
 
 /**