feat: remove legal comments

Author: kshutkin

.changeset/weak-penguins-study.md

@@ -0,0 +1,6 @@
+---
+"pkgbld": minor
+"pkgbld-internal": minor
+---
+
+added remove-legal-comments flag

options/src/index.ts

@@ -142,6 +142,11 @@ export const cliFlags = {
         description: 'Do not bundle',
         default: false
     },
+    removeLegalComments: {
+        type: Boolean,
+        description: 'Remove legal comments',
+        default: false
+    }
 };
 
 export const packageJsonFieldsOrder = new Set([

pkgbld/README.md

@@ -227,21 +227,29 @@ If files cannot be copied because of name conflicts the command will fail.
 ### removeSourcemaps
 
 ```
-pkgbld prune --removeSourcemaps
+pkgbld prune --remove-sourcemaps
 ```
 
 Removes all sourcemaps from the package. The logic is very simple and removes all files with `.map` extension and references in format `//# sourceMappingURL=<mapFile>`.
 
 ### optimizeFiles (default)
 
 ```
-pkgbld prune --optimizeFiles=false
+pkgbld prune --optimize-files=false
 ```
 
 Optimizes files by removing all files that are not required for pack at the given moment.
 
 You might want to disable this option in some edge cases.
 
+### removeLegalComments
+
+```
+pkgbld prune --remove-legal-comments --compress=es,cjs
+```
+
+Removes all legal comments from the package. Only works with compress.
+
 ## Plugin API
 
 `pkgbld` reads all installed packages named `pkgbld-plugin-*` and assumes they are plugins

pkgbld/src/builtin-plugins/terser.ts

@@ -14,7 +14,13 @@ export default async function(provider: Provider, config: CliOptions, inputs: st
                     regex: /_$/
                 }
             }
-        };        
+        };
+        
+        if (config.removeLegalComments) {
+            (options as unknown as { output: { comments: boolean } }).output = {
+                comments: false,
+            };
+        }
 
         if (filteredFormats.length > 0) {
             for (const format of filteredFormats as InternalModuleFormat[]) {

pkgbld/src/get-cli-options.ts

@@ -81,7 +81,8 @@ export function getCliOptions(plugins: Partial<PkgbldPlugin>[], pkg: PackageJson
             noPack: flags.noPack,
             noExports: flags.noExports,
             noClean: flags.noClean,
-            noBundle: flags.noBundle
+            noBundle: flags.noBundle,
+            removeLegalComments: flags.removeLegalComments
         };
 
         for (const plugin of plugins) {
@@ -110,7 +111,8 @@ export function getCliOptions(plugins: Partial<PkgbldPlugin>[], pkg: PackageJson
             noPack: boolean,
             noExports: boolean,
             noClean: boolean,
-            noBundle: boolean
+            noBundle: boolean,
+            removeLegalComments: boolean
         };
     }
 }

pkgbld/src/get-rollup-configs.ts

@@ -112,6 +112,9 @@ export async function getRollupConfigs([provider, plugins]: [Provider, PkgbldRol
                 entryFileNames: fileNamePatterns[format],
                 plugins: getPlugins([format], inputs, true),
                 sourcemap: config.sourcemapFormats.includes(format),
+                // this requires more work
+                // preserveModules: true,
+                // preserveModulesRoot: config.sourceDir,
                 ...getExtraOutputSettings(format, inputs)
             })),
 

pkgbld/src/process-pkg.ts

@@ -129,7 +129,7 @@ export async function processPackage(pkg: JsonObject, config: CliOptions, plugin
         for (const id in pkg.exports as object) {
             if (id === './package.json') continue;
 
-            const basename = id == '.' ? indexId : path.basename(id);
+            const basename = id == '.' ? indexId : path.join(path.dirname(id), path.basename(id));
 
             if (typeof (pkg.exports as Record<string, JsonValue>)[id] !== 'object') {
                 (pkg.exports as Record<string, JsonValue>)[id] = {};

pkgbld/tests/tests.json

@@ -269,6 +269,34 @@
             "output": "dist\n  index.mjs\n|const o=0;export{o as test};\n|\npackage.json\n|{}\n|\nsrc\n  index.js\n|export const test = 0;",
             "stdout": "preparing..\n\npreparing...\nsrc → dist 0 / 1\n✓ index [es]\nsrc → dist 1 / 1\n✓ src → dist 1 / 1 in XXX\n",
             "stderr": ""
+        },
+        {
+            "id": 29,
+            "name": "remove legal comments",
+            "args": "--remove-legal-comments --compress=es,cjs",
+            "input": "package.json\n|{\n|    \"exports\": {\n|        \".\": {\n|            \"import\": \"./dist/index.mjs\"\n|        }\n|    }\n|}\nsrc\n  index.ts\n|//! Copyright (c) 2024 Konstantin Shutkin MIT License\n|export const test = 0;",
+            "output": "dist\n  index.cjs\n|\"use strict\";exports.test=0;\n|\n  index.d.ts\n|export declare const test = 0;\n|\n  index.mjs\n|const o=0;export{o as test};\n|\npackage.json\n|{\n|  \"exports\": {\n|    \".\": {\n|      \"types\": \"./dist/index.d.ts\",\n|      \"import\": \"./dist/index.mjs\",\n|      \"require\": \"./dist/index.cjs\",\n|      \"default\": \"./dist/index.cjs\"\n|    },\n|    \"./package.json\": \"./package.json\"\n|  },\n|  \"files\": [\n|    \"dist\"\n|  ],\n|  \"scripts\": {\n|    \"prepack\": \"pkgbld prune\"\n|  },\n|  \"types\": \"./dist/index.d.ts\",\n|  \"main\": \"./dist/index.cjs\",\n|  \"module\": \"./dist/index.mjs\",\n|  \"typesVersions\": {\n|    \"*\": {\n|      \".\": [\n|        \"dist/index.d.ts\"\n|      ],\n|      \"*\": [\n|        \"dist/index.d.ts\",\n|        \"dist/*\"\n|      ]\n|    }\n|  }\n|}\n|\nsrc\n  index.ts\n|//! Copyright (c) 2024 Konstantin Shutkin MIT License\n|export const test = 0;\ntsconfig.json\n|{\n|  \"include\": [\n|    \"src\",\n|    \"types\"\n|  ],\n|  \"compilerOptions\": {\n|    \"lib\": [\n|      \"dom\",\n|      \"esnext\"\n|    ],\n|    \"target\": \"esnext\",\n|    \"module\": \"esnext\",\n|    \"esModuleInterop\": true,\n|    \"allowJs\": true,\n|    \"skipLibCheck\": true,\n|    \"strict\": true,\n|    \"sourceMap\": true,\n|    \"noUncheckedIndexedAccess\": true,\n|    \"declaration\": true,\n|    \"moduleResolution\": \"node\"\n|  }\n|}\n|",
+            "stdout": "preparing..\n\npreparing...\nno tsconfig.json or jsconfig.json and --no-ts-config not specified, writing tsconfig...\ndone\nsrc → dist 0 / 1\n✓ index [es, cjs]\nsrc → dist 1 / 1\n✓ src → dist 1 / 1 in XXX\n",
+            "stderr": ""
+        },
+        {
+            "id": 30,
+            "name": "legal comments",
+            "args": "--compress=es,cjs",
+            "input": "package.json\n|{\n|    \"exports\": {\n|        \".\": {\n|            \"import\": \"./dist/index.mjs\"\n|        }\n|    }\n|}\nsrc\n  index.ts\n|//! Copyright (c) 2024 Konstantin Shutkin MIT License\n|export const test = 0;",
+            "output": "dist\n  index.cjs\n|\"use strict\";\n|//! Copyright (c) 2024 Konstantin Shutkin MIT License\n|exports.test=0;\n|\n  index.d.ts\n|export declare const test = 0;\n|\n  index.mjs\n|//! Copyright (c) 2024 Konstantin Shutkin MIT License\n|const o=0;export{o as test};\n|\npackage.json\n|{\n|  \"exports\": {\n|    \".\": {\n|      \"types\": \"./dist/index.d.ts\",\n|      \"import\": \"./dist/index.mjs\",\n|      \"require\": \"./dist/index.cjs\",\n|      \"default\": \"./dist/index.cjs\"\n|    },\n|    \"./package.json\": \"./package.json\"\n|  },\n|  \"files\": [\n|    \"dist\"\n|  ],\n|  \"scripts\": {\n|    \"prepack\": \"pkgbld prune\"\n|  },\n|  \"types\": \"./dist/index.d.ts\",\n|  \"main\": \"./dist/index.cjs\",\n|  \"module\": \"./dist/index.mjs\",\n|  \"typesVersions\": {\n|    \"*\": {\n|      \".\": [\n|        \"dist/index.d.ts\"\n|      ],\n|      \"*\": [\n|        \"dist/index.d.ts\",\n|        \"dist/*\"\n|      ]\n|    }\n|  }\n|}\n|\nsrc\n  index.ts\n|//! Copyright (c) 2024 Konstantin Shutkin MIT License\n|export const test = 0;\ntsconfig.json\n|{\n|  \"include\": [\n|    \"src\",\n|    \"types\"\n|  ],\n|  \"compilerOptions\": {\n|    \"lib\": [\n|      \"dom\",\n|      \"esnext\"\n|    ],\n|    \"target\": \"esnext\",\n|    \"module\": \"esnext\",\n|    \"esModuleInterop\": true,\n|    \"allowJs\": true,\n|    \"skipLibCheck\": true,\n|    \"strict\": true,\n|    \"sourceMap\": true,\n|    \"noUncheckedIndexedAccess\": true,\n|    \"declaration\": true,\n|    \"moduleResolution\": \"node\"\n|  }\n|}\n|",
+            "stdout": "preparing..\n\npreparing...\nno tsconfig.json or jsconfig.json and --no-ts-config not specified, writing tsconfig...\ndone\nsrc → dist 0 / 1\n✓ index [es, cjs]\nsrc → dist 1 / 1\n✓ src → dist 1 / 1 in XXX\n",
+            "stderr": ""
+        }
+    ],
+    "capture": [
+        {
+            "id": 31,
+            "name": "",
+            "input": "package.json\n|{\n|    \"exports\": {\n|        \".\": {\n|            \"import\": \"./dist/index.mjs\"\n|        },\n|        \"./folder/second\": {            \n|            \"import\": \"./dist/folder/second.mjs\"\n|        }\n|    }\n|}\nsrc\n  folder\n    second.ts\n|export const t = 0;\n  index.ts\n|export const test = 0;",
+            "output": "dist\n  folder\n    second.d.ts\n|export declare const t = 0;\n|\n  index.cjs\n|'use strict';\n|\n|const test = 0;\n|\n|exports.test = test;\n|\n  index.d.ts\n|export declare const test = 0;\n|\n  index.mjs\n|const test = 0;\n|\n|export { test };\n|\n  second.cjs\n|'use strict';\n|\n|const t = 0;\n|\n|exports.t = t;\n|\n  second.mjs\n|const t = 0;\n|\n|export { t };\n|\npackage.json\n|{\n|  \"exports\": {\n|    \".\": {\n|      \"types\": \"./dist/index.d.ts\",\n|      \"import\": \"./dist/index.mjs\",\n|      \"require\": \"./dist/index.cjs\",\n|      \"default\": \"./dist/index.cjs\"\n|    },\n|    \"./folder/second\": {\n|      \"types\": \"./dist/folder/second.d.ts\",\n|      \"import\": \"./dist/folder/second.mjs\",\n|      \"default\": \"./dist/folder/second.cjs\"\n|    },\n|    \"./package.json\": \"./package.json\"\n|  },\n|  \"files\": [\n|    \"dist\",\n|    \"folder/second\"\n|  ],\n|  \"scripts\": {\n|    \"prepack\": \"pkgbld prune\"\n|  },\n|  \"types\": \"./dist/index.d.ts\",\n|  \"main\": \"./dist/index.cjs\",\n|  \"module\": \"./dist/index.mjs\",\n|  \"typesVersions\": {\n|    \"*\": {\n|      \".\": [\n|        \"dist/index.d.ts\"\n|      ],\n|      \"./folder/second\": [\n|        \"dist/folder/second.d.ts\"\n|      ],\n|      \"*\": [\n|        \"dist/index.d.ts\",\n|        \"dist/*\"\n|      ]\n|    }\n|  }\n|}\n|\nsecond\n  package.json\n|{\n|  \"type\": \"module\",\n|  \"types\": \"../dist/second.d.ts\",\n|  \"main\": \"../dist/second.mjs\"\n|}\nsrc\n  folder\n    second.ts\n|export const t = 0;\n  index.ts\n|export const test = 0;\ntsconfig.json\n|{\n|  \"include\": [\n|    \"src\",\n|    \"types\"\n|  ],\n|  \"compilerOptions\": {\n|    \"lib\": [\n|      \"dom\",\n|      \"esnext\"\n|    ],\n|    \"target\": \"esnext\",\n|    \"module\": \"esnext\",\n|    \"esModuleInterop\": true,\n|    \"allowJs\": true,\n|    \"skipLibCheck\": true,\n|    \"strict\": true,\n|    \"sourceMap\": true,\n|    \"noUncheckedIndexedAccess\": true,\n|    \"declaration\": true,\n|    \"moduleResolution\": \"node\"\n|  }\n|}\n|",
+            "stdout": "preparing..\n\npreparing...\nno tsconfig.json or jsconfig.json and --no-ts-config not specified, writing tsconfig...\ndone\nsrc → dist 0 / 1\n✓ index, second [es, cjs]\nsrc → dist 1 / 1\n✓ src → dist 1 / 1 in XXX\n",
+            "stderr": ""
         }
     ]
 }