@lntvow/vite-plugin 1.1.11 → 1.1.13

package/dist/index.d.ts

@@ -6,7 +6,9 @@ import { Arrayable } from '@lntvow/utils';
  * 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.
+ * This is useful for tracking deployment versions and build times in frontend projects,
+ * making it easier to identify which version is currently deployed and when it was built.
+ *
  *
  * You can customize the localStorage key, version, timezone, and the entry files to inject via plugin options.
  *
@@ -18,27 +20,38 @@ import { Arrayable } from '@lntvow/utils';
  *     vitePluginVersionLog(),
  *   ],
  * }
+ *
+ * @remarks
+ * - Automatically reads version from package.json if not provided
+ * - Supports custom timezone for build time formatting
+ * - Configurable localStorage key name
+ * - Supports multiple entry files
  */
 declare function vitePluginVersionLog(options?: VersionLogOptions): PluginOption;
 interface VersionLogOptions {
     /**
-     * The key used for localStorage.
+     * The key used for localStorage to store version information.
+     * The stored value will be a JSON array: [buildTime, version]
      * @default 'LNTVOW_VERSION'
      */
     name?: string;
     /**
-     * Project version.
+     * Project version string.
+     * If not provided, the plugin will automatically read the version from package.json.
+     * If package.json is not found or doesn't contain a version, 'unknown' will be used.
      * @default Reads the version from package.json by default.
      */
     version?: string;
     /**
-     * Timezone setting.
+     * Timezone setting for formatting the build time.
+     * Supports all timezone identifiers (e.g., 'UTC', 'America/New_York', 'Europe/London').
      * @default 'Asia/Shanghai'
      */
     timezone?: string;
     /**
-     * The entry files to log.
-     * The path is resolved from the command line working directory (process.cwd()).
+     * The entry files where version information will be injected.
+     * Can be a single file path string or an array of file paths.
+     * Paths are resolved from the command line working directory (process.cwd()).
      * @default ['src/main.ts', 'src/main.js']
      */
     entries?: Arrayable<string>;
@@ -46,12 +59,14 @@ interface VersionLogOptions {
 
 /**
  * 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 displays the current environment (such as development, 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'.
+ * This is useful for quickly identifying the current environment during development
+ * and testing phases, helping prevent confusion between different deployment stages.
  *
- * You can customize the ribbon's width, height, font size, background color, text color, position, and environment label mapping via plugin options.
+ * The ribbon will NOT be injected when the current mode is 'production'.
  *
  * @example
  * import { vitePluginEnvRibbon } from '@lntvow/vite-plugin'
@@ -61,41 +76,56 @@ interface VersionLogOptions {
  *     vitePluginEnvRibbon(),
  *   ],
  * }
+ *
+ * @remarks
+ * - Automatically displays current environment mode
+ * - Customizable appearance (size, colors, position)
+ * - Environment label mapping support
+ * - Non-intrusive design (no pointer events)
+ * - Production-safe (automatically disabled)
  */
 declare function vitePluginEnvRibbon(options?: EnvRibbonOptions): PluginOption;
 interface EnvRibbonOptions {
     /**
-     * The height of the banner.
-     * @default 20
-     */
-    height?: number;
-    /**
-     * The width of the banner.
+     * The width of the ribbon.
      * @default 150
      */
     width?: number;
     /**
-     * The font size of the banner text.
+     * The height of the ribbon.
+     * @default 20
+     */
+    height?: number;
+    /**
+     * The font size of the ribbon text.
      * @default 12
      */
     fontSize?: number;
     /**
-     * The background color of the banner.
+     * The background color of the ribbon.
+     * Supports any valid CSS color value (hex, rgba, hsla, etc.).
      * @default 'hsla(0, 100%, 33%, 0.733)'
      */
     backgroundColor?: string;
     /**
-     * The text color of the banner.
+     * The text color of the ribbon.
+     * Supports any valid CSS color value.
      * @default '#fff'
      */
     color?: string;
     /**
-     * The position of the banner on the screen.
+     * The position of the ribbon on the screen.
      * @default 'top-right'
      */
     position?: 'top-right' | 'top-left';
     /**
      * The mapping of environment modes to display labels.
+     * The key is the Vite mode (e.g., 'development', 'staging', 'uat', 'pre'),
+     * and the value is the custom label to display on the ribbon.
+     *
+     * Used to customize the text shown for different environments.
+     * If a mode is not found in this mapping, the original mode name will be displayed.
+     *
      * @default {}
      */
     envMap?: Record<string, string>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lntvow/vite-plugin",
-  "version": "1.1.11",
+  "version": "1.1.13",
   "type": "module",
   "description": "Collection of custom vite plugins",
   "keywords": [
@@ -23,13 +23,13 @@
     "import": "./dist/index.mjs"
   },
   "dependencies": {
-    "@lntvow/utils": "^4.3.1",
+    "@lntvow/utils": "^4.3.4",
     "dayjs": "^1.11.13"
   },
   "devDependencies": {
     "@commitlint/cli": "^19.8.1",
     "@commitlint/config-conventional": "^19.8.1",
-    "@lntvow/eslint-config": "^9.29.0",
+    "@lntvow/eslint-config": "^9.29.1",
     "bumpp": "^10.2.0",
     "commitizen": "^4.3.1",
     "cz-conventional-changelog": "^3.3.0",