@lntvow/vite-plugin 1.0.7 → 1.1.0

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 w=Object.create;var c=Object.defineProperty;var P=Object.getOwnPropertyDescriptor;var R=Object.getOwnPropertyNames;var S=Object.getPrototypeOf,z=Object.prototype.hasOwnProperty;var E=(o,n)=>{for(var t in n)c(o,t,{get:n[t],enumerable:!0})},v=(o,n,t,r)=>{if(n&&typeof n=="object"||typeof n=="function")for(let e of R(n))!z.call(o,e)&&e!==t&&c(o,e,{get:()=>n[e],enumerable:!(r=P(n,e))||r.enumerable});return o};var m=(o,n,t)=>(t=o!=null?w(S(o)):{},v(n||!o||!o.__esModule?c(t,"default",{value:o,enumerable:!0}):t,o)),q=o=>v(c({},"__esModule",{value:!0}),o);var H={};E(H,{vitePluginEnvRibbon:()=>k,vitePluginHtml:()=>j,vitePluginLog:()=>L});module.exports=q(H);var s=require("path"),h=require("fs"),l=m(require("dayjs"),1),x=m(require("dayjs/plugin/timezone.js"),1),$=m(require("dayjs/plugin/utc.js"),1);l.default.extend($.default);l.default.extend(x.default);function L(o={}){let{name:n="LNTVOW_VERSION"}=o,{version:t}=o;if(!t)try{let e=(0,h.readFileSync)((0,s.resolve)(process.cwd(),"package.json"),"utf8");t=JSON.parse(e).version}catch(e){t="version is missing",console.log("error: ",e)}let r=[(0,s.resolve)(process.cwd(),"src/main.ts"),(0,s.resolve)(process.cwd(),"src/main.js")];return{name:"vite-plugin-logs",transform(e,f){if(r.includes((0,s.normalize)(f))){let p=(0,l.default)().tz("Asia/Shanghai").format("YYYY-MM-DD HH:mm:ss");return{code:`
+          ${e}
 
-// src/index.ts
-var src_exports = {};
-__export(src_exports, {
-  vitePluginHtml: () => vitePluginHtml,
-  vitePluginLogs: () => vitePluginLogs
-});
-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 vitePluginLogs(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,
-  vitePluginLogs
-});
+          localStorage.setItem('${n}', JSON.stringify(['${p}', '${t}']))
+          console.log('[Log] version: ', ['${p}', '${t}']);
+          `}}}}}var b=require("vite");function j(){let o={};return{name:"vite-plugin-html",enforce:"pre",config(n,{mode:t}){o=(0,b.loadEnv)(t,process.cwd())},transformIndexHtml(n){return Object.keys(o).forEach(t=>{let r=new RegExp(`%${t}%`,"g");n=n.replace(r,o[t])}),n}}}function k(o={}){let{width:n=150,height:t=20,fontSize:r=12,backgroundColor:e="hsla(0, 100%, 33%, 0.733)",color:f="#fff",position:p="top-right",envMap:O={}}=o,i;return{name:"vite-plugin-env-ribbon",transformIndexHtml(a){if(console.log("mode: ",i),i==="production")return a;let d=O[i]||i;if(!d)return a;let g=p==="top-left",y=g?`translate(-${t/Math.sqrt(2)}px, -${t/Math.sqrt(2)}px) translate(0, ${n/Math.sqrt(2)}px) rotate(-45deg)`:`translate(${t/Math.sqrt(2)}px, -${t/Math.sqrt(2)}px) translate(0, ${n/Math.sqrt(2)}px) rotate(45deg)`,M=`
+        position: fixed;
+        width: ${n}px;
+        height: ${t}px;
+        background: ${e};
+        color: ${f};
+        font-size: ${r}px;
+        line-height: ${t}px;
+        transform: ${y};
+        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:M.replace(/\s+/g," ").trim(),class:"vite-plugin-env-ribbon","data-env-ribbon":i},children:d,injectTo:"body"}]}},configResolved(a){i=a.mode}}}0&&(module.exports={vitePluginEnvRibbon,vitePluginHtml,vitePluginLog});

package/dist/index.d.cts

@@ -1,19 +1,78 @@
-import { Plugin } from 'vite';
+import { PluginOption } from 'vite';
 
-declare function vitePluginLogs(options?: VitePluginLogsOptions): Plugin;
-interface VitePluginLogsOptions {
+declare function vitePluginLog(options?: LogOptions): PluginOption;
+interface LogOptions {
     /**
-     * @description localStorage key
-     * @default LNTVOW_VERSION
+     * localStorage key
+     * @default 'LNTVOW_VERSION'
      */
     name?: string;
     /**
-     * @description 版本号
+     * 版本号
      * @default 默认读取package.json的version
      */
     version?: string;
 }
 
-declare function vitePluginHtml(): Plugin;
+declare function vitePluginHtml(): PluginOption;
 
-export { type VitePluginLogsOptions, vitePluginHtml, vitePluginLogs };
+/**
+ * This Vite plugin injects a diagonal environment ribbon into the built HTML page.
+ * The ribbon displays the current environment (such as development, uat, pre, etc.)
+ * 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 EnvRibbonOptions, type LogOptions, vitePluginEnvRibbon, vitePluginHtml, vitePluginLog };

package/dist/index.d.ts

@@ -1,19 +1,78 @@
-import { Plugin } from 'vite';
+import { PluginOption } from 'vite';
 
-declare function vitePluginLogs(options?: VitePluginLogsOptions): Plugin;
-interface VitePluginLogsOptions {
+declare function vitePluginLog(options?: LogOptions): PluginOption;
+interface LogOptions {
     /**
-     * @description localStorage key
-     * @default LNTVOW_VERSION
+     * localStorage key
+     * @default 'LNTVOW_VERSION'
      */
     name?: string;
     /**
-     * @description 版本号
+     * 版本号
      * @default 默认读取package.json的version
      */
     version?: string;
 }
 
-declare function vitePluginHtml(): Plugin;
+declare function vitePluginHtml(): PluginOption;
 
-export { type VitePluginLogsOptions, vitePluginHtml, vitePluginLogs };
+/**
+ * This Vite plugin injects a diagonal environment ribbon into the built HTML page.
+ * The ribbon displays the current environment (such as development, uat, pre, etc.)
+ * 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 EnvRibbonOptions, type LogOptions, vitePluginEnvRibbon, vitePluginHtml, vitePluginLog };

package/dist/index.mjs

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

package/package.json

@@ -1,31 +1,57 @@
 {
   "name": "@lntvow/vite-plugin",
-  "version": "1.0.7",
+  "version": "1.1.0",
   "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"
+    "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 vitePluginLogs(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,
-  vitePluginLogs
-};