vite-plugin-jdists 1.0.3 → 1.0.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026  Game
+
+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,6 +1,7 @@
 # vite-plugin-jdists
 
 ## Introduction
+
 [![NPM version](https://img.shields.io/npm/v/vite-plugin-jdists.svg?style=flat-square)](https://npmjs.com/package/vite-plugin-jdists)
 
 A vite plugin for [jdists](https://github.com/zswang/jdists).
@@ -11,22 +12,61 @@ A vite plugin for [jdists](https://github.com/zswang/jdists).
 
 ``` javascript
 
-// 案例1：只在开发环境起作用的代码， 在生产环境会被自动删除
+viteJdistsPlugin({
+    include?: ['**/*.tsx', '**/*.ts'],
+    exclude?: ['node_modules/**', 'dist/**'],
+    /**
+     * dev 模式时删除 /* <prod> */ ${代码} /* </prod> */
+     * prod 模式时删除 /* <dev> */ ${代码} /* </dev> */
+    */
+    remove: process.env.NODE_ENV === 'development' ? ['prod'] : ['dev'],
+    trigger?: ['release']
+}) as PluginOption
+
+```
+
+INPUT:
+
+### 场景1：只在开发环境起作用的代码， 在生产环境会被自动删除
+
+``` javascript
+/* <dev> */
+    let password = '123456';
+    console.log('dev');
+/* </dev> */
+
+/* <prod> */
+    let password = '777777';
+    console.log('prod');
+/* </prod> */
+
+```
+
+OUTPUT:
+
+``` javascript
+// process.env.NODE_ENV === 'development'
 
 /* <dev> */
     let password = '123456';
     console.log('dev');
 /* </dev> */
 
-// 只在生产环境起作用的代码， 在开发环境会被自动删除
+```
+
+``` javascript
+// process.env.NODE_ENV === 'production'
 
 /* <prod> */
     let password = '777777';
     console.log('prod');
 /* </prod> */
 
+```
+
+### 场景2：开发环境运行时使用的代码
 
-// 案例1：开发环境运行时使用的代码
+``` javascript
 
 let password = '123456';
 
@@ -37,8 +77,26 @@ let password = '123456';
 
 ```
 
-这样做比判断process.env.NODE_ENV更方便，也更安全。build时，jdists会自动删除所有`<dev>`代码，只保留一份代码在运行时不会暴露任何给用户。
+OUTPUT:
+
+``` javascript
+// process.env.NODE_ENV === 'development'
+
+let password = '123456';
 
+/* <dev> */
+    let password = '777777';
+    console.log('prod');
+/* </dev> */
+```
+
+``` javascript
+// process.env.NODE_ENV === 'production'
+let password = '123456';
+
+```
+
+ 这样做比判断process.env.NODE_ENV更方便，也更安全。build时jdists会自动删除所有`<dev>`代码，只保留一份代码在运行时不会暴露任何给用户。
 
 ## Install
 
@@ -46,8 +104,14 @@ let password = '123456';
 
 npm i -D vite-plugin-jdists
 
+```
+
 ## Usage
-```js vite.config.js
+
+```javascript
+
+// vite.config.js
+
 import { defineConfig, type PluginOption } from 'vite';
 
 import viteJdistsPlugin from 'vite-plugin-jdists'
@@ -58,7 +122,7 @@ export default defineConfig({
         viteJdistsPlugin({
             include: ['**/*.tsx', '**/*.ts'], // 修正路径模式
             exclude: ['node_modules/**', 'dist/**'],
-            remove: ['prod'],
+            remove: process.env.NODE_ENV === 'development' ? ['prod'] : ['dev'],
             trigger: ['release']
         }) as PluginOption
     ]

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "vite-plugin-jdists",
-    "version": "1.0.3",
+    "version": "1.0.4",
     "description": "vite plugin jdists",
     "author": "neverland",
     "repository": "",
@@ -8,7 +8,8 @@
     "main": "dist/index.cjs.js",
     "scripts": {
         "build": "vite build",
-        "dev": "vite build --watch"
+        "dev": "vite build --watch",
+        "test": "echo \"Error: no test specified\" && exit 0"
     },
     "dependencies": {
         "@rollup/pluginutils": "^5.3.0",
@@ -21,6 +22,3 @@
     },
     "homepage": "https://github.com/sbramimond/vite-plugin-jdists#readme"
 }
-
-
-