esbuild-ignore-with-comments-plugin 0.3.0 → 0.3.1

package/README.md

@@ -1,3 +1,63 @@
+[![npm version](https://badge.fury.io/js/esbuild-ignore-with-comments-plugin.svg)](https://badge.fury.io/js/esbuild-ignore-with-comments-plugin)
+
 # ESBuild Ignore with Comments Plugin
 
-Allows inserting comments into TypeScript source files. ESBuild will ignore these files during build.
+Allows inserting comments into TypeScript source files. ESBuild will ignore these files during build.
+
+## Usage
+
+Add to any `.ts` or `.tsx` file the following comment:
+
+```typescript
+/* esbuild-ignore */
+```
+
+This file will be replaced with a source file that has an empty object as a default export.
+
+Configure the plugin for esbuild as follows:
+
+```typescript
+import ignorePlugin from 'esbuild-ignore-with-comments-plugin';
+import { build } from 'esbuild';
+
+await build({
+  plugins: [ignorePlugin()],
+});
+```
+
+If you are bundling the same files multiple times (such as for server-side rendering) you can group files into sets and only ignore specific sets of files.
+
+For instance, assume you have the following files:
+
+`server.ts`
+
+```typescript
+/* esbuild-ignore ui */
+
+// some server only stuff
+```
+
+`ui.ts`
+
+```typescript
+/* esbuild-ignore server */
+
+// some ui only stuff
+```
+
+Then running the following will ignore `server.ts` during the build:
+
+```typescript
+await build({
+  plugins: [ignorePlugin(['ui'])],
+});
+```
+
+Note that files that have the comment `/* esbuild-ignore */` without specifying a group will always be ignored.
+
+Also note that if you want to add a file to multiple groups, you need to include multiple `esbuild-ignore` comments, such as:
+
+```typescript
+/* esbuild-ignore server */
+/* esbuild-ignore ui */
+```

package/dist/src/esbuildIgnoreWithCommentsPlugin.d.ts

@@ -1,9 +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;
+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.js

@@ -1,68 +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;
+"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/package.json

@@ -1,13 +1,13 @@
 {
   "name": "esbuild-ignore-with-comments-plugin",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "esbuild Plugin for ignoring files with specific comments in them",
   "keywords": [
     "node",
     "javascript",
     "esbuild"
   ],
-  "homepage": "",
+  "homepage": "https://github.com/goldstack/goldstack/tree/master/workspaces/utils/packages/esbuild-ignore-with-comments-plugin",
   "bugs": {
     "url": "https://github.com/goldstack/goldstack/issues"
   },
@@ -33,7 +33,7 @@
     "version:apply": "utils-git changed --exec \"yarn version $@ && yarn version apply\""
   },
   "devDependencies": {
-    "@goldstack/utils-git": "0.2.0",
+    "@goldstack/utils-git": "0.2.1",
     "@types/jest": "^28.1.8",
     "@types/node": "^18.7.13",
     "esbuild": "^0.15.5",