pkgprn 0.6.0 → 0.8.0

package/README.md

@@ -62,16 +62,16 @@ Additional optional features can be enabled via flags:
 
 ## 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.                                                      |
-| `--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.                                                                                                                |
+| 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 (or `auto`) to auto-detect, or provide comma-separated directory names or repeat the flag.          |
+| `--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 JSDoc and regular comments, or provide comma-separated types: `jsdoc`, `license`, `regular`, `annotation`. |
+| `--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
 
@@ -100,19 +100,21 @@ Flattening moves files from a dist directory (e.g. `dist/`) into the package roo
 
 ### Auto-detect
 
-When `--flatten` is passed without a value, `pkgprn` inspects `main`, `bin`, `module`, `exports`, `types`, and other entry-point fields to find the longest common directory prefix, and flattens that:
+When `--flatten` is passed without a value (or with `auto`), `pkgprn` inspects `main`, `bin`, `module`, `exports`, `types`, and other entry-point fields to find the longest common directory prefix, and flattens that:
 
 ```sh
 pkgprn --flatten
+pkgprn --flatten auto
 ```
 
 ### Explicit directories
 
-You can specify one or more directories to flatten (comma-separated):
+You can specify one or more directories to flatten (comma-separated or by repeating the flag):
 
 ```sh
 pkgprn --flatten dist
 pkgprn --flatten dist,lib
+pkgprn --flatten dist --flatten lib
 ```
 
 ### What flattening does
@@ -133,20 +135,23 @@ The `--strip-comments` flag removes comments from `.js`, `.mjs`, and `.cjs` file
 ### 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
+pkgprn --strip-comments                                    # strip JSDoc and regular comments (default)
+pkgprn --strip-comments jsdoc                               # strip only JSDoc comments
+pkgprn --strip-comments jsdoc,license,regular,annotation    # strip all comment types
+pkgprn --strip-comments license                             # strip only license comments
+pkgprn --strip-comments annotation                          # strip only annotation comments
 ```
 
 ### Comment types
 
-| Type      | Description                                        |
-| --------- | -------------------------------------------------- |
-| `jsdoc`   | `/** … */` documentation comments                  |
-| `license` | Comments containing "license", "copyright", or "©" |
-| `regular` | All other `//` and `/* … */` comments              |
+| Type         | Description                                                                           | Stripped by default |
+| ------------ | ------------------------------------------------------------------------------------- | ------------------- |
+| `jsdoc`      | `/** … */` documentation comments                                                     | ✓                   |
+| `regular`    | All other `//` and `/* … */` comments                                                 | ✓                   |
+| `license`    | `/*! … */` or comments containing `@license` / `@preserve`                            |                     |
+| `annotation` | Bundler annotations like `/*#__PURE__*/`, `/*@__PURE__*/`, `/*#__NO_SIDE_EFFECTS__*/` |                     |
 
-Passing `--strip-comments` without a value (or with `all`) strips every type.
+Passing `--strip-comments` without a value (or with `all`) strips `jsdoc` and `regular` comments. License and annotation comments are preserved by default — specify them explicitly to strip them.
 
 ### Sourcemap adjustment
 
@@ -224,9 +229,9 @@ await prunePkg(
     pkg,
     {
         profile: "library",
-        flatten: false,
+        flatten: false, // or true for auto-detect, or ["dist"] / ["dist", "lib"]
         removeSourcemaps: false,
-        stripComments: false, // or "all", "jsdoc", "license,regular", etc.
+        stripComments: false, // or "all" (jsdoc+regular), "jsdoc", "license", "annotation", etc.
         optimizeFiles: true,
         cleanupFiles: true,
     },
@@ -237,7 +242,7 @@ await prunePkg(
 ### `prunePkg(pkg, options, logger)`
 
 - **`pkg`** - A mutable `package.json` object. Modified in place.
-- **`options`** - An options object matching the CLI flags.
+- **`options`** - An options object matching the CLI flags. Note that `flatten` accepts `boolean | string[]` (`true` for auto-detect, or an array of directory names).
 - **`logger`** - A logger instance (from [`@niceties/logger`](https://www.npmjs.com/package/@niceties/logger)).
 
 ## Ignored Files

package/index.d.ts

@@ -23,9 +23,9 @@ declare module 'pkgprn' {
 	};
 	export type PruneOptions = {
 		profile: string;
-		flatten: string | boolean;
+		flatten: true | string[] | false;
 		removeSourcemaps: boolean;
-		stripComments: string | boolean;
+		stripComments: true | string[] | false;
 		optimizeFiles: boolean;
 		cleanupFiles: boolean;
 	};

package/index.js

@@ -1,70 +1,86 @@
 #!/usr/bin/env node
 import { readFile, writeFile } from 'node:fs/promises';
-import { dirname, resolve } from 'node:path';
-import { fileURLToPath } from 'node:url';
-
-import { cli } from 'cleye';
+import { resolve } from 'node:path';
 
 import { createLogger } from '@niceties/logger';
+import { parseArgsPlus } from '@niceties/node-parseargs-plus';
+import { camelCase } from '@niceties/node-parseargs-plus/camel-case';
+import { customValue } from '@niceties/node-parseargs-plus/custom-value';
+import { help } from '@niceties/node-parseargs-plus/help';
+import { optionalValue } from '@niceties/node-parseargs-plus/optional-value';
+import { readPackageJson } from '@niceties/node-parseargs-plus/package-info';
 
 import { prunePkg } from './prune.js';
 
-const __dirname = dirname(fileURLToPath(import.meta.url));
+function parseMultiString(values) {
+    const items = values
+        .flatMap(v => v.split(','))
+        .map(s => s.trim())
+        .filter(Boolean);
+    return items.length ? items : true;
+}
 
 const logger = createLogger();
 logger.update('preparing..');
 
 try {
-    const version = await getMyVersion();
+    const myPkgData = await readPackageJson(import.meta.url);
 
     logger.update('');
-    process.stdout.moveCursor?.(0, -1);
 
-    const cliOptions = cli({
-        name: 'pkgprn',
-        version: version ?? '<unknown>',
-        help: {
-            description: 'prune devDependencies and redundant scripts from package.json',
-        },
-        flags: {
-            profile: {
-                type: String,
-                description: 'profile to use',
-                default: 'library',
-            },
-            flatten: {
-                type: FlattenParam,
-                description: 'flatten package files (comma-separated for multiple directories)',
-                default: false,
-            },
-            removeSourcemaps: {
-                type: Boolean,
-                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',
-                default: true,
-            },
-            cleanupFiles: {
-                type: Boolean,
-                description: 'cleanup files not included in files array',
-                default: true,
+    const { values } = parseArgsPlus(
+        {
+            ...myPkgData,
+            allowNegative: true,
+            options: {
+                profile: {
+                    type: 'string',
+                    description: 'profile to use',
+                    default: 'library',
+                },
+                flatten: {
+                    type:  (parseMultiString),
+                    multiple: true,
+                    optionalValue: true,
+                    description: 'flatten package files (omit value to auto-detect, or specify directories)',
+                },
+                removeSourcemaps: {
+                    type: 'boolean',
+                    description: 'remove sourcemaps',
+                    default: false,
+                },
+                stripComments: {
+                    type:  (parseMultiString),
+                    multiple: true,
+                    optionalValue: true,
+                    description: 'strip comments (omit value for defaults, or specify types: jsdoc, license, regular, annotation)',
+                },
+                optimizeFiles: {
+                    type: 'boolean',
+                    description: 'optimize files array',
+                    default: true,
+                },
+                cleanupFiles: {
+                    type: 'boolean',
+                    description: 'cleanup files not included in files array',
+                    default: true,
+                },
             },
         },
-    });
+        [camelCase, customValue, optionalValue, help]
+    );
+
+    const flags = {
+        ...values,
+        flatten: values.flatten ?? false,
+        stripComments: values.stripComments ?? false,
+    };
 
     const pkg = await readPackage('.');
     if (!pkg) {
         throw new Error('Could not read package.json');
     }
-    await prunePkg(pkg, cliOptions.flags, logger);
+    await prunePkg(pkg, flags, logger);
 
     await writePackage(pkg);
 } catch (error) {
@@ -73,12 +89,6 @@ try {
     process.exit(255);
 }
 
-async function getMyVersion() {
-    const pkg = await readPackage(resolve(__dirname));
-
-    return pkg && 'version' in pkg && typeof pkg.version === 'string' ? pkg.version : '<unknown>';
-}
-
 async function readPackage(dir) {
     const packageFileName = resolve(dir, 'package.json');
     try {
@@ -92,17 +102,3 @@ async function readPackage(dir) {
 async function writePackage(pkg) {
     await writeFile('./package.json', `${JSON.stringify(pkg, null, 2)}\n`);
 }
-
-function StripCommentsParam(value) {
-    if (value === '') {
-        return 'all';
-    }
-    return value;
-}
-
-function FlattenParam(value) {
-    if (value === '') {
-        return true;
-    }
-    return value;
-}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pkgprn",
-  "version": "0.6.0",
+  "version": "0.8.0",
   "license": "MIT",
   "author": "Konstantin Shutkin",
   "bin": "./index.js",
@@ -33,7 +33,7 @@
   "main": "prune.js",
   "dependencies": {
     "@jridgewell/sourcemap-codec": "^1.5.5",
-    "@niceties/logger": "^1.1.13",
-    "cleye": "2.2.1"
+    "@niceties/logger": "^2.1.0",
+    "@niceties/node-parseargs-plus": "^0.5.0"
   }
 }

package/prune.js

@@ -88,7 +88,7 @@ export async function prunePkg(pkg, options, logger) {
     }
 
     if (options.stripComments) {
-        const typesToStrip = parseCommentTypes( (options.stripComments));
+        const typesToStrip = parseCommentTypes(options.stripComments);
         logger.update('stripping comments...');
         const allFiles = await walkDir('.', ['node_modules']);
         const jsFiles = allFiles.filter(isStrippableFile);
@@ -256,11 +256,7 @@ async function flatten(pkg, flatten, logger, skipSourcemapAdjust) {
         }
         distDirs = [distDir];
     } else {
-
-        distDirs = flatten
-            .split(',')
-            .map(d => normalizePath(d.trim()))
-            .filter(Boolean);
+        distDirs = flatten.map(d => normalizePath(d.trim())).filter(Boolean);
     }
 
     logger.update(`flattening ${distDirs.join(', ')}...`);
@@ -352,7 +348,7 @@ async function flatten(pkg, flatten, logger, skipSourcemapAdjust) {
 
     await Promise.all(renamePromises);
 
-    if (typeof flatten === 'string' && !skipSourcemapAdjust) {
+    if (Array.isArray(flatten) && !skipSourcemapAdjust) {
 
         const oldToNew = new Map();
         for (const [newPath, oldPath] of movedFiles) {

package/strip-comments.js

@@ -41,6 +41,10 @@ function classifyBlockComment(source, start, end) {
         return 'jsdoc';
     }
 
+    if (/^[#@]__[A-Z_]+__$/.test(body.trim())) {
+        return 'annotation';
+    }
+
     return 'regular';
 }
 
@@ -288,30 +292,23 @@ function scanTemplateTail(s, i, len, templateStack, comments) {
 }
 
 export function parseCommentTypes(value) {
-    if (value === true || value === 'all') {
-        return new Set( (['jsdoc', 'license', 'regular']));
+    if (value === true) {
+        return new Set( (['jsdoc', 'regular']));
     }
 
-    const valid =  (['jsdoc', 'license', 'regular']);
-    const parts = String(value)
-        .split(',')
-        .map(s => s.trim())
-        .filter(Boolean);
+    const valid =  (['jsdoc', 'license', 'regular', 'annotation']);
 
     const result = new Set();
 
-    for (const part of parts) {
-        if (part === 'all') {
-            return new Set(valid);
-        }
+    for (const part of value) {
         if (!valid.includes( (part))) {
-            throw new Error(`unknown comment type "${part}" (expected: ${valid.join(', ')}, all)`);
+            throw new Error(`unknown comment type "${part}" (expected: ${valid.join(', ')})`);
         }
         result.add( (part));
     }
 
     if (result.size === 0) {
-        return new Set(valid);
+        return new Set( (['jsdoc', 'regular']));
     }
 
     return result;