feat: 更新 package.json 和 README.md，添加 ECMAScript 语法检查功能，支持 Vite、Webpack 和 Rspack 构建工具，更新依赖项版本。

cklwblove · cklwblove · commit 3eda0e4c6e66 · 2025-07-16T15:10:09.000+08:00
diff --git a/README.md b/README.md
@@ -1,54 +1,125 @@
-# winjs-plugin-example
+# @winner-fed/plugin-check-syntax
 
-Example plugin for WinJS.
+WinJS plugin for checking ECMAScript syntax compatibility using `@winner-fed/unplugin-check-syntax`.
 
 <p>
-  <a href="https://npmjs.com/package/winjs-plugin-example">
-   <img src="https://img.shields.io/npm/v/winjs-plugin-example?style=flat-square&colorA=564341&colorB=EDED91" alt="npm version" />
+  <a href="https://npmjs.com/package/@winner-fed/plugin-check-syntax">
+   <img src="https://img.shields.io/npm/v/@winner-fed/plugin-check-syntax?style=flat-square&colorA=564341&colorB=EDED91" alt="npm version" />
   </a>
   <img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="license" />
-  <a href="https://npmcharts.com/compare/winjs-plugin-example?minimal=true"><img src="https://img.shields.io/npm/dm/winjs-plugin-example.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="downloads" /></a>
+  <a href="https://npmcharts.com/compare/@winner-fed/plugin-check-syntax?minimal=true"><img src="https://img.shields.io/npm/dm/@winner-fed/plugin-check-syntax.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="downloads" /></a>
 </p>
 
-## Usage
+## 功能特性
 
-Install:
+- 🔍 检查 ECMAScript 语法兼容性
+- 🎯 支持自定义目标浏览器范围
+- 📦 支持 Vite、Webpack、Rspack 构建工具
+- ⚙️ 灵活的配置选项
+- 🚫 支持排除特定文件
+
+## 安装
 
 ```bash
-npm add winjs-plugin-example -D
+npm add @winner-fed/plugin-check-syntax -D
 ```
 
-Add plugin to your `.winrc.ts`:
+## 使用方法
+
+在 `.winrc.ts` 配置文件中添加插件：
 
 ```ts
 // .winrc.ts
 export default {
-  plugins: ['winjs-plugin-example'],
-  // 开启配置
-  example: {}
+  plugins: ['@winner-fed/plugin-check-syntax'],
+  // 启用语法检查
+  checkSyntax: {
+    // 目标浏览器范围
+    targets: ['> 1%', 'last 2 versions'],
+    
+    // 排除文件
+    exclude: ['node_modules', '\\.min\\.js$'],
+    
+    // ECMAScript 版本
+    ecmaVersion: 2018
+  }
 };
 ```
 
-## Options
+## 配置选项
+
+### targets
+
+指定项目的目标浏览器范围，值为标准的 browserslist 数组。
+
+- 类型: `string[]`
+- 默认值: `undefined`
+- 示例:
+
+```js
+export default {
+  plugins: ['@winner-fed/plugin-check-syntax'],
+  checkSyntax: {
+    targets: ['> 1%', 'last 2 versions', 'not ie <= 8']
+  }
+};
+```
+
+### exclude
+
+用于在检测期间排除部分源文件。可以传入一个或多个正则表达式来匹配源文件的路径。
+
+- 类型: `string | string[]`
+- 默认值: `undefined`
+- 示例:
 
-### foo
+```js
+export default {
+  plugins: ['@winner-fed/plugin-check-syntax'],
+  checkSyntax: {
+    exclude: [
+      'node_modules',
+      '\\.min\\.js$',
+      'vendor/'
+    ]
+  }
+};
+```
+
+### ecmaVersion
 
-Some description.
+指定构建产物中可以使用的最低 ECMAScript 语法版本。`ecmaVersion` 的优先级高于 `targets`。
 
-- Type: `string`
-- Default: `undefined`
-- Example:
+- 类型: `3 | 5 | 6 | 2015 | 2016 | 2017 | 2018 | 2019 | 2020 | 2021 | 2022 | 'latest'`
+- 默认值: `undefined`
+- 示例:
 
 ```js
 export default {
-  plugins: ['winjs-plugin-example'],
-  // 开启配置
-  example: {
-    foo: 'bar'
+  plugins: ['@winner-fed/plugin-check-syntax'],
+  checkSyntax: {
+    ecmaVersion: 2018
   }
 };
 ```
 
+## 简单配置
+
+如果你只想启用默认的语法检查，可以直接设置为 `true`：
+
+```ts
+export default {
+  plugins: ['@winner-fed/plugin-check-syntax'],
+  checkSyntax: true
+};
+```
+
+## 支持的构建工具
+
+- ✅ Vite
+- ✅ Webpack
+- ✅ Rspack
+
 ## License
 
 [MIT](./LICENSE).
diff --git a/package.json b/package.json
@@ -1,7 +1,8 @@
 {
-  "name": "winjs-plugin-example",
+  "name": "@winner-fed/plugin-check-syntax",
   "version": "0.0.0",
-  "repository": "https://github.com/winjs-dev/winjs-plugin-template",
+  "description": "WinJS plugin for checking ECMAScript syntax compatibility",
+  "repository": "https://github.com/winjs-dev/winjs-plugin-check-syntax",
   "license": "MIT",
   "type": "module",
   "exports": {
@@ -30,18 +31,21 @@
   "devDependencies": {
     "@biomejs/biome": "^1.9.4",
     "@playwright/test": "^1.49.0",
-    "@winner-fed/winjs": "^0.11.21",
-    "@winner-fed/utils": "^0.11.21",
+    "@winner-fed/winjs": "^0.15.0",
+    "@winner-fed/utils": "^0.15.0",
     "@rslib/core": "^0.1.1",
     "@types/node": "^22.10.1",
     "playwright": "^1.49.0",
     "simple-git-hooks": "^2.11.1",
     "typescript": "^5.7.2"
   },
+  "dependencies": {
+    "@winner-fed/unplugin-check-syntax": "^1.0.0"
+  },
   "peerDependencies": {
     "@rsbuild/core": "1.x",
-    "@winner-fed/winjs": "^0.11.21",
-    "@winner-fed/utils": "^0.11.21"
+    "@winner-fed/winjs": "^0.15.0",
+    "@winner-fed/utils": "^0.15.0"
   },
   "peerDependenciesMeta": {
     "@rsbuild/core": {
diff --git a/playground/.winrc.ts b/playground/.winrc.ts
@@ -1,8 +1,15 @@
 import { defineConfig } from 'win';
 
 export default defineConfig({
-  plugins: ['../src'],
-  example: {
-    foo: 'bar',
+  plugins: ['@winner-fed/plugin-check-syntax'], // 使用相对路径引用本地开发的插件
+  targets: { chrome: 60, ie: 11 },
+  jsMinifier: 'terser',
+  // 测试 checkSyntax 默认值逻辑
+  // checkSyntax: true,
+  // checkSyntax: {},
+  // 也可以测试对象配置
+  checkSyntax: {
+    ecmaVersion: 5, // 只配置 ecmaVersion，targets 应该使用默认值
   },
+  rsbuild: {},
 });
diff --git a/playground/package.json b/playground/package.json
@@ -14,6 +14,7 @@
     "@winner-fed/winjs": "*"
   },
   "devDependencies": {
-    "typescript": "^5.0.3"
+    "typescript": "^5.0.3",
+    "@winner-fed/plugin-check-syntax": "workspace:*"
   }
 }
diff --git a/playground/plugin.ts b/playground/plugin.ts
@@ -4,4 +4,14 @@ export default (api: IApi) => {
   api.modifyHTML(($) => {
     return $;
   });
+
+  api.addHTMLHeadScripts(
+    () => `
+  // 可选链和空值合并 (ES2020)
+    const config = {
+      theme: 'dark'
+    };
+    const selectedTheme = config?.theme ?? 'light';
+    `,
+  );
 };
diff --git a/playground/src/app.ts b/playground/src/app.ts
@@ -0,0 +1,74 @@
+// 使用 ES2015+ 语法来演示语法检查功能
+
+// 箭头函数 (ES2015)
+const greet = (name: string) => `Hello, ${name}!`;
+
+// 模板字符串 (ES2015)
+const message = `Welcome to syntax checking demo!`;
+
+// const/let (ES2015)
+const numbers = [1, 2, 3, 4, 5];
+
+// 解构赋值 (ES2015)
+const [first, ...rest] = numbers;
+
+// 展开运算符 (ES2015)
+const moreNumbers = [...numbers, 6, 7, 8];
+
+// 默认参数 (ES2015)
+function add(a: number, b = 0) {
+  return a + b;
+}
+
+// async/await (ES2017)
+async function fetchData() {
+  try {
+    const response = await fetch('/api/data');
+    return await response.json();
+  } catch (error) {
+    console.error('Error fetching data:', error);
+  }
+}
+
+// 可选链 (ES2020)
+const user = {
+  profile: {
+    name: 'John',
+  },
+};
+const userName = user?.profile?.name;
+
+// 空值合并 (ES2020)
+const defaultName = userName ?? 'Anonymous';
+
+// 类 (ES2015)
+class Calculator {
+  private result = 0;
+
+  // 私有字段 (ES2022)
+  #history: number[] = [];
+
+  add(value: number) {
+    this.result += value;
+    this.#history.push(this.result);
+    return this;
+  }
+
+  getResult() {
+    return this.result;
+  }
+}
+
+// 使用示例
+const calc = new Calculator();
+calc.add(5).add(3);
+
+console.log(greet('World'));
+console.log(message);
+console.log('First number:', first);
+console.log('Calculator result:', calc.getResult());
+console.log('User name:', defaultName);
+
+// 导出一些内容
+export { greet, Calculator };
+export default message;
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/index.ts b/src/index.ts

Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@`
`14`	`14`	`"@winner-fed/winjs": "*"`
`15`	`15`	`},`
`16`	`16`	`"devDependencies": {`
`17`		`- "typescript": "^5.0.3"`
	`17`	`+ "typescript": "^5.0.3",`
	`18`	`+ "@winner-fed/plugin-check-syntax": "workspace:*"`
`18`	`19`	`}`
`19`	`20`	`}`