env-attr-cleaner 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,67 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const unplugin = require('unplugin');
+
+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+(?:v-bind:|:)?(data-[\w-]+)(?:\s*=\s*(?:"[^"]*"|'[^']*'|\{(?:[^{}]|\{[^{}]*\})*\}|[^\s"'`<>/{}]+)|(?=[\s/>]|$))/g,
+    (match, attr) => shouldStrip(attr, stripPatterns) ? "" : match
+  );
+}
+function resolvePatterns(config) {
+  const env = process.env.NODE_ENV ?? "development";
+  return config.environments[env] ?? [];
+}
+
+const FILE_PATTERN = /\.(vue|svelte|astro|jsx?|tsx?)$/;
+const envAttrCleanerPlugin = unplugin.createUnplugin((userConfig = {}) => {
+  const config = {
+    environments: { ...DEFAULT_CONFIG.environments, ...userConfig.environments }
+  };
+  const allowedPatterns = resolvePatterns(config);
+  return {
+    name: "env-attr-cleaner",
+    enforce: "pre",
+    transformInclude(id) {
+      return FILE_PATTERN.test(id);
+    },
+    transform(code) {
+      return stripDataAttributes(code, allowedPatterns);
+    },
+    vite: {
+      transformIndexHtml(html) {
+        return stripDataAttributes(html, allowedPatterns);
+      }
+    }
+  };
+});
+const vite = envAttrCleanerPlugin.vite;
+const rollup = envAttrCleanerPlugin.rollup;
+const webpack = envAttrCleanerPlugin.webpack;
+const esbuild = envAttrCleanerPlugin.esbuild;
+
+exports.default = envAttrCleanerPlugin;
+exports.esbuild = esbuild;
+exports.matchPattern = matchPattern;
+exports.rollup = rollup;
+exports.shouldStrip = shouldStrip;
+exports.stripDataAttributes = stripDataAttributes;
+exports.vite = vite;
+exports.webpack = webpack;

package/dist/index.d.cts

@@ -0,0 +1,79 @@
+import * as _esbuild from 'esbuild';
+import * as _webpack from 'webpack';
+import * as _rollup from 'rollup';
+import * as _vite from 'vite';
+import * as unplugin from 'unplugin';
+
+/**
+ * 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.
+ *
+ * Recognised attribute forms:
+ * - quoted values: `data-test-id="x"`, `data-test-id='x'`
+ * - expression values: `data-test-id={id}`, `` data-test-id={`p-${id}`} `` (JSX / Svelte)
+ * - bound names: `:data-test-id="x"`, `v-bind:data-test-id="x"` (Vue)
+ * - unquoted values: `data-test-id=x`
+ * - value-less attributes: `data-test-active`
+ *
+ * @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;
+
+/**
+ * Universal envAttrCleaner plugin built with unplugin.
+ * Strips non-allowed data-* attributes from source files and HTML at build time,
+ * based on the current `NODE_ENV`.
+ *
+ * Supports Vite, Rollup, Webpack, and esbuild via the named exports below.
+ *
+ * @example
+ * ```ts
+ * // vite.config.ts
+ * import { vite as envAttrCleaner } from 'env-attr-cleaner'
+ * plugins: [envAttrCleaner()]
+ *
+ * // next.config.ts
+ * import { webpack as envAttrCleaner } from 'env-attr-cleaner'
+ * webpack(config) { config.plugins.push(envAttrCleaner()); return config }
+ * ```
+ */
+declare const envAttrCleanerPlugin: unplugin.UnpluginInstance<Partial<IEnvAttrCleanerConfig>, boolean>;
+/** Vite plugin adapter. */
+declare const vite: (options: Partial<IEnvAttrCleanerConfig>) => _vite.Plugin<any> | _vite.Plugin<any>[];
+/** Rollup plugin adapter. */
+declare const rollup: (options: Partial<IEnvAttrCleanerConfig>) => _rollup.Plugin<any> | _rollup.Plugin<any>[];
+/** Webpack plugin adapter (also works with Next.js). */
+declare const webpack: (options: Partial<IEnvAttrCleanerConfig>) => _webpack.WebpackPluginInstance;
+/** esbuild plugin adapter. */
+declare const esbuild: (options: Partial<IEnvAttrCleanerConfig>) => _esbuild.Plugin;
+
+// @ts-ignore
+export = envAttrCleanerPlugin;
+export { esbuild, matchPattern, rollup, shouldStrip, stripDataAttributes, vite, webpack };
+export type { IEnvAttrCleanerConfig };

package/dist/index.d.mts

@@ -0,0 +1,77 @@
+import * as _esbuild from 'esbuild';
+import * as _webpack from 'webpack';
+import * as _rollup from 'rollup';
+import * as _vite from 'vite';
+import * as unplugin from 'unplugin';
+
+/**
+ * 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.
+ *
+ * Recognised attribute forms:
+ * - quoted values: `data-test-id="x"`, `data-test-id='x'`
+ * - expression values: `data-test-id={id}`, `` data-test-id={`p-${id}`} `` (JSX / Svelte)
+ * - bound names: `:data-test-id="x"`, `v-bind:data-test-id="x"` (Vue)
+ * - unquoted values: `data-test-id=x`
+ * - value-less attributes: `data-test-active`
+ *
+ * @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;
+
+/**
+ * Universal envAttrCleaner plugin built with unplugin.
+ * Strips non-allowed data-* attributes from source files and HTML at build time,
+ * based on the current `NODE_ENV`.
+ *
+ * Supports Vite, Rollup, Webpack, and esbuild via the named exports below.
+ *
+ * @example
+ * ```ts
+ * // vite.config.ts
+ * import { vite as envAttrCleaner } from 'env-attr-cleaner'
+ * plugins: [envAttrCleaner()]
+ *
+ * // next.config.ts
+ * import { webpack as envAttrCleaner } from 'env-attr-cleaner'
+ * webpack(config) { config.plugins.push(envAttrCleaner()); return config }
+ * ```
+ */
+declare const envAttrCleanerPlugin: unplugin.UnpluginInstance<Partial<IEnvAttrCleanerConfig>, boolean>;
+/** Vite plugin adapter. */
+declare const vite: (options: Partial<IEnvAttrCleanerConfig>) => _vite.Plugin<any> | _vite.Plugin<any>[];
+/** Rollup plugin adapter. */
+declare const rollup: (options: Partial<IEnvAttrCleanerConfig>) => _rollup.Plugin<any> | _rollup.Plugin<any>[];
+/** Webpack plugin adapter (also works with Next.js). */
+declare const webpack: (options: Partial<IEnvAttrCleanerConfig>) => _webpack.WebpackPluginInstance;
+/** esbuild plugin adapter. */
+declare const esbuild: (options: Partial<IEnvAttrCleanerConfig>) => _esbuild.Plugin;
+
+export { envAttrCleanerPlugin as default, esbuild, matchPattern, rollup, shouldStrip, stripDataAttributes, vite, webpack };
+export type { IEnvAttrCleanerConfig };

package/dist/index.d.ts

@@ -0,0 +1,79 @@
+import * as _esbuild from 'esbuild';
+import * as _webpack from 'webpack';
+import * as _rollup from 'rollup';
+import * as _vite from 'vite';
+import * as unplugin from 'unplugin';
+
+/**
+ * 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.
+ *
+ * Recognised attribute forms:
+ * - quoted values: `data-test-id="x"`, `data-test-id='x'`
+ * - expression values: `data-test-id={id}`, `` data-test-id={`p-${id}`} `` (JSX / Svelte)
+ * - bound names: `:data-test-id="x"`, `v-bind:data-test-id="x"` (Vue)
+ * - unquoted values: `data-test-id=x`
+ * - value-less attributes: `data-test-active`
+ *
+ * @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;
+
+/**
+ * Universal envAttrCleaner plugin built with unplugin.
+ * Strips non-allowed data-* attributes from source files and HTML at build time,
+ * based on the current `NODE_ENV`.
+ *
+ * Supports Vite, Rollup, Webpack, and esbuild via the named exports below.
+ *
+ * @example
+ * ```ts
+ * // vite.config.ts
+ * import { vite as envAttrCleaner } from 'env-attr-cleaner'
+ * plugins: [envAttrCleaner()]
+ *
+ * // next.config.ts
+ * import { webpack as envAttrCleaner } from 'env-attr-cleaner'
+ * webpack(config) { config.plugins.push(envAttrCleaner()); return config }
+ * ```
+ */
+declare const envAttrCleanerPlugin: unplugin.UnpluginInstance<Partial<IEnvAttrCleanerConfig>, boolean>;
+/** Vite plugin adapter. */
+declare const vite: (options: Partial<IEnvAttrCleanerConfig>) => _vite.Plugin<any> | _vite.Plugin<any>[];
+/** Rollup plugin adapter. */
+declare const rollup: (options: Partial<IEnvAttrCleanerConfig>) => _rollup.Plugin<any> | _rollup.Plugin<any>[];
+/** Webpack plugin adapter (also works with Next.js). */
+declare const webpack: (options: Partial<IEnvAttrCleanerConfig>) => _webpack.WebpackPluginInstance;
+/** esbuild plugin adapter. */
+declare const esbuild: (options: Partial<IEnvAttrCleanerConfig>) => _esbuild.Plugin;
+
+// @ts-ignore
+export = envAttrCleanerPlugin;
+export { esbuild, matchPattern, rollup, shouldStrip, stripDataAttributes, vite, webpack };
+export type { IEnvAttrCleanerConfig };

package/dist/index.mjs

@@ -0,0 +1,56 @@
+import { createUnplugin } from 'unplugin';
+
+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+(?:v-bind:|:)?(data-[\w-]+)(?:\s*=\s*(?:"[^"]*"|'[^']*'|\{(?:[^{}]|\{[^{}]*\})*\}|[^\s"'`<>/{}]+)|(?=[\s/>]|$))/g,
+    (match, attr) => shouldStrip(attr, stripPatterns) ? "" : match
+  );
+}
+function resolvePatterns(config) {
+  const env = process.env.NODE_ENV ?? "development";
+  return config.environments[env] ?? [];
+}
+
+const FILE_PATTERN = /\.(vue|svelte|astro|jsx?|tsx?)$/;
+const envAttrCleanerPlugin = createUnplugin((userConfig = {}) => {
+  const config = {
+    environments: { ...DEFAULT_CONFIG.environments, ...userConfig.environments }
+  };
+  const allowedPatterns = resolvePatterns(config);
+  return {
+    name: "env-attr-cleaner",
+    enforce: "pre",
+    transformInclude(id) {
+      return FILE_PATTERN.test(id);
+    },
+    transform(code) {
+      return stripDataAttributes(code, allowedPatterns);
+    },
+    vite: {
+      transformIndexHtml(html) {
+        return stripDataAttributes(html, allowedPatterns);
+      }
+    }
+  };
+});
+const vite = envAttrCleanerPlugin.vite;
+const rollup = envAttrCleanerPlugin.rollup;
+const webpack = envAttrCleanerPlugin.webpack;
+const esbuild = envAttrCleanerPlugin.esbuild;
+
+export { envAttrCleanerPlugin as default, esbuild, matchPattern, rollup, shouldStrip, stripDataAttributes, vite, webpack };

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "env-attr-cleaner",
+  "version": "1.0.0",
+  "description": "Universal 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": [
+    "unplugin",
+    "vite",
+    "webpack",
+    "rollup",
+    "esbuild",
+    "nuxt",
+    "nextjs",
+    "data-attributes",
+    "testing",
+    "e2e",
+    "playwright",
+    "cypress"
+  ],
+  "homepage": "https://github.com/techmefr/env-attr-cleaner/tree/main/packages/unplugin#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/techmefr/env-attr-cleaner.git",
+    "directory": "packages/unplugin"
+  },
+  "bugs": {
+    "url": "https://github.com/techmefr/env-attr-cleaner/issues"
+  },
+  "dependencies": {
+    "unplugin": "^2.0.0"
+  },
+  "peerDependencies": {
+    "vite": "^4.0.0 || ^5.0.0 || ^6.0.0",
+    "webpack": "^4.0.0 || ^5.0.0",
+    "next": "^13.0.0 || ^14.0.0 || ^15.0.0"
+  },
+  "peerDependenciesMeta": {
+    "vite": {
+      "optional": true
+    },
+    "webpack": {
+      "optional": true
+    },
+    "next": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "unbuild": "^3.0.0",
+    "vite": "^5.4.21",
+    "vitest": "^1.6.0",
+    "typescript": "^5.3.3"
+  },
+  "scripts": {
+    "build": "unbuild",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit"
+  }
+}