@web-remarq/unplugin 0.0.1 → 0.0.3

package/README.md

@@ -0,0 +1,154 @@
+# @web-remarq/unplugin
+
+Universal build plugin that injects source location attributes into JSX and Vue template elements for [web-remarq](https://www.npmjs.com/package/web-remarq).
+
+Works with Vite, webpack, Rollup, esbuild, and Rspack. Supports JSX/TSX and Vue SFC templates.
+
+## Install
+
+```bash
+npm install -D @web-remarq/unplugin
+```
+
+## Setup
+
+### Vite
+
+```js
+// vite.config.js
+import remarq from '@web-remarq/unplugin/vite'
+
+export default {
+  plugins: [remarq()]
+}
+```
+
+### webpack
+
+```js
+// webpack.config.js
+const remarq = require('@web-remarq/unplugin/webpack').default
+
+module.exports = {
+  plugins: [remarq()]
+}
+```
+
+### Rollup
+
+```js
+// rollup.config.js
+import remarq from '@web-remarq/unplugin/rollup'
+
+export default {
+  plugins: [remarq()]
+}
+```
+
+### esbuild
+
+```js
+import remarq from '@web-remarq/unplugin/esbuild'
+import { build } from 'esbuild'
+
+build({
+  plugins: [remarq()]
+})
+```
+
+### Rspack
+
+```js
+// rspack.config.js
+const remarq = require('@web-remarq/unplugin/rspack').default
+
+module.exports = {
+  plugins: [remarq()]
+}
+```
+
+## What it does
+
+Transforms this:
+
+```jsx
+function LoginForm() {
+  return <button className="submit">Log in</button>
+}
+```
+
+Into this:
+
+```jsx
+function LoginForm() {
+  return <button className="submit"
+    data-remarq-source="src/components/LoginForm.tsx:3:9"
+    data-remarq-component="LoginForm">Log in</button>
+}
+```
+
+Vue SFC templates are also transformed:
+
+```vue
+<template>
+  <div class="wrapper">
+    <button>Save</button>
+  </div>
+</template>
+```
+
+Becomes:
+
+```vue
+<template>
+  <div class="wrapper"
+    data-remarq-source="src/components/SavePanel.vue:2:4"
+    data-remarq-component="SavePanel">
+    <button
+      data-remarq-source="src/components/SavePanel.vue:3:8"
+      data-remarq-component="SavePanel">Save</button>
+  </div>
+</template>
+```
+
+## Options
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `include` | `string[]` | `['**/*.jsx', '**/*.tsx', '**/*.vue']` | Glob patterns for files to transform |
+| `exclude` | `string[]` | `['node_modules/**']` | Glob patterns to skip |
+| `production` | `boolean` | `false` | Enable in production builds |
+
+```js
+remarq({
+  include: ['src/**/*.tsx', 'src/**/*.vue'],
+  exclude: ['node_modules/**', '**/*.test.*'],
+  production: false,
+})
+```
+
+**Security note:** `production: true` exposes source file paths in the DOM. Use only for internal/staging environments.
+
+## JSX/TSX
+
+Uses `@babel/parser` for AST-based transformation. Handles TypeScript, decorators, and all JSX patterns. Component name is detected from the nearest function/class declaration.
+
+## Vue SFC
+
+Parses `<template>` blocks and injects attributes on HTML elements. Vue built-in tags (`template`, `slot`, `component`, `transition`, `keep-alive`, `teleport`, `suspense`) are skipped. Component name is derived from the filename.
+
+## How it differs from `@web-remarq/babel-plugin`
+
+| | `@web-remarq/babel-plugin` | `@web-remarq/unplugin` |
+|-|---|---|
+| **Use when** | Project uses Babel | Project uses Vite/SWC/esbuild without Babel |
+| **Bundlers** | Babel only | Vite, webpack, Rollup, esbuild, Rspack |
+| **JSX** | Yes | Yes |
+| **Vue SFC** | No | Yes |
+| **Parsing** | Babel AST (native) | `@babel/parser` (bundled) |
+
+If your project already uses Babel, prefer `@web-remarq/babel-plugin` — it's lighter and integrates natively.
+
+## License
+
+MIT

package/dist/{chunk-PRGGVU7P.cjs → chunk-LXJOI4H7.cjs}

@@ -15,7 +15,7 @@ function findComponentName(ast, jsxStart) {
       }
       if (node.type === "ExportDefaultDeclaration") {
         const decl = node.declaration;
-        if (decl.type === "FunctionDeclaration" && decl.id && typeof decl.id.name === "string") {
+        if ((decl.type === "FunctionDeclaration" || decl.type === "ClassDeclaration") && decl.id && typeof decl.id.name === "string") {
           return decl.id.name;
         }
       }
@@ -39,6 +39,9 @@ function findComponentName(ast, jsxStart) {
       if (decl.type === "FunctionDeclaration" && decl.id && containsPosition(decl, jsxStart)) {
         return decl.id.name;
       }
+      if (decl.type === "ClassDeclaration" && decl.id && containsPosition(decl, jsxStart)) {
+        return decl.id.name;
+      }
     }
     if (node.type === "ClassDeclaration" && node.id && containsPosition(node, jsxStart)) {
       return node.id.name;
@@ -162,7 +165,7 @@ var DEFAULT_INCLUDE = ["**/*.jsx", "**/*.tsx", "**/*.vue"];
 var DEFAULT_EXCLUDE = ["node_modules/**"];
 function createFilter(include, exclude) {
   function toRegex(glob) {
-    const escaped = glob.replace(/[.+^${}()|[\]\\]/g, "\\$&").replace(/\*\*/g, "\xA7GLOBSTAR\xA7").replace(/\*/g, "[^/]*").replace(/§GLOBSTAR§/g, ".*").replace(/\?/g, "[^/]");
+    const escaped = glob.replace(/[.+^${}()|[\]\\]/g, "\\$&").replace(/\*\*/g, "\xA7GLOBSTAR\xA7").replace(/\*/g, "[^/]*").replace(/\/§GLOBSTAR§\//g, "\xA7OPTPATH\xA7").replace(/§GLOBSTAR§/g, ".*").replace(/\?/g, "[^/]").replace(/§OPTPATH§/g, "/(?:.*/)?");
     return new RegExp(`(?:^|/)${escaped}$`);
   }
   const includePatterns = include.map(toRegex);

package/dist/{chunk-CRVREGZW.js → chunk-XB3NQOJG.js}

@@ -15,7 +15,7 @@ function findComponentName(ast, jsxStart) {
       }
       if (node.type === "ExportDefaultDeclaration") {
         const decl = node.declaration;
-        if (decl.type === "FunctionDeclaration" && decl.id && typeof decl.id.name === "string") {
+        if ((decl.type === "FunctionDeclaration" || decl.type === "ClassDeclaration") && decl.id && typeof decl.id.name === "string") {
           return decl.id.name;
         }
       }
@@ -39,6 +39,9 @@ function findComponentName(ast, jsxStart) {
       if (decl.type === "FunctionDeclaration" && decl.id && containsPosition(decl, jsxStart)) {
         return decl.id.name;
       }
+      if (decl.type === "ClassDeclaration" && decl.id && containsPosition(decl, jsxStart)) {
+        return decl.id.name;
+      }
     }
     if (node.type === "ClassDeclaration" && node.id && containsPosition(node, jsxStart)) {
       return node.id.name;
@@ -162,7 +165,7 @@ var DEFAULT_INCLUDE = ["**/*.jsx", "**/*.tsx", "**/*.vue"];
 var DEFAULT_EXCLUDE = ["node_modules/**"];
 function createFilter(include, exclude) {
   function toRegex(glob) {
-    const escaped = glob.replace(/[.+^${}()|[\]\\]/g, "\\$&").replace(/\*\*/g, "\xA7GLOBSTAR\xA7").replace(/\*/g, "[^/]*").replace(/§GLOBSTAR§/g, ".*").replace(/\?/g, "[^/]");
+    const escaped = glob.replace(/[.+^${}()|[\]\\]/g, "\\$&").replace(/\*\*/g, "\xA7GLOBSTAR\xA7").replace(/\*/g, "[^/]*").replace(/\/§GLOBSTAR§\//g, "\xA7OPTPATH\xA7").replace(/§GLOBSTAR§/g, ".*").replace(/\?/g, "[^/]").replace(/§OPTPATH§/g, "/(?:.*/)?");
     return new RegExp(`(?:^|/)${escaped}$`);
   }
   const includePatterns = include.map(toRegex);

package/dist/esbuild.cjs

@@ -1,6 +1,6 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
-var _chunkPRGGVU7Pcjs = require('./chunk-PRGGVU7P.cjs');
+var _chunkLXJOI4H7cjs = require('./chunk-LXJOI4H7.cjs');
 
 
-exports.default = _chunkPRGGVU7Pcjs.esbuildPlugin;
+exports.default = _chunkLXJOI4H7cjs.esbuildPlugin;

package/dist/esbuild.d.cts

@@ -1,4 +1,5 @@
 export { Options, esbuildPlugin as default } from './index.cjs';
 import 'esbuild';
 import 'rollup';
+import 'vite';
 import 'unplugin';

package/dist/esbuild.d.ts

@@ -1,4 +1,5 @@
 export { Options, esbuildPlugin as default } from './index.js';
 import 'esbuild';
 import 'rollup';
+import 'vite';
 import 'unplugin';

package/dist/esbuild.js

@@ -1,6 +1,6 @@
 import {
   esbuildPlugin
-} from "./chunk-CRVREGZW.js";
+} from "./chunk-XB3NQOJG.js";
 export {
   esbuildPlugin as default
 };

package/dist/index.cjs

@@ -5,7 +5,7 @@
 
 
 
-var _chunkPRGGVU7Pcjs = require('./chunk-PRGGVU7P.cjs');
+var _chunkLXJOI4H7cjs = require('./chunk-LXJOI4H7.cjs');
 
 
 
@@ -13,4 +13,4 @@ var _chunkPRGGVU7Pcjs = require('./chunk-PRGGVU7P.cjs');
 
 
 
-exports.default = _chunkPRGGVU7Pcjs.index_default; exports.esbuildPlugin = _chunkPRGGVU7Pcjs.esbuildPlugin; exports.rollupPlugin = _chunkPRGGVU7Pcjs.rollupPlugin; exports.rspackPlugin = _chunkPRGGVU7Pcjs.rspackPlugin; exports.vitePlugin = _chunkPRGGVU7Pcjs.vitePlugin; exports.webpackPlugin = _chunkPRGGVU7Pcjs.webpackPlugin;
+exports.default = _chunkLXJOI4H7cjs.index_default; exports.esbuildPlugin = _chunkLXJOI4H7cjs.esbuildPlugin; exports.rollupPlugin = _chunkLXJOI4H7cjs.rollupPlugin; exports.rspackPlugin = _chunkLXJOI4H7cjs.rspackPlugin; exports.vitePlugin = _chunkLXJOI4H7cjs.vitePlugin; exports.webpackPlugin = _chunkLXJOI4H7cjs.webpackPlugin;

package/dist/index.d.cts

@@ -1,5 +1,6 @@
 import * as esbuild from 'esbuild';
 import * as rollup from 'rollup';
+import * as vite from 'vite';
 import * as _unplugin from 'unplugin';
 
 interface Options {
@@ -12,7 +13,7 @@ interface Options {
 }
 declare const unplugin: _unplugin.UnpluginInstance<Options, boolean>;
 
-declare const vitePlugin: (options: Options) => any;
+declare const vitePlugin: (options: Options) => vite.Plugin<any> | vite.Plugin<any>[];
 declare const rollupPlugin: (options: Options) => rollup.Plugin<any> | rollup.Plugin<any>[];
 declare const webpackPlugin: (options: Options) => WebpackPluginInstance;
 declare const esbuildPlugin: (options: Options) => esbuild.Plugin;

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import * as esbuild from 'esbuild';
 import * as rollup from 'rollup';
+import * as vite from 'vite';
 import * as _unplugin from 'unplugin';
 
 interface Options {
@@ -12,7 +13,7 @@ interface Options {
 }
 declare const unplugin: _unplugin.UnpluginInstance<Options, boolean>;
 
-declare const vitePlugin: (options: Options) => any;
+declare const vitePlugin: (options: Options) => vite.Plugin<any> | vite.Plugin<any>[];
 declare const rollupPlugin: (options: Options) => rollup.Plugin<any> | rollup.Plugin<any>[];
 declare const webpackPlugin: (options: Options) => WebpackPluginInstance;
 declare const esbuildPlugin: (options: Options) => esbuild.Plugin;

package/dist/index.js

@@ -5,7 +5,7 @@ import {
   rspackPlugin,
   vitePlugin,
   webpackPlugin
-} from "./chunk-CRVREGZW.js";
+} from "./chunk-XB3NQOJG.js";
 export {
   index_default as default,
   esbuildPlugin,

package/dist/rollup.cjs

@@ -1,6 +1,6 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
-var _chunkPRGGVU7Pcjs = require('./chunk-PRGGVU7P.cjs');
+var _chunkLXJOI4H7cjs = require('./chunk-LXJOI4H7.cjs');
 
 
-exports.default = _chunkPRGGVU7Pcjs.rollupPlugin;
+exports.default = _chunkLXJOI4H7cjs.rollupPlugin;

package/dist/rollup.d.cts

@@ -1,4 +1,5 @@
 export { Options, rollupPlugin as default } from './index.cjs';
 import 'esbuild';
 import 'rollup';
+import 'vite';
 import 'unplugin';

package/dist/rollup.d.ts

@@ -1,4 +1,5 @@
 export { Options, rollupPlugin as default } from './index.js';
 import 'esbuild';
 import 'rollup';
+import 'vite';
 import 'unplugin';

package/dist/rollup.js

@@ -1,6 +1,6 @@
 import {
   rollupPlugin
-} from "./chunk-CRVREGZW.js";
+} from "./chunk-XB3NQOJG.js";
 export {
   rollupPlugin as default
 };

package/dist/rspack.cjs

@@ -1,6 +1,6 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
-var _chunkPRGGVU7Pcjs = require('./chunk-PRGGVU7P.cjs');
+var _chunkLXJOI4H7cjs = require('./chunk-LXJOI4H7.cjs');
 
 
-exports.default = _chunkPRGGVU7Pcjs.rspackPlugin;
+exports.default = _chunkLXJOI4H7cjs.rspackPlugin;

package/dist/rspack.d.cts

@@ -1,4 +1,5 @@
 export { Options, rspackPlugin as default } from './index.cjs';
 import 'esbuild';
 import 'rollup';
+import 'vite';
 import 'unplugin';

package/dist/rspack.d.ts

@@ -1,4 +1,5 @@
 export { Options, rspackPlugin as default } from './index.js';
 import 'esbuild';
 import 'rollup';
+import 'vite';
 import 'unplugin';

package/dist/rspack.js

@@ -1,6 +1,6 @@
 import {
   rspackPlugin
-} from "./chunk-CRVREGZW.js";
+} from "./chunk-XB3NQOJG.js";
 export {
   rspackPlugin as default
 };

package/dist/vite.cjs

@@ -1,6 +1,6 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
-var _chunkPRGGVU7Pcjs = require('./chunk-PRGGVU7P.cjs');
+var _chunkLXJOI4H7cjs = require('./chunk-LXJOI4H7.cjs');
 
 
-exports.default = _chunkPRGGVU7Pcjs.vitePlugin;
+exports.default = _chunkLXJOI4H7cjs.vitePlugin;

package/dist/vite.d.cts

@@ -1,4 +1,5 @@
 export { Options, vitePlugin as default } from './index.cjs';
 import 'esbuild';
 import 'rollup';
+import 'vite';
 import 'unplugin';

package/dist/vite.d.ts

@@ -1,4 +1,5 @@
 export { Options, vitePlugin as default } from './index.js';
 import 'esbuild';
 import 'rollup';
+import 'vite';
 import 'unplugin';

package/dist/vite.js

@@ -1,6 +1,6 @@
 import {
   vitePlugin
-} from "./chunk-CRVREGZW.js";
+} from "./chunk-XB3NQOJG.js";
 export {
   vitePlugin as default
 };

package/dist/webpack.cjs

@@ -1,6 +1,6 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
-var _chunkPRGGVU7Pcjs = require('./chunk-PRGGVU7P.cjs');
+var _chunkLXJOI4H7cjs = require('./chunk-LXJOI4H7.cjs');
 
 
-exports.default = _chunkPRGGVU7Pcjs.webpackPlugin;
+exports.default = _chunkLXJOI4H7cjs.webpackPlugin;

package/dist/webpack.d.cts

@@ -1,4 +1,5 @@
 export { Options, webpackPlugin as default } from './index.cjs';
 import 'esbuild';
 import 'rollup';
+import 'vite';
 import 'unplugin';

package/dist/webpack.d.ts

@@ -1,4 +1,5 @@
 export { Options, webpackPlugin as default } from './index.js';
 import 'esbuild';
 import 'rollup';
+import 'vite';
 import 'unplugin';

package/dist/webpack.js

@@ -1,6 +1,6 @@
 import {
   webpackPlugin
-} from "./chunk-CRVREGZW.js";
+} from "./chunk-XB3NQOJG.js";
 export {
   webpackPlugin as default
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@web-remarq/unplugin",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "Unplugin for web-remarq source location injection (Vite/webpack/Rollup/esbuild/Rspack)",
   "type": "module",
   "main": "dist/index.cjs",