@qmuse/component-tagger-vite-plugin 0.0.1

package/LEGAL.md

@@ -0,0 +1,7 @@
+Legal Disclaimer
+
+Within this source code, the comments in Chinese shall be the original, governing version. Any comment in other languages are for reference only. In the event of any conflict between the Chinese language version comments and other language comments, the Chinese language version shall prevail.
+
+法律免责声明
+
+关于代码注释部分，中文注释为官方版本，其它语言注释仅做参考。中文注释可能与其它语言注释存在不一致，当中文注释与其它语言注释存在不一致时，请以中文注释为准。

package/README.md

@@ -0,0 +1,43 @@
+# @qmuse/component-tagger-vite-plugin
+
+Vite 版本的 QMuse component tagger 插件，用于在开发模式下为 React JSX/TSX 代码注入组件和元素源码标记。
+
+## 安装
+
+```bash
+npm install @qmuse/component-tagger-vite-plugin
+```
+
+## 使用
+
+```ts
+import { defineConfig } from 'vite';
+import react from '@vitejs/plugin-react';
+import componentTaggerVitePlugin from '@qmuse/component-tagger-vite-plugin';
+
+export default defineConfig({
+  plugins: [componentTaggerVitePlugin(), react()],
+});
+```
+
+默认只在 Vite dev server 下生效。如果需要在 build 时也注入标记：
+
+```ts
+componentTaggerVitePlugin({
+  onlyDev: false,
+});
+```
+
+## 选项
+
+```ts
+componentTaggerVitePlugin({
+  onlyDev: true,
+  include: /src\/.*\.[jt]sx?$/,
+  exclude: /node_modules/,
+});
+```
+
+- `onlyDev`: 默认 `true`，只在 `vite serve` 或 development mode 注入。
+- `include`: 可选，额外限制需要处理的文件。
+- `exclude`: 可选，排除不需要处理的文件。

package/dist/cjs/index.d.ts

@@ -0,0 +1,37 @@
+interface LoaderOptions {
+    enabled?: boolean;
+    sourceDir?: string;
+    tagComponents?: boolean;
+    tagElements?: boolean;
+}
+type FilterPattern = RegExp | string | ((id: string) => boolean);
+interface ComponentTaggerViteOptions {
+    onlyDev?: boolean;
+    include?: FilterPattern | FilterPattern[];
+    exclude?: FilterPattern | FilterPattern[];
+    loaderOptions?: LoaderOptions;
+}
+interface Alias {
+    find: string | RegExp;
+    replacement: string;
+}
+interface ResolvedViteConfig {
+    root: string;
+    command?: string;
+    mode?: string;
+    resolve?: {
+        alias?: Alias[] | Record<string, string>;
+    };
+}
+interface VitePlugin {
+    name: string;
+    enforce: 'pre';
+    configResolved(config: ResolvedViteConfig): void;
+    transform(source: string, id: string): {
+        code: string;
+        map: null;
+    } | null;
+}
+declare function componentTaggerVitePlugin(options?: ComponentTaggerViteOptions): VitePlugin;
+export { componentTaggerVitePlugin };
+export default componentTaggerVitePlugin;

package/dist/cjs/index.js

@@ -0,0 +1,173 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  componentTaggerVitePlugin: () => componentTaggerVitePlugin,
+  default: () => src_default
+});
+module.exports = __toCommonJS(src_exports);
+var import_fs = __toESM(require("fs"));
+var import_path = __toESM(require("path"));
+var import_component_tagger_webpack_loader = __toESM(require("@qmuse/component-tagger-webpack-loader"));
+var DEFAULT_EXT_RE = /\.(js|ts|jsx|tsx)$/;
+function cleanUrl(id) {
+  return id.replace(/[?#].*$/, "");
+}
+function normalizePath(filePath) {
+  return filePath.replace(/\\/g, "/");
+}
+function toArray(value) {
+  if (!value)
+    return [];
+  return Array.isArray(value) ? value : [value];
+}
+function matchesPattern(pattern, id) {
+  if (typeof pattern === "function")
+    return pattern(id);
+  if (typeof pattern === "string")
+    return id.includes(pattern);
+  return pattern.test(id);
+}
+function normalizeAliases(alias) {
+  if (!alias)
+    return [];
+  if (Array.isArray(alias))
+    return alias;
+  return Object.keys(alias).map((find) => ({
+    find,
+    replacement: alias[find]
+  }));
+}
+function toProjectRelative(projectRoot, filePath) {
+  const normalizedRoot = normalizePath(projectRoot);
+  const normalizedPath = normalizePath(filePath);
+  if (normalizedPath === normalizedRoot)
+    return "";
+  if (normalizedPath.startsWith(`${normalizedRoot}/`)) {
+    return normalizedPath.slice(normalizedRoot.length + 1);
+  }
+  return normalizedPath.replace(/^\/+/, "");
+}
+function resolveAlias(request, aliases, projectRoot) {
+  for (const alias of aliases) {
+    if (typeof alias.find === "string") {
+      const { find, replacement } = alias;
+      if (request !== find && !request.startsWith(`${find}/`))
+        continue;
+      const suffix = request.slice(find.length).replace(/^\/+/, "");
+      const resolved2 = import_path.default.isAbsolute(replacement) ? import_path.default.join(replacement, suffix) : import_path.default.resolve(projectRoot, replacement, suffix);
+      return toProjectRelative(projectRoot, resolved2);
+    }
+    if (!alias.find.test(request))
+      continue;
+    const replaced = request.replace(alias.find, alias.replacement);
+    const resolved = import_path.default.isAbsolute(replaced) ? replaced : import_path.default.resolve(projectRoot, replaced);
+    return toProjectRelative(projectRoot, resolved);
+  }
+  return null;
+}
+function createWebpackUtils(projectRoot, aliases) {
+  return {
+    absolutify(context, request) {
+      const aliasResolved = resolveAlias(request, aliases, projectRoot);
+      if (aliasResolved)
+        return aliasResolved;
+      if (request.startsWith(".")) {
+        return toProjectRelative(projectRoot, import_path.default.resolve(projectRoot, context, request));
+      }
+      if (import_path.default.isAbsolute(request)) {
+        return toProjectRelative(projectRoot, request);
+      }
+      return request;
+    }
+  };
+}
+function createLoaderFs() {
+  return {
+    fileSystem: import_fs.default,
+    existsSync: import_fs.default.existsSync.bind(import_fs.default),
+    readFileSync: import_fs.default.readFileSync.bind(import_fs.default)
+  };
+}
+function shouldTransform(filePath, options) {
+  if (filePath.includes("node_modules"))
+    return false;
+  if (!DEFAULT_EXT_RE.test(filePath))
+    return false;
+  const include = toArray(options.include);
+  if (include.length && !include.some((pattern) => matchesPattern(pattern, filePath))) {
+    return false;
+  }
+  return !toArray(options.exclude).some((pattern) => matchesPattern(pattern, filePath));
+}
+function componentTaggerVitePlugin(options = {}) {
+  let projectRoot = process.cwd();
+  let aliases = [];
+  let isDev = process.env.NODE_ENV === "development";
+  return {
+    name: "qmuse-component-tagger-vite-plugin",
+    enforce: "pre",
+    configResolved(config) {
+      var _a;
+      projectRoot = config.root || process.cwd();
+      aliases = normalizeAliases((_a = config.resolve) == null ? void 0 : _a.alias);
+      isDev = config.command === "serve" || config.mode === "development" || process.env.NODE_ENV === "development";
+    },
+    transform(source, id) {
+      if (options.onlyDev !== false && !isDev)
+        return null;
+      if (id.includes("\0"))
+        return null;
+      const filePath = cleanUrl(id);
+      if (!shouldTransform(filePath, options))
+        return null;
+      const resourcePath = import_path.default.isAbsolute(filePath) ? filePath : import_path.default.resolve(projectRoot, filePath);
+      const loaderContext = {
+        getOptions: () => options.loaderOptions || {},
+        resourcePath,
+        rootContext: projectRoot,
+        fs: createLoaderFs(),
+        utils: createWebpackUtils(projectRoot, aliases)
+      };
+      const code = import_component_tagger_webpack_loader.default.call(loaderContext, source);
+      if (!code || code === source)
+        return null;
+      return {
+        code,
+        map: null
+      };
+    }
+  };
+}
+var src_default = componentTaggerVitePlugin;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  componentTaggerVitePlugin
+});

package/dist/esm/index.d.ts

@@ -0,0 +1,37 @@
+interface LoaderOptions {
+    enabled?: boolean;
+    sourceDir?: string;
+    tagComponents?: boolean;
+    tagElements?: boolean;
+}
+type FilterPattern = RegExp | string | ((id: string) => boolean);
+interface ComponentTaggerViteOptions {
+    onlyDev?: boolean;
+    include?: FilterPattern | FilterPattern[];
+    exclude?: FilterPattern | FilterPattern[];
+    loaderOptions?: LoaderOptions;
+}
+interface Alias {
+    find: string | RegExp;
+    replacement: string;
+}
+interface ResolvedViteConfig {
+    root: string;
+    command?: string;
+    mode?: string;
+    resolve?: {
+        alias?: Alias[] | Record<string, string>;
+    };
+}
+interface VitePlugin {
+    name: string;
+    enforce: 'pre';
+    configResolved(config: ResolvedViteConfig): void;
+    transform(source: string, id: string): {
+        code: string;
+        map: null;
+    } | null;
+}
+declare function componentTaggerVitePlugin(options?: ComponentTaggerViteOptions): VitePlugin;
+export { componentTaggerVitePlugin };
+export default componentTaggerVitePlugin;

package/dist/esm/index.js

@@ -0,0 +1,140 @@
+import _createForOfIteratorHelper from "@babel/runtime/helpers/esm/createForOfIteratorHelper";
+import fs from 'fs';
+import path from 'path';
+import componentTaggerLoader from '@qmuse/component-tagger-webpack-loader';
+var DEFAULT_EXT_RE = /\.(js|ts|jsx|tsx)$/;
+function cleanUrl(id) {
+  return id.replace(/[?#].*$/, '');
+}
+function normalizePath(filePath) {
+  return filePath.replace(/\\/g, '/');
+}
+function toArray(value) {
+  if (!value) return [];
+  return Array.isArray(value) ? value : [value];
+}
+function matchesPattern(pattern, id) {
+  if (typeof pattern === 'function') return pattern(id);
+  if (typeof pattern === 'string') return id.includes(pattern);
+  return pattern.test(id);
+}
+function normalizeAliases(alias) {
+  if (!alias) return [];
+  if (Array.isArray(alias)) return alias;
+  return Object.keys(alias).map(function (find) {
+    return {
+      find: find,
+      replacement: alias[find]
+    };
+  });
+}
+function toProjectRelative(projectRoot, filePath) {
+  var normalizedRoot = normalizePath(projectRoot);
+  var normalizedPath = normalizePath(filePath);
+  if (normalizedPath === normalizedRoot) return '';
+  if (normalizedPath.startsWith("".concat(normalizedRoot, "/"))) {
+    return normalizedPath.slice(normalizedRoot.length + 1);
+  }
+  return normalizedPath.replace(/^\/+/, '');
+}
+function resolveAlias(request, aliases, projectRoot) {
+  var _iterator = _createForOfIteratorHelper(aliases),
+    _step;
+  try {
+    for (_iterator.s(); !(_step = _iterator.n()).done;) {
+      var alias = _step.value;
+      if (typeof alias.find === 'string') {
+        var find = alias.find,
+          replacement = alias.replacement;
+        if (request !== find && !request.startsWith("".concat(find, "/"))) continue;
+        var suffix = request.slice(find.length).replace(/^\/+/, '');
+        var _resolved = path.isAbsolute(replacement) ? path.join(replacement, suffix) : path.resolve(projectRoot, replacement, suffix);
+        return toProjectRelative(projectRoot, _resolved);
+      }
+      if (!alias.find.test(request)) continue;
+      var replaced = request.replace(alias.find, alias.replacement);
+      var resolved = path.isAbsolute(replaced) ? replaced : path.resolve(projectRoot, replaced);
+      return toProjectRelative(projectRoot, resolved);
+    }
+  } catch (err) {
+    _iterator.e(err);
+  } finally {
+    _iterator.f();
+  }
+  return null;
+}
+function createWebpackUtils(projectRoot, aliases) {
+  return {
+    absolutify: function absolutify(context, request) {
+      var aliasResolved = resolveAlias(request, aliases, projectRoot);
+      if (aliasResolved) return aliasResolved;
+      if (request.startsWith('.')) {
+        return toProjectRelative(projectRoot, path.resolve(projectRoot, context, request));
+      }
+      if (path.isAbsolute(request)) {
+        return toProjectRelative(projectRoot, request);
+      }
+      return request;
+    }
+  };
+}
+function createLoaderFs() {
+  return {
+    fileSystem: fs,
+    existsSync: fs.existsSync.bind(fs),
+    readFileSync: fs.readFileSync.bind(fs)
+  };
+}
+function shouldTransform(filePath, options) {
+  if (filePath.includes('node_modules')) return false;
+  if (!DEFAULT_EXT_RE.test(filePath)) return false;
+  var include = toArray(options.include);
+  if (include.length && !include.some(function (pattern) {
+    return matchesPattern(pattern, filePath);
+  })) {
+    return false;
+  }
+  return !toArray(options.exclude).some(function (pattern) {
+    return matchesPattern(pattern, filePath);
+  });
+}
+function componentTaggerVitePlugin() {
+  var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  var projectRoot = process.cwd();
+  var aliases = [];
+  var isDev = process.env.NODE_ENV === 'development';
+  return {
+    name: 'qmuse-component-tagger-vite-plugin',
+    enforce: 'pre',
+    configResolved: function configResolved(config) {
+      var _config$resolve;
+      projectRoot = config.root || process.cwd();
+      aliases = normalizeAliases((_config$resolve = config.resolve) === null || _config$resolve === void 0 ? void 0 : _config$resolve.alias);
+      isDev = config.command === 'serve' || config.mode === 'development' || process.env.NODE_ENV === 'development';
+    },
+    transform: function transform(source, id) {
+      if (options.onlyDev !== false && !isDev) return null;
+      if (id.includes('\0')) return null;
+      var filePath = cleanUrl(id);
+      if (!shouldTransform(filePath, options)) return null;
+      var resourcePath = path.isAbsolute(filePath) ? filePath : path.resolve(projectRoot, filePath);
+      var loaderContext = {
+        getOptions: function getOptions() {
+          return options.loaderOptions || {};
+        },
+        resourcePath: resourcePath,
+        rootContext: projectRoot,
+        fs: createLoaderFs(),
+        utils: createWebpackUtils(projectRoot, aliases)
+      };
+      var code = componentTaggerLoader.call(loaderContext, source);
+      if (!code || code === source) return null;
+      return {
+        code: code,
+        map: null
+      };
+    }
+  };
+}
+export { componentTaggerVitePlugin };
+export default componentTaggerVitePlugin;

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@qmuse/component-tagger-vite-plugin",
+  "version": "0.0.1",
+  "description": "component tagger vite plugin",
+  "author": "dyxuan",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "typings": "dist/esm/index.d.ts",
+  "files": [
+    "dist",
+    "LEGAL.md",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "father build",
+    "build:watch": "father build --watch",
+    "prepublishOnly": "npm run build"
+  },
+  "dependencies": {
+    "@babel/runtime": "^7.18.0",
+    "@qmuse/component-tagger-webpack-loader": "^0.0.2"
+  },
+  "devDependencies": {
+    "@babel/plugin-transform-modules-commonjs": "^7.28.6",
+    "@types/node": "^20.11.30",
+    "father": "^4.6.18",
+    "prettier": "^3.4.2"
+  },
+  "peerDependencies": {
+    "vite": ">=4.0.0"
+  },
+  "engines": {},
+  "ci": {
+    "type": "aci"
+  },
+  "libType": "UTIL",
+  "tnpm": {
+    "mode": "npm"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  }
+}