env-attr-cleaner-bun 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Tcharlyto
+
+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/dist/index.cjs

@@ -0,0 +1,59 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const DEFAULT_CONFIG = {
+  environments: {
+    development: [],
+    test: [],
+    staging: ["data-test-*", "data-debug-*"],
+    production: ["data-test-*", "data-debug-*"]
+  }
+};
+function matchPattern(attr, pattern) {
+  const regex = new RegExp("^" + pattern.replace(/\*/g, ".*") + "$");
+  return regex.test(attr);
+}
+function shouldStrip(attr, patterns) {
+  return patterns.some((pattern) => matchPattern(attr, pattern));
+}
+function stripDataAttributes(code, stripPatterns) {
+  return code.replace(/\s+(data-[\w-]+)=(?:"[^"]*"|'[^']*')/g, (match, attr) => {
+    if (shouldStrip(attr, stripPatterns)) {
+      return "";
+    }
+    return match;
+  });
+}
+function resolvePatterns(config) {
+  const env = process.env.NODE_ENV ?? "development";
+  return config.environments[env] ?? [];
+}
+
+const BUN_FILE_PATTERN = /\.(tsx?|jsx?|vue|svelte)$/;
+function envAttrCleaner(userConfig = {}) {
+  const config = {
+    environments: { ...DEFAULT_CONFIG.environments, ...userConfig.environments }
+  };
+  const allowedPatterns = resolvePatterns(config);
+  return {
+    name: "bun-plugin-env-attr-cleaner",
+    setup(build) {
+      build.onLoad({ filter: BUN_FILE_PATTERN }, async (args) => {
+        const fs = await import('fs');
+        const source = fs.readFileSync(args.path, "utf8");
+        const loader = args.path.endsWith(".ts") || args.path.endsWith(".tsx") ? "ts" : "js";
+        return {
+          contents: stripDataAttributes(source, allowedPatterns),
+          loader
+        };
+      });
+    }
+  };
+}
+
+exports.default = envAttrCleaner;
+exports.envAttrCleaner = envAttrCleaner;
+exports.matchPattern = matchPattern;
+exports.shouldStrip = shouldStrip;
+exports.stripDataAttributes = stripDataAttributes;

package/dist/index.d.cts

@@ -0,0 +1,74 @@
+/**
+ * Per-environment configuration for data-* attribute patterns to strip.
+ * Each key is an environment name and its value is a list of glob-style patterns to remove.
+ */
+interface IEnvAttrCleanerConfig {
+    /** Map of environment names to lists of data-* attribute patterns to strip. */
+    environments: Record<string, string[]>;
+}
+/**
+ * Returns whether a data-* attribute name matches a glob-style pattern.
+ * Supports `*` as a wildcard.
+ *
+ * @param attr - The attribute name to test (e.g. `data-test-id`).
+ * @param pattern - The glob pattern to match against (e.g. `data-test-*`).
+ */
+declare function matchPattern(attr: string, pattern: string): boolean;
+/**
+ * Returns whether a data-* attribute should be stripped,
+ * i.e. whether it matches at least one of the strip patterns.
+ *
+ * @param attr - The attribute name to test.
+ * @param patterns - List of glob patterns marking attributes for removal.
+ */
+declare function shouldStrip(attr: string, patterns: string[]): boolean;
+/**
+ * Strips data-* attributes from an HTML or source code string
+ * when they match one of the given patterns. All other attributes are preserved.
+ *
+ * @param code - The source string to process.
+ * @param stripPatterns - List of glob patterns for attributes to remove.
+ * @returns The processed string with matched data-* attributes removed.
+ */
+declare function stripDataAttributes(code: string, stripPatterns: string[]): string;
+
+/** Subset of the Bun build API used by the envAttrCleaner plugin. */
+interface IBunBuild {
+    onLoad: (options: {
+        filter: RegExp;
+    }, callback: (args: {
+        path: string;
+    }) => Promise<{
+        contents: string;
+        loader: string;
+    }>) => void;
+}
+/** Shape of a Bun bundler plugin. */
+interface IBunPlugin {
+    name: string;
+    setup: (build: IBunBuild) => void;
+}
+/**
+ * Bun plugin that strips non-allowed data-* attributes from source files at build time,
+ * based on the current `NODE_ENV`.
+ *
+ * @param userConfig - Optional partial configuration to override the default environment patterns.
+ * @returns A Bun plugin object to pass to `Bun.build({ plugins: [...] })`.
+ *
+ * @example
+ * ```ts
+ * import envAttrCleaner from 'env-attr-cleaner-bun'
+ *
+ * await Bun.build({
+ *     entrypoints: ['./src/index.tsx'],
+ *     outdir: './dist',
+ *     plugins: [envAttrCleaner()]
+ * })
+ * ```
+ */
+declare function envAttrCleaner(userConfig?: Partial<IEnvAttrCleanerConfig>): IBunPlugin;
+
+// @ts-ignore
+export = envAttrCleaner;
+export { envAttrCleaner, matchPattern, shouldStrip, stripDataAttributes };
+export type { IBunBuild, IBunPlugin, IEnvAttrCleanerConfig };

package/dist/index.d.mts

@@ -0,0 +1,72 @@
+/**
+ * Per-environment configuration for data-* attribute patterns to strip.
+ * Each key is an environment name and its value is a list of glob-style patterns to remove.
+ */
+interface IEnvAttrCleanerConfig {
+    /** Map of environment names to lists of data-* attribute patterns to strip. */
+    environments: Record<string, string[]>;
+}
+/**
+ * Returns whether a data-* attribute name matches a glob-style pattern.
+ * Supports `*` as a wildcard.
+ *
+ * @param attr - The attribute name to test (e.g. `data-test-id`).
+ * @param pattern - The glob pattern to match against (e.g. `data-test-*`).
+ */
+declare function matchPattern(attr: string, pattern: string): boolean;
+/**
+ * Returns whether a data-* attribute should be stripped,
+ * i.e. whether it matches at least one of the strip patterns.
+ *
+ * @param attr - The attribute name to test.
+ * @param patterns - List of glob patterns marking attributes for removal.
+ */
+declare function shouldStrip(attr: string, patterns: string[]): boolean;
+/**
+ * Strips data-* attributes from an HTML or source code string
+ * when they match one of the given patterns. All other attributes are preserved.
+ *
+ * @param code - The source string to process.
+ * @param stripPatterns - List of glob patterns for attributes to remove.
+ * @returns The processed string with matched data-* attributes removed.
+ */
+declare function stripDataAttributes(code: string, stripPatterns: string[]): string;
+
+/** Subset of the Bun build API used by the envAttrCleaner plugin. */
+interface IBunBuild {
+    onLoad: (options: {
+        filter: RegExp;
+    }, callback: (args: {
+        path: string;
+    }) => Promise<{
+        contents: string;
+        loader: string;
+    }>) => void;
+}
+/** Shape of a Bun bundler plugin. */
+interface IBunPlugin {
+    name: string;
+    setup: (build: IBunBuild) => void;
+}
+/**
+ * Bun plugin that strips non-allowed data-* attributes from source files at build time,
+ * based on the current `NODE_ENV`.
+ *
+ * @param userConfig - Optional partial configuration to override the default environment patterns.
+ * @returns A Bun plugin object to pass to `Bun.build({ plugins: [...] })`.
+ *
+ * @example
+ * ```ts
+ * import envAttrCleaner from 'env-attr-cleaner-bun'
+ *
+ * await Bun.build({
+ *     entrypoints: ['./src/index.tsx'],
+ *     outdir: './dist',
+ *     plugins: [envAttrCleaner()]
+ * })
+ * ```
+ */
+declare function envAttrCleaner(userConfig?: Partial<IEnvAttrCleanerConfig>): IBunPlugin;
+
+export { envAttrCleaner as default, envAttrCleaner, matchPattern, shouldStrip, stripDataAttributes };
+export type { IBunBuild, IBunPlugin, IEnvAttrCleanerConfig };

package/dist/index.d.ts

@@ -0,0 +1,74 @@
+/**
+ * Per-environment configuration for data-* attribute patterns to strip.
+ * Each key is an environment name and its value is a list of glob-style patterns to remove.
+ */
+interface IEnvAttrCleanerConfig {
+    /** Map of environment names to lists of data-* attribute patterns to strip. */
+    environments: Record<string, string[]>;
+}
+/**
+ * Returns whether a data-* attribute name matches a glob-style pattern.
+ * Supports `*` as a wildcard.
+ *
+ * @param attr - The attribute name to test (e.g. `data-test-id`).
+ * @param pattern - The glob pattern to match against (e.g. `data-test-*`).
+ */
+declare function matchPattern(attr: string, pattern: string): boolean;
+/**
+ * Returns whether a data-* attribute should be stripped,
+ * i.e. whether it matches at least one of the strip patterns.
+ *
+ * @param attr - The attribute name to test.
+ * @param patterns - List of glob patterns marking attributes for removal.
+ */
+declare function shouldStrip(attr: string, patterns: string[]): boolean;
+/**
+ * Strips data-* attributes from an HTML or source code string
+ * when they match one of the given patterns. All other attributes are preserved.
+ *
+ * @param code - The source string to process.
+ * @param stripPatterns - List of glob patterns for attributes to remove.
+ * @returns The processed string with matched data-* attributes removed.
+ */
+declare function stripDataAttributes(code: string, stripPatterns: string[]): string;
+
+/** Subset of the Bun build API used by the envAttrCleaner plugin. */
+interface IBunBuild {
+    onLoad: (options: {
+        filter: RegExp;
+    }, callback: (args: {
+        path: string;
+    }) => Promise<{
+        contents: string;
+        loader: string;
+    }>) => void;
+}
+/** Shape of a Bun bundler plugin. */
+interface IBunPlugin {
+    name: string;
+    setup: (build: IBunBuild) => void;
+}
+/**
+ * Bun plugin that strips non-allowed data-* attributes from source files at build time,
+ * based on the current `NODE_ENV`.
+ *
+ * @param userConfig - Optional partial configuration to override the default environment patterns.
+ * @returns A Bun plugin object to pass to `Bun.build({ plugins: [...] })`.
+ *
+ * @example
+ * ```ts
+ * import envAttrCleaner from 'env-attr-cleaner-bun'
+ *
+ * await Bun.build({
+ *     entrypoints: ['./src/index.tsx'],
+ *     outdir: './dist',
+ *     plugins: [envAttrCleaner()]
+ * })
+ * ```
+ */
+declare function envAttrCleaner(userConfig?: Partial<IEnvAttrCleanerConfig>): IBunPlugin;
+
+// @ts-ignore
+export = envAttrCleaner;
+export { envAttrCleaner, matchPattern, shouldStrip, stripDataAttributes };
+export type { IBunBuild, IBunPlugin, IEnvAttrCleanerConfig };

package/dist/index.mjs

@@ -0,0 +1,51 @@
+const DEFAULT_CONFIG = {
+  environments: {
+    development: [],
+    test: [],
+    staging: ["data-test-*", "data-debug-*"],
+    production: ["data-test-*", "data-debug-*"]
+  }
+};
+function matchPattern(attr, pattern) {
+  const regex = new RegExp("^" + pattern.replace(/\*/g, ".*") + "$");
+  return regex.test(attr);
+}
+function shouldStrip(attr, patterns) {
+  return patterns.some((pattern) => matchPattern(attr, pattern));
+}
+function stripDataAttributes(code, stripPatterns) {
+  return code.replace(/\s+(data-[\w-]+)=(?:"[^"]*"|'[^']*')/g, (match, attr) => {
+    if (shouldStrip(attr, stripPatterns)) {
+      return "";
+    }
+    return match;
+  });
+}
+function resolvePatterns(config) {
+  const env = process.env.NODE_ENV ?? "development";
+  return config.environments[env] ?? [];
+}
+
+const BUN_FILE_PATTERN = /\.(tsx?|jsx?|vue|svelte)$/;
+function envAttrCleaner(userConfig = {}) {
+  const config = {
+    environments: { ...DEFAULT_CONFIG.environments, ...userConfig.environments }
+  };
+  const allowedPatterns = resolvePatterns(config);
+  return {
+    name: "bun-plugin-env-attr-cleaner",
+    setup(build) {
+      build.onLoad({ filter: BUN_FILE_PATTERN }, async (args) => {
+        const fs = await import('fs');
+        const source = fs.readFileSync(args.path, "utf8");
+        const loader = args.path.endsWith(".ts") || args.path.endsWith(".tsx") ? "ts" : "js";
+        return {
+          contents: stripDataAttributes(source, allowedPatterns),
+          loader
+        };
+      });
+    }
+  };
+}
+
+export { envAttrCleaner as default, envAttrCleaner, matchPattern, shouldStrip, stripDataAttributes };

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "env-attr-cleaner-bun",
+  "version": "1.0.0",
+  "description": "Bun plugin to strip data-* attributes from production builds",
+  "author": "techmefr",
+  "license": "MIT",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "bun",
+    "bundler",
+    "data-attributes",
+    "testing",
+    "e2e",
+    "playwright",
+    "cypress"
+  ],
+  "homepage": "https://github.com/techmefr/env-attr-cleaner/tree/main/packages/bun#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/techmefr/env-attr-cleaner.git",
+    "directory": "packages/bun"
+  },
+  "bugs": {
+    "url": "https://github.com/techmefr/env-attr-cleaner/issues"
+  },
+  "devDependencies": {
+    "unbuild": "^3.0.0",
+    "vitest": "^1.6.0",
+    "typescript": "^5.3.3"
+  },
+  "scripts": {
+    "build": "unbuild",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit"
+  }
+}