esbuild-ignore-with-comments-plugin 0.1.1

package/README.md

@@ -0,0 +1,3 @@
+# ESBuild Ignore with Comments Plugin
+
+Allows inserting comments into TypeScript source files. ESBuild will ignore these files during build.

package/dist/src/esbuildIgnoreWithCommentsPlugin.d.ts

@@ -0,0 +1,9 @@
+import { Plugin } from 'esbuild';
+export interface IgnoreWithCommentsPluginOptions {
+    ignore: string[];
+}
+export declare function mustIgnore(comments: string[], ignore: string[] | undefined): boolean;
+export declare function findComments(text: string): string[];
+declare const pluginFactory: (opts?: IgnoreWithCommentsPluginOptions) => Plugin;
+export default pluginFactory;
+//# sourceMappingURL=esbuildIgnoreWithCommentsPlugin.d.ts.map

package/dist/src/esbuildIgnoreWithCommentsPlugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"esbuildIgnoreWithCommentsPlugin.d.ts","sourceRoot":"","sources":["../../src/esbuildIgnoreWithCommentsPlugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAA4B,MAAM,EAAe,MAAM,SAAS,CAAC;AAIxE,MAAM,WAAW,+BAA+B;IAC9C,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB;AAsCD,wBAAgB,UAAU,CACxB,QAAQ,EAAE,MAAM,EAAE,EAClB,MAAM,EAAE,MAAM,EAAE,GAAG,SAAS,GAC3B,OAAO,CAaT;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAanD;AAED,QAAA,MAAM,aAAa,UAAW,+BAA+B,KAAG,MAE/D,CAAC;AAEF,eAAe,aAAa,CAAC"}

package/dist/src/esbuildIgnoreWithCommentsPlugin.js

@@ -0,0 +1,68 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.findComments = exports.mustIgnore = void 0;
+const fs_1 = __importDefault(require("fs"));
+const ignorePlugin = (opts) => {
+    return {
+        name: 'ignore-with-comments-plugin',
+        setup: (build) => {
+            // build.onResolve({ filter: /.*/, namespace: 'ignore' }, (args) => {
+            //   return {
+            //     path: args.path,
+            //     namespace: 'ignore',
+            //   };
+            // });
+            build.onLoad({
+                filter: /\.(ts|tsx)$/,
+            }, async (args) => {
+                const text = await fs_1.default.promises.readFile(args.path, 'utf8');
+                const res = findComments(text);
+                if (mustIgnore(res, opts === null || opts === void 0 ? void 0 : opts.ignore)) {
+                    return {
+                        contents: 'const dummy = {}; export default dummy;',
+                        loader: 'ts',
+                    };
+                }
+                const type = args.path.endsWith('.ts') ? 'ts' : 'tsx';
+                return {
+                    contents: text,
+                    loader: type,
+                };
+            });
+        },
+    };
+};
+function mustIgnore(comments, ignore) {
+    if (comments.length === 0) {
+        return false;
+    }
+    if (!ignore) {
+        return true;
+    }
+    const reducer = (prev, curr) => {
+        return (prev && comments.find((el) => el === curr || el === '') !== undefined);
+    };
+    return ignore.reduce(reducer, true);
+}
+exports.mustIgnore = mustIgnore;
+function findComments(text) {
+    const commentRegex = /^\s*\/\* esbuild-ignore ([^\s\*]*)/gm;
+    const res = [];
+    let matches;
+    do {
+        matches = commentRegex.exec(text);
+        if (matches && matches.length > 1) {
+            res.push(matches[1]);
+        }
+    } while (matches !== null);
+    return res;
+}
+exports.findComments = findComments;
+const pluginFactory = (opts) => {
+    return ignorePlugin(opts);
+};
+exports.default = pluginFactory;
+//# sourceMappingURL=esbuildIgnoreWithCommentsPlugin.js.map

package/dist/src/esbuildIgnoreWithCommentsPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"esbuildIgnoreWithCommentsPlugin.js","sourceRoot":"","sources":["../../src/esbuildIgnoreWithCommentsPlugin.ts"],"names":[],"mappings":";;;;;;AAEA,4CAAoB;AAMpB,MAAM,YAAY,GAAG,CAAC,IAAsC,EAAU,EAAE;IACtE,OAAO;QACL,IAAI,EAAE,6BAA6B;QACnC,KAAK,EAAE,CAAC,KAAkB,EAAE,EAAE;YAC5B,qEAAqE;YACrE,aAAa;YACb,uBAAuB;YACvB,2BAA2B;YAC3B,OAAO;YACP,MAAM;YAEN,KAAK,CAAC,MAAM,CACV;gBACE,MAAM,EAAE,aAAa;aACtB,EACD,KAAK,EAAE,IAAgB,EAAyB,EAAE;gBAChD,MAAM,IAAI,GAAG,MAAM,YAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;gBAE3D,MAAM,GAAG,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;gBAC/B,IAAI,UAAU,CAAC,GAAG,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,CAAC,EAAE;oBACjC,OAAO;wBACL,QAAQ,EAAE,yCAAyC;wBACnD,MAAM,EAAE,IAAI;qBACb,CAAC;iBACH;gBACD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;gBACtD,OAAO;oBACL,QAAQ,EAAE,IAAI;oBACd,MAAM,EAAE,IAAI;iBACb,CAAC;YACJ,CAAC,CACF,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC,CAAC;AAEF,SAAgB,UAAU,CACxB,QAAkB,EAClB,MAA4B;IAE5B,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;QACzB,OAAO,KAAK,CAAC;KACd;IACD,IAAI,CAAC,MAAM,EAAE;QACX,OAAO,IAAI,CAAC;KACb;IACD,MAAM,OAAO,GAAG,CAAC,IAAa,EAAE,IAAY,EAAW,EAAE;QACvD,OAAO,CACL,IAAI,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,KAAK,IAAI,IAAI,EAAE,KAAK,EAAE,CAAC,KAAK,SAAS,CACtE,CAAC;IACJ,CAAC,CAAC;IACF,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;AACtC,CAAC;AAhBD,gCAgBC;AAED,SAAgB,YAAY,CAAC,IAAY;IACvC,MAAM,YAAY,GAAG,sCAAsC,CAAC;IAC5D,MAAM,GAAG,GAAa,EAAE,CAAC;IACzB,IAAI,OAA+B,CAAC;IACpC,GAAG;QACD,OAAO,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAElC,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YACjC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;SACtB;KACF,QAAQ,OAAO,KAAK,IAAI,EAAE;IAE3B,OAAO,GAAG,CAAC;AACb,CAAC;AAbD,oCAaC;AAED,MAAM,aAAa,GAAG,CAAC,IAAsC,EAAU,EAAE;IACvE,OAAO,YAAY,CAAC,IAAI,CAAC,CAAC;AAC5B,CAAC,CAAC;AAEF,kBAAe,aAAa,CAAC"}

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "esbuild-ignore-with-comments-plugin",
+  "version": "0.1.1",
+  "description": "esbuild Plugin for ignoring files with specific comments in them",
+  "keywords": [
+    "node",
+    "javascript",
+    "esbuild"
+  ],
+  "homepage": "",
+  "bugs": {
+    "url": "https://github.com/goldstack/goldstack/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/goldstack/goldstack.git"
+  },
+  "license": "MIT",
+  "author": "Max Rohde",
+  "sideEffects": false,
+  "main": "dist/src/esbuildIgnoreWithCommentsPlugin.js",
+  "scripts": {
+    "build": "yarn clean && yarn compile",
+    "build:watch": "yarn clean && yarn compile-watch",
+    "clean": "rimraf ./dist",
+    "compile": "tsc -p tsconfig.json",
+    "compile-watch": "tsc -p tsconfig.json --watch",
+    "compile-watch:light": "nodemon --watch ./src/ -e '*' --exec 'yarn compile'",
+    "coverage": "jest --collect-coverage --passWithNoTests --config=./jest.config.js --runInBand",
+    "prepublishOnly": "yarn run build",
+    "publish": "utils-git changed --exec \"yarn npm publish $@\"",
+    "test-ci": "jest --passWithNoTests --config=./jest.config.js --runInBand",
+    "version:apply": "utils-git changed --exec \"yarn version $@ && yarn version apply\""
+  },
+  "devDependencies": {
+    "@goldstack/utils-git": "0.1.37",
+    "@types/jest": "^28.1.8",
+    "@types/node": "^18.7.13",
+    "esbuild": "^0.15.5",
+    "jest": "^28.1.0",
+    "rimraf": "^3.0.2",
+    "ts-jest": "^28.0.2",
+    "typescript": "^4.7.4"
+  },
+  "publishConfig": {
+    "main": "dist/src/esbuildIgnoreWithCommentsPlugin.js"
+  }
+}