@pawover/kit 0.8.1 → 0.9.0-alpha.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -0
- package/package.json +12 -4
package/README.md
CHANGED
|
@@ -3,11 +3,14 @@
|
|
|
3
3
|
[](https://www.npmjs.com/package/@pawover/kit)
|
|
4
4
|
[](https://nodejs.org)
|
|
5
5
|
[](LICENSE)
|
|
6
|
+
[](https://pawover.github.io/pawover-kit/)
|
|
6
7
|
|
|
7
8
|
> 一个基于 TypeScript 的开源工具包合集：类型工具、静态工具类、React / Alova Hooks、ESLint 规则集与 Zod Schema，开箱即用、类型完备。
|
|
8
9
|
|
|
9
10
|
pawover-kit 是一个 pnpm 单体仓库（monorepo），由 5 个独立可发布的子包组成。根包 `@pawover/kit` 聚合重新导出所有子包，也可以按需单独安装使用。
|
|
10
11
|
|
|
12
|
+
> 📚 **技术文档**：[https://pawover.github.io/pawover-kit/](https://pawover.github.io/pawover-kit/) —— 完整的 API 参考、指南与实战示例见文档站；本文档只保留最简介绍。
|
|
13
|
+
|
|
11
14
|
## 特性
|
|
12
15
|
|
|
13
16
|
- **纯类型工具** `@pawover/kit-types`：无运行时代码，提供 `AnyObject`、`TreeLike`、`AnyFunction` 族、`AdvancedRecord`、`ApiNameCheck` 等常用类型
|
|
@@ -105,6 +108,8 @@ pnpm install
|
|
|
105
108
|
| `pnpm test:ci` | 完整 CI 流程：类型检查 → 测试 → 构建 → 冒烟 → pack 检查 |
|
|
106
109
|
| `pnpm build` | turbo 构建全部子包（tsdown 生成 ESM/CJS 双格式与类型声明） |
|
|
107
110
|
| `pnpm check` | 并行运行 types / eslint / format 检查 |
|
|
111
|
+
| `pnpm docs:dev` | 本地预览文档站（VitePress，源码见 `docs/`） |
|
|
112
|
+
| `pnpm docs:gen` | 从源码 JSDoc 重新生成 API 参考页（改源码注释后需重新生成） |
|
|
108
113
|
|
|
109
114
|
## 发布
|
|
110
115
|
|
package/package.json
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
"url": "https://github.com/pawover"
|
|
7
7
|
},
|
|
8
8
|
"description": "一个基于 TypeScript 的开发工具包",
|
|
9
|
-
"version": "0.
|
|
9
|
+
"version": "0.9.0-alpha.0",
|
|
10
10
|
"type": "module",
|
|
11
11
|
"engines": {
|
|
12
12
|
"node": ">=22.20.0"
|
|
@@ -158,10 +158,10 @@
|
|
|
158
158
|
"./metadata.json": "./entry/metadata.json"
|
|
159
159
|
},
|
|
160
160
|
"dependencies": {
|
|
161
|
-
"@pawover/kit-eslint-rules": "0.0.0",
|
|
162
161
|
"@pawover/kit-types": "0.0.0",
|
|
163
|
-
"@pawover/kit-hooks": "0.0.0",
|
|
164
|
-
"@pawover/kit-utils": "0.0.0",
|
|
162
|
+
"@pawover/kit-hooks": "0.0.1-alpha.0",
|
|
163
|
+
"@pawover/kit-utils": "0.1.0-alpha.0",
|
|
164
|
+
"@pawover/kit-eslint-rules": "0.0.0",
|
|
165
165
|
"@pawover/kit-zod": "0.0.0"
|
|
166
166
|
},
|
|
167
167
|
"devDependencies": {
|
|
@@ -170,6 +170,7 @@
|
|
|
170
170
|
"@commitlint/cli": "^21.2.1",
|
|
171
171
|
"@commitlint/config-conventional": "^21.2.0",
|
|
172
172
|
"@eslint-react/eslint-plugin": "^5.18.3",
|
|
173
|
+
"@fontsource/ibm-plex-mono": "^5.3.0",
|
|
173
174
|
"@playwright/test": "^1.62.1",
|
|
174
175
|
"@stylistic/eslint-plugin": "^6.0.0-beta.5",
|
|
175
176
|
"@testing-library/react": "^16.3.2",
|
|
@@ -197,8 +198,11 @@
|
|
|
197
198
|
"rimraf": "^6.1.3",
|
|
198
199
|
"tsdown": "^0.22.14",
|
|
199
200
|
"turbo": "^2.10.9",
|
|
201
|
+
"typedoc": "^0.28.20",
|
|
202
|
+
"typedoc-plugin-markdown": "^4.12.0",
|
|
200
203
|
"typescript": "^6.0.3",
|
|
201
204
|
"typescript-eslint": "^8.67.0",
|
|
205
|
+
"vitepress": "^1.6.4",
|
|
202
206
|
"vitest": "^4.1.10"
|
|
203
207
|
},
|
|
204
208
|
"peerDependencies": {
|
|
@@ -257,6 +261,10 @@
|
|
|
257
261
|
"ci:publish": "pnpm build && pnpm changeset publish",
|
|
258
262
|
"pre:enter-alpha": "pnpm changeset pre enter alpha",
|
|
259
263
|
"pre:exit": "pnpm changeset pre exit",
|
|
264
|
+
"docs:dev": "vitepress dev docs",
|
|
265
|
+
"docs:build": "vitepress build docs",
|
|
266
|
+
"docs:preview": "vitepress preview docs",
|
|
267
|
+
"docs:gen": "node scripts/generate-docs.mjs",
|
|
260
268
|
"check": "pnpm check:types & pnpm check:eslint & pnpm check:format",
|
|
261
269
|
"check:types": "tsc --noEmit",
|
|
262
270
|
"check:eslint": "eslint --fix \"**/*.{js,cjs,mjs,ts,cts,mts,jsx,tsx,vue}\" --cache-location=.cache/eslint.cache.json --cache",
|