@lntvow/vite-plugin 1.0.8 → 1.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 lntvow
+
+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/README.md

@@ -1 +1,3 @@
-# vite-plugin
+# @lntvow/vite-plugin
+
+Collection of custom Vite plugins

package/dist/index.cjs

@@ -1,103 +1,24 @@
-"use strict";
-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);
+"use strict";var z=Object.create;var c=Object.defineProperty;var P=Object.getOwnPropertyDescriptor;var R=Object.getOwnPropertyNames;var S=Object.getPrototypeOf,E=Object.prototype.hasOwnProperty;var k=(t,e)=>{for(var n in e)c(t,n,{get:e[n],enumerable:!0})},h=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let o of R(e))!E.call(t,o)&&o!==n&&c(t,o,{get:()=>e[o],enumerable:!(r=P(e,o))||r.enumerable});return t};var u=(t,e,n)=>(n=t!=null?z(S(t)):{},h(e||!t||!t.__esModule?c(n,"default",{value:t,enumerable:!0}):n,t)),q=t=>h(c({},"__esModule",{value:!0}),t);var A={};k(A,{vitePluginEnvRibbon:()=>H,vitePluginHtml:()=>j,vitePluginLog:()=>L});module.exports=q(A);var p=require("path"),x=require("fs"),m=u(require("dayjs"),1),b=u(require("dayjs/plugin/timezone.js"),1),$=u(require("dayjs/plugin/utc.js"),1),O=require("@lntvow/utils");m.default.extend($.default);m.default.extend(b.default);function L(t={}){let{name:e="LNTVOW_VERSION",timezone:n="Asia/Shanghai"}=t,{entries:r=["src/main.ts","src/main.js"]}=t,{version:o}=t;r=(0,O.castArray)(r).map(i=>(0,p.resolve)(process.cwd(),i));let g=(0,m.default)().tz(n).format("YYYY-MM-DD HH:mm:ss");if(!o)try{let i=(0,x.readFileSync)((0,p.resolve)(process.cwd(),"package.json"),"utf8");o=JSON.parse(i).version}catch(i){o="unknown",console.log("error: ",i)}return{name:"vite-plugin-logs",transform(i,f){if(r.includes((0,p.normalize)(f)))return{code:`
+          ${i}
 
-// src/index.ts
-var src_exports = {};
-__export(src_exports, {
-  vitePluginHtml: () => vitePluginHtml,
-  vitePluginLog: () => vitePluginLog
-});
-module.exports = __toCommonJS(src_exports);
-
-// src/vite-plugin-logs.ts
-var import_node_path = __toESM(require("path"), 1);
-var import_node_fs = __toESM(require("fs"), 1);
-var import_dayjs = __toESM(require("dayjs"), 1);
-var import_utc = __toESM(require("dayjs/plugin/utc"), 1);
-var import_timezone = __toESM(require("dayjs/plugin/timezone"), 1);
-var import_utils = require("@lntvow/utils");
-import_dayjs.default.extend(import_utc.default);
-import_dayjs.default.extend(import_timezone.default);
-function vitePluginLog(options = {}) {
-  const { name = "LNTVOW_VERSION" } = options;
-  let { version } = options;
-  if (!version) {
-    try {
-      const packageJsonContent = import_node_fs.default.readFileSync(import_node_path.default.resolve(process.cwd(), "package.json"), "utf8");
-      version = JSON.parse(packageJsonContent).version;
-    } catch (e) {
-      (0, import_utils.throwError)("vitePluginLogs", "package.json not found");
-    }
-  }
-  return {
-    name: "vite-plugin-logs",
-    transform(code, id) {
-      if (id.endsWith("src/main.ts") || id.endsWith("src/main.js")) {
-        const time = (0, import_dayjs.default)().tz("Asia/Shanghai").format("YYYY-MM-DD HH:mm:ss");
-        return {
-          code: `
-
-          import { log as vitePluginLogs } from '@lntvow/utils';
-
-          ${code}
-
-          localStorage.setItem('${name}', JSON.stringify(['${time}', '${version}']))
-          vitePluginLogs('version', '${time}', '${version}')
-
-          `
-        };
-      }
-    }
-  };
-}
-
-// src/vite-plugin-html.ts
-var import_vite = require("vite");
-function vitePluginHtml() {
-  let env = {};
-  return {
-    name: "vite-plugin-html",
-    enforce: "pre",
-    config(config, { mode }) {
-      env = (0, import_vite.loadEnv)(mode, process.cwd());
-    },
-    transformIndexHtml(html) {
-      Object.keys(env).forEach((key) => {
-        const regex = new RegExp(`%${key}%`, "g");
-        html = html.replace(regex, env[key]);
-      });
-      return html;
-    }
-  };
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  vitePluginHtml,
-  vitePluginLog
-});
+          localStorage.setItem('${e}', JSON.stringify(['${g}', '${o}']))
+          console.log('[Log] version: ', ['${g}', '${o}']);
+          `}}}}var y=require("vite");function j(){let t={};return{name:"vite-plugin-html",enforce:"pre",config(e,{mode:n}){t=(0,y.loadEnv)(n,process.cwd())},transformIndexHtml(e){return Object.keys(t).forEach(n=>{let r=new RegExp(`%${n}%`,"g");e=e.replace(r,t[n])}),e}}}function H(t={}){let{width:e=150,height:n=20,fontSize:r=12,backgroundColor:o="hsla(0, 100%, 33%, 0.733)",color:g="#fff",position:i="top-right",envMap:f={}}=t,s;return{name:"vite-plugin-env-ribbon",transformIndexHtml(a){if(console.log("mode: ",s),s==="production")return a;let v=f[s]||s;if(!v)return a;let l=i==="top-left",M=l?`translate(-${n/Math.sqrt(2)}px, -${n/Math.sqrt(2)}px) translate(0, ${e/Math.sqrt(2)}px) rotate(-45deg)`:`translate(${n/Math.sqrt(2)}px, -${n/Math.sqrt(2)}px) translate(0, ${e/Math.sqrt(2)}px) rotate(45deg)`,w=`
+        position: fixed;
+        width: ${e}px;
+        height: ${n}px;
+        background: ${o};
+        color: ${g};
+        font-size: ${r}px;
+        line-height: ${n}px;
+        transform: ${M};
+        transform-origin: ${l?"left top":"right top"};
+        top: 0;
+        right: ${l?"auto":"0"};
+        left: ${l?"0":"auto"};
+        z-index: 9999;
+        text-align: center;
+        pointer-events: none;
+        user-select: none;
+        overflow: hidden;
+      `;return{html:a,tags:[{tag:"div",attrs:{style:w.replace(/\s+/g," ").trim(),class:"vite-plugin-env-ribbon","data-env-ribbon":s},children:v,injectTo:"body"}]}},configResolved(a){s=a.mode}}}0&&(module.exports={vitePluginEnvRibbon,vitePluginHtml,vitePluginLog});

package/dist/index.d.cts

@@ -1,19 +1,106 @@
-import { Plugin } from 'vite';
+import { PluginOption } from 'vite';
+import { Arrayable } from '@lntvow/utils';
 
-declare function vitePluginLog(options?: VitePluginLogOptions): Plugin;
-interface VitePluginLogOptions {
+/**
+ * This Vite plugin injects version and build time information into specified entry files.
+ * It automatically writes the current build time and project version (read from package.json by default)
+ * to localStorage and prints them to the console at runtime.
+ *
+ * This is useful for tracking deployment versions and build times in frontend projects.
+ *
+ * You can customize the localStorage key, version, timezone, and the entry files to inject via plugin options.
+ *
+ * @example
+ * import { vitePluginLog } from '@lntvow/vite-plugin'
+ *
+ * export default defineConfig({
+ *   plugins: [
+ *     vitePluginLog(),
+ *   ],
+ * })
+ */
+declare function vitePluginLog(options?: LogOptions): PluginOption;
+interface LogOptions {
     /**
-     * @description localStorage key
-     * @default LNTVOW_VERSION
+     * The key used for localStorage.
+     * @default 'LNTVOW_VERSION'
      */
     name?: string;
     /**
-     * @description 版本号
-     * @default 默认读取package.json的version
+     * Project version.
+     * @default Reads the version from package.json by default.
      */
     version?: string;
+    /**
+     * Timezone setting.
+     * @default 'Asia/Shanghai'
+     */
+    timezone?: string;
+    /**
+     * The entry files to log.
+     * The path is resolved from the command line working directory (process.cwd()).
+     * @default ['src/main.ts', 'src/main.js']
+     */
+    entries?: Arrayable<string>;
 }
 
-declare function vitePluginHtml(): Plugin;
+declare function vitePluginHtml(): PluginOption;
+
+/**
+ * This Vite plugin injects a diagonal environment ribbon into the built HTML page.
+ * The ribbon displays the current environment (such as development, test, uat, pre.)
+ * in the top-left or top-right corner of the page, similar to environment tags seen in some mobile app demos.
+ *
+ * The ribbon will NOT be injected when the current mode is 'production'.
+ *
+ * You can customize the ribbon's width, height, font size, background color, text color, position, and environment label mapping via plugin options.
+ *
+ * @example
+ * import { vitePluginEnvRibbon } from '@lntvow/vite-plugin'
+ *
+ * export default defineConfig({
+ *   plugins: [
+ *     vitePluginEnvRibbon(),
+ *   ],
+ * })
+ */
+declare function vitePluginEnvRibbon(options?: EnvRibbonOptions): PluginOption;
+interface EnvRibbonOptions {
+    /**
+     * The height of the banner.
+     * @default 20
+     */
+    height?: number;
+    /**
+     * The width of the banner.
+     * @default 150
+     */
+    width?: number;
+    /**
+     * The font size of the banner text.
+     * @default 12
+     */
+    fontSize?: number;
+    /**
+     * The background color of the banner.
+     * @default 'hsla(0, 100%, 33%, 0.733)'
+     */
+    backgroundColor?: string;
+    /**
+     * The text color of the banner.
+     * @default '#fff'
+     */
+    color?: string;
+    /**
+     * The position of the banner on the screen.
+     * @default 'top-right'
+     */
+    position?: 'top-right' | 'top-left';
+    /**
+     * The mapping of environment modes to display labels.
+     * @default {}
+     */
+    envMap?: Record<string, string>;
+}
 
-export { type VitePluginLogOptions, vitePluginHtml, vitePluginLog };
+export { type EnvRibbonOptions, type LogOptions, vitePluginEnvRibbon, vitePluginHtml, vitePluginLog };

package/dist/index.d.ts

@@ -1,19 +1,106 @@
-import { Plugin } from 'vite';
+import { PluginOption } from 'vite';
+import { Arrayable } from '@lntvow/utils';
 
-declare function vitePluginLog(options?: VitePluginLogOptions): Plugin;
-interface VitePluginLogOptions {
+/**
+ * This Vite plugin injects version and build time information into specified entry files.
+ * It automatically writes the current build time and project version (read from package.json by default)
+ * to localStorage and prints them to the console at runtime.
+ *
+ * This is useful for tracking deployment versions and build times in frontend projects.
+ *
+ * You can customize the localStorage key, version, timezone, and the entry files to inject via plugin options.
+ *
+ * @example
+ * import { vitePluginLog } from '@lntvow/vite-plugin'
+ *
+ * export default defineConfig({
+ *   plugins: [
+ *     vitePluginLog(),
+ *   ],
+ * })
+ */
+declare function vitePluginLog(options?: LogOptions): PluginOption;
+interface LogOptions {
     /**
-     * @description localStorage key
-     * @default LNTVOW_VERSION
+     * The key used for localStorage.
+     * @default 'LNTVOW_VERSION'
      */
     name?: string;
     /**
-     * @description 版本号
-     * @default 默认读取package.json的version
+     * Project version.
+     * @default Reads the version from package.json by default.
      */
     version?: string;
+    /**
+     * Timezone setting.
+     * @default 'Asia/Shanghai'
+     */
+    timezone?: string;
+    /**
+     * The entry files to log.
+     * The path is resolved from the command line working directory (process.cwd()).
+     * @default ['src/main.ts', 'src/main.js']
+     */
+    entries?: Arrayable<string>;
 }
 
-declare function vitePluginHtml(): Plugin;
+declare function vitePluginHtml(): PluginOption;
+
+/**
+ * This Vite plugin injects a diagonal environment ribbon into the built HTML page.
+ * The ribbon displays the current environment (such as development, test, uat, pre.)
+ * in the top-left or top-right corner of the page, similar to environment tags seen in some mobile app demos.
+ *
+ * The ribbon will NOT be injected when the current mode is 'production'.
+ *
+ * You can customize the ribbon's width, height, font size, background color, text color, position, and environment label mapping via plugin options.
+ *
+ * @example
+ * import { vitePluginEnvRibbon } from '@lntvow/vite-plugin'
+ *
+ * export default defineConfig({
+ *   plugins: [
+ *     vitePluginEnvRibbon(),
+ *   ],
+ * })
+ */
+declare function vitePluginEnvRibbon(options?: EnvRibbonOptions): PluginOption;
+interface EnvRibbonOptions {
+    /**
+     * The height of the banner.
+     * @default 20
+     */
+    height?: number;
+    /**
+     * The width of the banner.
+     * @default 150
+     */
+    width?: number;
+    /**
+     * The font size of the banner text.
+     * @default 12
+     */
+    fontSize?: number;
+    /**
+     * The background color of the banner.
+     * @default 'hsla(0, 100%, 33%, 0.733)'
+     */
+    backgroundColor?: string;
+    /**
+     * The text color of the banner.
+     * @default '#fff'
+     */
+    color?: string;
+    /**
+     * The position of the banner on the screen.
+     * @default 'top-right'
+     */
+    position?: 'top-right' | 'top-left';
+    /**
+     * The mapping of environment modes to display labels.
+     * @default {}
+     */
+    envMap?: Record<string, string>;
+}
 
-export { type VitePluginLogOptions, vitePluginHtml, vitePluginLog };
+export { type EnvRibbonOptions, type LogOptions, vitePluginEnvRibbon, vitePluginHtml, vitePluginLog };

package/dist/index.mjs

@@ -0,0 +1,24 @@
+import{normalize as x,resolve as d}from"path";import{readFileSync as b}from"fs";import f from"dayjs";import $ from"dayjs/plugin/timezone.js";import O from"dayjs/plugin/utc.js";import{castArray as y}from"@lntvow/utils";f.extend(O);f.extend($);function j(n={}){let{name:e="LNTVOW_VERSION",timezone:t="Asia/Shanghai"}=n,{entries:r=["src/main.ts","src/main.js"]}=n,{version:i}=n;r=y(r).map(o=>d(process.cwd(),o));let p=f().tz(t).format("YYYY-MM-DD HH:mm:ss");if(!i)try{let o=b(d(process.cwd(),"package.json"),"utf8");i=JSON.parse(o).version}catch(o){i="unknown",console.log("error: ",o)}return{name:"vite-plugin-logs",transform(o,l){if(r.includes(x(l)))return{code:`
+          ${o}
+
+          localStorage.setItem('${e}', JSON.stringify(['${p}', '${i}']))
+          console.log('[Log] version: ', ['${p}', '${i}']);
+          `}}}}import{loadEnv as M}from"vite";function N(){let n={};return{name:"vite-plugin-html",enforce:"pre",config(e,{mode:t}){n=M(t,process.cwd())},transformIndexHtml(e){return Object.keys(n).forEach(t=>{let r=new RegExp(`%${t}%`,"g");e=e.replace(r,n[t])}),e}}}function J(n={}){let{width:e=150,height:t=20,fontSize:r=12,backgroundColor:i="hsla(0, 100%, 33%, 0.733)",color:p="#fff",position:o="top-right",envMap:l={}}=n,s;return{name:"vite-plugin-env-ribbon",transformIndexHtml(a){if(console.log("mode: ",s),s==="production")return a;let u=l[s]||s;if(!u)return a;let g=o==="top-left",v=g?`translate(-${t/Math.sqrt(2)}px, -${t/Math.sqrt(2)}px) translate(0, ${e/Math.sqrt(2)}px) rotate(-45deg)`:`translate(${t/Math.sqrt(2)}px, -${t/Math.sqrt(2)}px) translate(0, ${e/Math.sqrt(2)}px) rotate(45deg)`,h=`
+        position: fixed;
+        width: ${e}px;
+        height: ${t}px;
+        background: ${i};
+        color: ${p};
+        font-size: ${r}px;
+        line-height: ${t}px;
+        transform: ${v};
+        transform-origin: ${g?"left top":"right top"};
+        top: 0;
+        right: ${g?"auto":"0"};
+        left: ${g?"0":"auto"};
+        z-index: 9999;
+        text-align: center;
+        pointer-events: none;
+        user-select: none;
+        overflow: hidden;
+      `;return{html:a,tags:[{tag:"div",attrs:{style:h.replace(/\s+/g," ").trim(),class:"vite-plugin-env-ribbon","data-env-ribbon":s},children:u,injectTo:"body"}]}},configResolved(a){s=a.mode}}}export{J as vitePluginEnvRibbon,N as vitePluginHtml,j as vitePluginLog};

package/package.json

@@ -1,31 +1,58 @@
 {
   "name": "@lntvow/vite-plugin",
-  "version": "1.0.8",
+  "version": "1.1.1",
   "type": "module",
-  "description": "vite插件",
+  "description": "Collection of custom vite plugins",
+  "keywords": [
+    "vite-plugin"
+  ],
   "license": "MIT",
-  "author": "lntvow",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/lntvow/vite-plugin.git"
+  },
   "files": [
     "dist"
   ],
-  "main": "dist/index.cjs",
-  "module": "dist/index.js",
   "types": "dist/index.d.ts",
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "exports": {
+    "types": "./dist/index.d.ts",
+    "require": "./dist/index.cjs",
+    "import": "./dist/index.mjs"
+  },
   "dependencies": {
-    "@lntvow/utils": "^3.1.7",
-    "dayjs": "^1.11.11"
+    "@lntvow/utils": "^4.0.25",
+    "dayjs": "^1.11.13"
   },
   "devDependencies": {
-    "@lntvow/dev": "^2.1.1",
-    "tsup": "^8.1.0"
+    "@commitlint/cli": "^19.8.1",
+    "@commitlint/config-conventional": "^19.8.1",
+    "@lntvow/eslint-config": "^9.26.6",
+    "bumpp": "^10.2.0",
+    "commitizen": "^4.3.1",
+    "cz-conventional-changelog": "^3.3.0",
+    "eslint": "^9.29.0",
+    "lint-staged": "^16.1.2",
+    "npm-run-all": "^4.1.5",
+    "prettier": "^3.6.1",
+    "simple-git-hooks": "^2.13.0",
+    "tsup": "^8.5.0",
+    "typescript": "^5.8.3"
   },
   "peerDependencies": {
-    "vite": ">=4.0.0"
+    "vite": ">=5.0.0"
   },
   "scripts": {
-    "build": "tsup",
-    "commit": "git add . && git-cz && git push",
+    "postinstall": "simple-git-hooks",
     "rimraf": "rimraf ./node_modules/",
-    "release": "git add . && bumpp package.json --all --commit --no-tag --push"
+    "ncu": "ncu -u --reject @types/node && pnpm install",
+    "commit": "git add . && git-cz && pnpm release -y",
+    "release": "git add . && bumpp package.json --all --no-tag --no-print-commits",
+    "lint:eslint": "eslint \"src/**/*.{js,jsx,ts,tsx,vue}\" --fix",
+    "lint:tsc": "tsc --noEmit",
+    "lint": "run-p lint:eslint lint:tsc",
+    "build": "tsup"
   }
 }

package/dist/index.js

@@ -1,65 +0,0 @@
-// src/vite-plugin-logs.ts
-import path from "path";
-import fs from "fs";
-import dayjs from "dayjs";
-import utc from "dayjs/plugin/utc";
-import timezone from "dayjs/plugin/timezone";
-import { throwError } from "@lntvow/utils";
-dayjs.extend(utc);
-dayjs.extend(timezone);
-function vitePluginLog(options = {}) {
-  const { name = "LNTVOW_VERSION" } = options;
-  let { version } = options;
-  if (!version) {
-    try {
-      const packageJsonContent = fs.readFileSync(path.resolve(process.cwd(), "package.json"), "utf8");
-      version = JSON.parse(packageJsonContent).version;
-    } catch (e) {
-      throwError("vitePluginLogs", "package.json not found");
-    }
-  }
-  return {
-    name: "vite-plugin-logs",
-    transform(code, id) {
-      if (id.endsWith("src/main.ts") || id.endsWith("src/main.js")) {
-        const time = dayjs().tz("Asia/Shanghai").format("YYYY-MM-DD HH:mm:ss");
-        return {
-          code: `
-
-          import { log as vitePluginLogs } from '@lntvow/utils';
-
-          ${code}
-
-          localStorage.setItem('${name}', JSON.stringify(['${time}', '${version}']))
-          vitePluginLogs('version', '${time}', '${version}')
-
-          `
-        };
-      }
-    }
-  };
-}
-
-// src/vite-plugin-html.ts
-import { loadEnv } from "vite";
-function vitePluginHtml() {
-  let env = {};
-  return {
-    name: "vite-plugin-html",
-    enforce: "pre",
-    config(config, { mode }) {
-      env = loadEnv(mode, process.cwd());
-    },
-    transformIndexHtml(html) {
-      Object.keys(env).forEach((key) => {
-        const regex = new RegExp(`%${key}%`, "g");
-        html = html.replace(regex, env[key]);
-      });
-      return html;
-    }
-  };
-}
-export {
-  vitePluginHtml,
-  vitePluginLog
-};