vite-plugin-strip-comments 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License (MIT)
+
+Copyright (c) 2024 thednp
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,58 @@
+# vite-plugin-strip-comments
+
+[![Coverage Status](https://coveralls.io/repos/github/thednp/vite-plugin-strip-comments/badge.svg)](https://coveralls.io/github/thednp/vite-plugin-strip-comments)
+[![ci](https://github.com/thednp/vite-plugin-strip-comments/actions/workflows/ci.yml/badge.svg)](https://github.com/thednp/vite-plugin-strip-comments/actions/workflows/ci.yml)
+[![NPM Version](https://img.shields.io/npm/v/vite-plugin-strip-comments.svg)](https://www.npmjs.com/package/vite-plugin-strip-comments)
+[![NPM Downloads](https://img.shields.io/npm/dm/vite-plugin-strip-comments.svg)](http://npm-stat.com/charts.html?package=vite-plugin-strip-comments)
+[![typescript version](https://img.shields.io/badge/typescript-5.6.3-brightgreen)](https://www.typescriptlang.org/)
+[![vitest version](https://img.shields.io/badge/vitest-2.1.4-brightgreen)](https://vitest.dev/)
+[![vite version](https://img.shields.io/badge/vite-5.4.10-brightgreen)](https://github.com/vitejs)
+
+A simple Vite plugin for stripping comments in your production code. Some comments just don't get removed no matter what minify options you set, especially `/* istanbul ignore */` flags. Also keep in mind this is experimental, the configuration doesn't work properly, it always removes ALL comments, so **use with caution**.
+
+## Install
+
+```bash
+pnpm install -D vite-plugin-strip-comments
+```
+
+```bash
+yarn add -D vite-plugin-strip-comments
+```
+
+```bash
+npm install -D vite-plugin-strip-comments
+```
+
+```bash
+deno install -D npm:vite-plugin-strip-comments@latest
+```
+
+## Usage
+
+```ts
+// vite.config.mts
+import stripComments from 'vite-plugin-strip-comments';
+
+export default defineConfig({
+  plugins: [
+    // ... other plugins
+    stripComments({ type: 'istanbul' }),
+  ],
+});
+```
+
+**Options**
+
+* type: "none" | "keep-legal" | "istanbul" (default) - changes the behavior of the transform function
+  * **none** removes all comments
+  * **keep-legal** remove all commments except those which contain `@legal` or `@license`, a very good practice to allow open source to shine yes?
+  * **istanbul** (default) only remove comments that target istanbul code coverage instrumentation (EG: `/* istanbul ignore else @preserve */`)
+
+## Contributions
+* Found a problem, [report](https://github.com/thednp/vite-plugin-strip-comments/issues) the problem. Thank you!
+* Found a fix? Clone, install, apply fix and commit. Thank you!
+
+
+## License
+**vite-plugin-strip-comments** is released under the [MIT License](https://github.com/thednp/vite-plugin-strip-comments/blob/master/LICENSE).

package/dist/index.cjs

@@ -0,0 +1,2 @@
+"use strict";const l={none:/((?=\/\*).*\*\/)|((?=((?<!\:)\/\/)).*(?=\n))/gm,"keep-legal":/(((?=(\/\*[\s\S](?!(\@legal|\@license)))).*\*\/)|((?=((?<!\:)\/\/[\s\S](?!(\@legal|\@license)))).*(?=\n)))/gm,istanbul:/(((?=(\/\*[\s\S]istanbul)).*\*\/)|((?=(\/\/[\s\S]istanbul)).*(?=\n)))/gm},m=e=>({name:"vite-plugin-strip-comments",transform(n,s){if(n?.length&&(!s?.length||!s.includes("node_modules"))){const t=["none","legal","istanbul"].some(a=>e?.type===a)?l[e?.type]:l.istanbul;return{code:n.replace(t,""),map:null}}}});module.exports=m;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":["../src/index.ts"],"sourcesContent":["export type StripCommentsOutput = {\n  name: string;\n  transform: (\n    text: string,\n    id: string | undefined,\n  ) => undefined | { code: string; map: string | null };\n};\n\n/**\n * @default 'istanbul'\n */\nexport type StripCommentsConfig = {\n  type: \"none\" | \"keep-legal\" | \"istanbul\";\n};\n\nconst replacements: Record<\"none\" | \"keep-legal\" | \"istanbul\", RegExp> = {\n  none: /((?=\\/\\*).*\\*\\/)|((?=((?<!\\:)\\/\\/)).*(?=\\n))/gm,\n  \"keep-legal\":\n    /(((?=(\\/\\*[\\s\\S](?!(\\@legal|\\@license)))).*\\*\\/)|((?=((?<!\\:)\\/\\/[\\s\\S](?!(\\@legal|\\@license)))).*(?=\\n)))/gm,\n  istanbul:\n    /(((?=(\\/\\*[\\s\\S]istanbul)).*\\*\\/)|((?=(\\/\\/[\\s\\S]istanbul)).*(?=\\n)))/gm,\n};\n\nconst stripComments = (cfg?: Partial<StripCommentsConfig>) => {\n  return {\n    name: \"vite-plugin-strip-comments\",\n    /* @ts-expect-error - it's just how Vite plugins work */\n    transform(code: string, id?: string) {\n      /* istanbul ignore else @preserve */\n      if (code?.length && (!id?.length || !id.includes(\"node_modules\"))) {\n        const replacement = [\"none\", \"legal\", \"istanbul\"].some((x) =>\n            cfg?.type === x\n          )\n          ? replacements[cfg?.type as StripCommentsConfig[\"type\"]]\n          : replacements[\"istanbul\"];\n        return {\n          code: code.replace(replacement, \"\"),\n          map: null,\n        };\n      }\n    },\n  } satisfies StripCommentsOutput;\n};\n\nexport default stripComments;\n"],"names":["replacements","stripComments","cfg","code","id","replacement","x"],"mappings":"aAeA,MAAMA,EAAmE,CACvE,KAAM,iDACN,aACE,+GACF,SACE,yEACJ,EAEMC,EAAiBC,IACd,CACL,KAAM,6BAEN,UAAUC,EAAcC,EAAa,CAE/B,GAAAD,GAAM,SAAW,CAACC,GAAI,QAAU,CAACA,EAAG,SAAS,cAAc,GAAI,CACjE,MAAMC,EAAc,CAAC,OAAQ,QAAS,UAAU,EAAE,KAAMC,GACpDJ,GAAK,OAASI,GAEdN,EAAaE,GAAK,IAAmC,EACrDF,EAAa,SACV,MAAA,CACL,KAAMG,EAAK,QAAQE,EAAa,EAAE,EAClC,IAAK,IACP,CAAA,CACF,CAEJ"}

package/dist/index.d.ts

@@ -0,0 +1,17 @@
+declare const stripComments: (cfg?: Partial<StripCommentsConfig>) => {
+    name: string;
+    transform(code: string, id?: string): {
+        code: string;
+        map: null;
+    } | undefined;
+};
+export default stripComments;
+
+/**
+ * @default 'istanbul'
+ */
+declare type StripCommentsConfig = {
+    type: "none" | "keep-legal" | "istanbul";
+};
+
+export { }

package/dist/index.mjs

@@ -0,0 +1,23 @@
+const s = {
+  none: /((?=\/\*).*\*\/)|((?=((?<!\:)\/\/)).*(?=\n))/gm,
+  "keep-legal": /(((?=(\/\*[\s\S](?!(\@legal|\@license)))).*\*\/)|((?=((?<!\:)\/\/[\s\S](?!(\@legal|\@license)))).*(?=\n)))/gm,
+  istanbul: /(((?=(\/\*[\s\S]istanbul)).*\*\/)|((?=(\/\/[\s\S]istanbul)).*(?=\n)))/gm
+}, m = (e) => ({
+  name: "vite-plugin-strip-comments",
+  /* @ts-expect-error - it's just how Vite plugins work */
+  transform(n, l) {
+    if (n?.length && (!l?.length || !l.includes("node_modules"))) {
+      const t = ["none", "legal", "istanbul"].some(
+        (a) => e?.type === a
+      ) ? s[e?.type] : s.istanbul;
+      return {
+        code: n.replace(t, ""),
+        map: null
+      };
+    }
+  }
+});
+export {
+  m as default
+};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sources":["../src/index.ts"],"sourcesContent":["export type StripCommentsOutput = {\n  name: string;\n  transform: (\n    text: string,\n    id: string | undefined,\n  ) => undefined | { code: string; map: string | null };\n};\n\n/**\n * @default 'istanbul'\n */\nexport type StripCommentsConfig = {\n  type: \"none\" | \"keep-legal\" | \"istanbul\";\n};\n\nconst replacements: Record<\"none\" | \"keep-legal\" | \"istanbul\", RegExp> = {\n  none: /((?=\\/\\*).*\\*\\/)|((?=((?<!\\:)\\/\\/)).*(?=\\n))/gm,\n  \"keep-legal\":\n    /(((?=(\\/\\*[\\s\\S](?!(\\@legal|\\@license)))).*\\*\\/)|((?=((?<!\\:)\\/\\/[\\s\\S](?!(\\@legal|\\@license)))).*(?=\\n)))/gm,\n  istanbul:\n    /(((?=(\\/\\*[\\s\\S]istanbul)).*\\*\\/)|((?=(\\/\\/[\\s\\S]istanbul)).*(?=\\n)))/gm,\n};\n\nconst stripComments = (cfg?: Partial<StripCommentsConfig>) => {\n  return {\n    name: \"vite-plugin-strip-comments\",\n    /* @ts-expect-error - it's just how Vite plugins work */\n    transform(code: string, id?: string) {\n      /* istanbul ignore else @preserve */\n      if (code?.length && (!id?.length || !id.includes(\"node_modules\"))) {\n        const replacement = [\"none\", \"legal\", \"istanbul\"].some((x) =>\n            cfg?.type === x\n          )\n          ? replacements[cfg?.type as StripCommentsConfig[\"type\"]]\n          : replacements[\"istanbul\"];\n        return {\n          code: code.replace(replacement, \"\"),\n          map: null,\n        };\n      }\n    },\n  } satisfies StripCommentsOutput;\n};\n\nexport default stripComments;\n"],"names":["replacements","stripComments","cfg","code","id","replacement","x"],"mappings":"AAeA,MAAMA,IAAmE;AAAA,EACvE,MAAM;AAAA,EACN,cACE;AAAA,EACF,UACE;AACJ,GAEMC,IAAgB,CAACC,OACd;AAAA,EACL,MAAM;AAAA;AAAA,EAEN,UAAUC,GAAcC,GAAa;AAE/B,QAAAD,GAAM,WAAW,CAACC,GAAI,UAAU,CAACA,EAAG,SAAS,cAAc,IAAI;AACjE,YAAMC,IAAc,CAAC,QAAQ,SAAS,UAAU,EAAE;AAAA,QAAK,CAACC,MACpDJ,GAAK,SAASI;AAAA,UAEdN,EAAaE,GAAK,IAAmC,IACrDF,EAAa;AACV,aAAA;AAAA,QACL,MAAMG,EAAK,QAAQE,GAAa,EAAE;AAAA,QAClC,KAAK;AAAA,MACP;AAAA,IAAA;AAAA,EACF;AAEJ;"}

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "vite-plugin-strip-comments",
+  "version": "0.0.1",
+  "description": "🗃️ Vite plugin for stripping comments in production builds",
+  "main": "dist/index.mjs",
+  "module": "./dist/index.mjs",
+  "source": "./src/index.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.mjs"
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/thednp/vite-plugin-strip-comments.git"
+  },
+  "keywords": [
+    "vite",
+    "strip",
+    "comments"
+  ],
+  "author": "thednp",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/thednp/vite-plugin-strip-comments/issues"
+  },
+  "homepage": "https://github.com/thednp/vite-plugin-strip-comments#readme",
+  "devDependencies": {
+    "@types/node": "^20.17.3",
+    "@vitest/coverage-istanbul": "^2.1.4",
+    "playwright": "^1.48.2",
+    "typescript": "^5.6.3",
+    "vite": "^5.4.10",
+    "vite-plugin-dts": "^4.3.0",
+    "vitest": "^2.1.4"
+  },
+  "engines": {
+    "node": ">=20",
+    "pnpm": ">=9.10.0",
+    "deno": ">=2.0.4"
+  },
+  "scripts": {
+    "pre-test": "pnpm clean-coverage",
+    "badges": "npx -p dependency-version-badge update-badge typescript vitest vite",
+    "test": "pnpm pre-test && vitest --config vitest.config.mts",
+    "clean-coverage": "rm -rf coverage .nyc_output",
+    "format": "deno fmt src",
+    "lint": "pnpm lint:ts && pnpm check:ts",
+    "lint:ts": "deno lint src",
+    "fix:ts": "deno lint src --fix",
+    "check:ts": "tsc -noEmit",
+    "build": "vite build"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,36 @@
+{
+   // https://janessagarrow.com/blog/typescript-and-esbuild/
+  "compilerOptions": {
+    "lib": ["DOM", "ESNext", "DOM.Iterable"],
+    // "types": ["vite", "vite/client"],
+    "rootDir": "./",
+    "baseUrl": "./",
+    "module": "ESNext",
+    "target": "ESNext",
+    "moduleResolution": "Bundler",
+    "allowJs": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolvePackageJsonImports": true,
+    "useDefineForClassFields": true,
+    "strict": true,
+    "sourceMap": true,
+    "resolveJsonModule": true,
+    "esModuleInterop": true,
+    "isolatedModules": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noImplicitReturns": true,
+    "removeComments": false,
+    "allowSyntheticDefaultImports": true,
+    "noEmit": true,
+    "checkJs": true,
+    "skipLibCheck": true, // allows dts-bundle-generator to import from package.json
+    "paths": {
+      "~/*": [
+        "./src/*"
+      ],
+    }
+  },
+  "include": ["src/*", "src/**/*"],
+  "exclude": ["node_modules", "experiments", "coverage", "dist"],
+}