@luxkit/cli 1.1.42 → 1.1.44
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/CHANGELOG.md +9 -0
- package/README.md +245 -2
- package/package.json +2 -2
- package/README_ZH.md +0 -242
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,14 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 1.1.44
|
|
4
|
+
|
|
5
|
+
- Merged English and Chinese README into a single file with in-page anchor switching
|
|
6
|
+
- Removed standalone `README_ZH.md` — no longer need to maintain two separate documents
|
|
7
|
+
|
|
8
|
+
## 1.1.43
|
|
9
|
+
|
|
10
|
+
- Fixed language switcher links in README pointing to npm 404 — now uses GitHub absolute URLs
|
|
11
|
+
|
|
3
12
|
## 1.1.42
|
|
4
13
|
|
|
5
14
|
- Added `CHANGELOG.md` to published npm package
|
package/README.md
CHANGED
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
[](https://www.typescriptlang.org/)
|
|
11
11
|
[](https://nodejs.org/api/esm.html)
|
|
12
12
|
|
|
13
|
-
**English** | [中文](
|
|
13
|
+
**English** | [中文](#中文)
|
|
14
14
|
|
|
15
15
|
</div>
|
|
16
16
|
|
|
@@ -237,6 +237,249 @@ Bug reports, feature suggestions, and code contributions are welcome!
|
|
|
237
237
|
|
|
238
238
|
[ISC](https://opensource.org/licenses/ISC) — Free to use, modify, and distribute.
|
|
239
239
|
|
|
240
|
+
<p align="right"><a href="#中文">切换到中文 →</a></p>
|
|
241
|
+
|
|
242
|
+
---
|
|
243
|
+
|
|
244
|
+
<br />
|
|
245
|
+
|
|
246
|
+
## 中文
|
|
247
|
+
|
|
248
|
+
<div align="center">
|
|
249
|
+
|
|
250
|
+
**一键项目格式化 & VSCode 配置 CLI**
|
|
251
|
+
|
|
252
|
+
[](https://www.npmjs.com/package/@luxkit/cli)
|
|
253
|
+
[](https://nodejs.org/)
|
|
254
|
+
[](https://opensource.org/licenses/ISC)
|
|
255
|
+
[](https://www.typescriptlang.org/)
|
|
256
|
+
[](https://nodejs.org/api/esm.html)
|
|
257
|
+
|
|
258
|
+
[English](#lux) | **中文**
|
|
259
|
+
|
|
260
|
+
</div>
|
|
261
|
+
|
|
262
|
+
---
|
|
263
|
+
|
|
264
|
+
### 📌 为什么选择 lux？
|
|
265
|
+
|
|
266
|
+
`lux` 是一款专为现代化开发与 **AI 时代** 打造的工程化配置 CLI 工具，一条命令完成项目代码规范配置。
|
|
267
|
+
|
|
268
|
+
- 🚀 **一键配置**：ESLint、Prettier、CSpell、Stylelint、EditorConfig 及 VSCode 工作区配置，一条命令搞定。
|
|
269
|
+
- 🤖 **AI Agent 拍档**：为 Claude、Opencode 等提供技能（Skill）支持，可直接用自然语言（如*"/lux 帮我配一套适合团队的 react 代码规范"*）让 AI 自动构建和调整预设。
|
|
270
|
+
- 📦 **框架预设开箱即用**：内置 `web-vue`、`web-react`、`node` 等场景预设。
|
|
271
|
+
- 🎨 **高度可定制**：支持提取和微调内置预设，也支持**完全自定义私有预设**，兼顾开箱即用与团队定制化需求。
|
|
272
|
+
- 🧠 **安全接入已有项目**：智能冲突解决与合并机制，自动检测 `bun`、`pnpm`、`npm`、`yarn` 依赖树。
|
|
273
|
+
|
|
274
|
+
<div align="center">
|
|
275
|
+
<img src="https://github.com/TTT1231/lux/blob/main/demo.gif?raw=true" alt="lux 演示" width="640" />
|
|
276
|
+
</div>
|
|
277
|
+
|
|
278
|
+
## ⚡快速开始
|
|
279
|
+
|
|
280
|
+
```bash
|
|
281
|
+
# 全局安装（选择你的包管理器）
|
|
282
|
+
npm install -g @luxkit/cli
|
|
283
|
+
|
|
284
|
+
# 初始化 skill 和 preset
|
|
285
|
+
lux init && lux init --preset
|
|
286
|
+
|
|
287
|
+
# 初始化你的项目 — lux 需要项目中有 package.json 来注入依赖和脚本
|
|
288
|
+
# 可使用 pnpm create vite、claude 等方式创建项目
|
|
289
|
+
# lux 通过锁文件检测包管理器（bun.lock / package-lock.json / pnpm-lock.yaml）
|
|
290
|
+
# 也可使用 --no-install 跳过依赖安装
|
|
291
|
+
|
|
292
|
+
# Lint 配置
|
|
293
|
+
lux fmt web-vue # 配置 ESLint + Prettier
|
|
294
|
+
lux fmt web-vue --stylelint # + Stylelint
|
|
295
|
+
lux fmt web-vue --editorconfig # + EditorConfig
|
|
296
|
+
lux fmt web-vue --cspell # + CSpell
|
|
297
|
+
lux fmt web-vue --lint-staged # + lint-staged（自动启用 --husky）
|
|
298
|
+
lux fmt web-vue --husky # + 仅 husky（不包含 lint-staged）
|
|
299
|
+
|
|
300
|
+
# VSCode 配置（可选，全局已配置可跳过）
|
|
301
|
+
lux vscode web-vue # 生成 .vscode/settings.json + extensions.json
|
|
302
|
+
|
|
303
|
+
# 查看可用预设
|
|
304
|
+
lux fmt list
|
|
305
|
+
lux vscode list
|
|
306
|
+
|
|
307
|
+
# 下一步：
|
|
308
|
+
# 🎨 自定义内置fmt lint预设，例如web-vue（可选）
|
|
309
|
+
# 🧩 自定义你自己的预设，例如fmt <your-lint-preset-name>（可选）
|
|
310
|
+
```
|
|
311
|
+
|
|
312
|
+
<br />
|
|
313
|
+
|
|
314
|
+
## 🎨 自定义内置预设
|
|
315
|
+
|
|
316
|
+
> 前置条件：已完成 `lux init && lux init --preset`（见快速开始）
|
|
317
|
+
|
|
318
|
+
```bash
|
|
319
|
+
# 使用 AI Agent 自定义（推荐）
|
|
320
|
+
# 在 Claude 等 AI Agent 中直接执行：
|
|
321
|
+
/lux 配置内置预设 web-react 模板，符合我的开发项目风格
|
|
322
|
+
|
|
323
|
+
# 也可手动编辑 ~/.lux/preset/ 下的预设文件
|
|
324
|
+
# 例如给 web-react 添加 cspell 脚本：
|
|
325
|
+
# 在 ~/.lux/preset/fmt/web-react/package.json 的 scripts 中添加 "cspell":"cspell \"src/**/*\""
|
|
326
|
+
```
|
|
327
|
+
|
|
328
|
+
## 🧩 完全自定义预设
|
|
329
|
+
|
|
330
|
+
> 前置条件：已完成 `lux init && lux init --preset`（见快速开始）
|
|
331
|
+
|
|
332
|
+
```bash
|
|
333
|
+
# 使用 AI Agent 创建自定义预设（推荐）
|
|
334
|
+
# 在 Claude 等 AI Agent 中直接执行：
|
|
335
|
+
/lux 配置我的格式化模板 <your-custom-fmt-preset-name>，符合我的开发项目风格
|
|
336
|
+
|
|
337
|
+
# 验证预设是否注册成功
|
|
338
|
+
lux fmt list
|
|
339
|
+
```
|
|
340
|
+
|
|
341
|
+
## 📖命令参考
|
|
342
|
+
|
|
343
|
+
| 命令 | 说明 |
|
|
344
|
+
| :-------------------------- | :----------------------------------------------------------- |
|
|
345
|
+
| `lux fmt <preset>` | 生成 Lint 配置 |
|
|
346
|
+
| `lux fmt list` | 列出可用的 Lint 预设 |
|
|
347
|
+
| `lux vscode <preset>` | 生成 VSCode 配置（项目内） |
|
|
348
|
+
| `lux vscode list` | 列出可用的 VSCode 预设 |
|
|
349
|
+
| `lux init` | 初始化 Skill 文件到 AI Agent |
|
|
350
|
+
| `lux init --preset` | 初始化所有内置预设到 `~/.lux/preset/` |
|
|
351
|
+
| `lux set <key=value> [...]` | 设置代理环境变量（如 `https_proxy="http://127.0.0.1:7890"`） |
|
|
352
|
+
| `lux unset` | 清除所有代理配置 |
|
|
353
|
+
| `lux show env` | 显示已配置的代理环境变量 |
|
|
354
|
+
| `lux vpn cmd` | 复制 CMD 代理命令到剪贴板 |
|
|
355
|
+
| `lux vpn pw` | 复制 PowerShell 代理命令到剪贴板 |
|
|
356
|
+
| `lux vpn bash` | 复制 Bash 代理命令到剪贴板 |
|
|
357
|
+
| `lux update` | 更新 `@luxkit/cli` 到最新版本 |
|
|
358
|
+
| `lux update --check` | 检查可用更新，不执行安装 |
|
|
359
|
+
|
|
240
360
|
<br />
|
|
241
361
|
|
|
242
|
-
|
|
362
|
+
### ⚙️命令选项
|
|
363
|
+
|
|
364
|
+
```bash
|
|
365
|
+
lux fmt <preset> [options]
|
|
366
|
+
|
|
367
|
+
--force 覆盖已有文件和脚本
|
|
368
|
+
--no-install 写入依赖到 package.json 但跳过安装
|
|
369
|
+
--dry-run 预览模式，不写入任何文件
|
|
370
|
+
--stylelint 包含 Stylelint 配置（按需启用）
|
|
371
|
+
--editorconfig 包含 EditorConfig 配置（按需启用）
|
|
372
|
+
--husky 初始化 husky Git hooks（按需启用）
|
|
373
|
+
--lint-staged 配置 lint-staged（自动启用 --husky，按需启用）
|
|
374
|
+
--cspell 包含 CSpell 配置（按需启用）
|
|
375
|
+
--reset 重置本地预设，从内置默认值重新创建
|
|
376
|
+
|
|
377
|
+
lux vscode <preset> [options]
|
|
378
|
+
|
|
379
|
+
--force 覆盖已有的 VSCode 配置文件
|
|
380
|
+
--dry-run 预览模式，不写入任何文件
|
|
381
|
+
--stylelint 包含 Stylelint 设置和扩展（按需启用）
|
|
382
|
+
--reset 重置本地预设，从内置默认值重新创建
|
|
383
|
+
```
|
|
384
|
+
|
|
385
|
+
<br />
|
|
386
|
+
|
|
387
|
+
## 🔧工作原理
|
|
388
|
+
|
|
389
|
+
```
|
|
390
|
+
lux fmt <preset> [options]
|
|
391
|
+
│
|
|
392
|
+
▼
|
|
393
|
+
解析 CLI 参数，校验项目 package.json
|
|
394
|
+
│
|
|
395
|
+
▼
|
|
396
|
+
预设类型判断
|
|
397
|
+
│
|
|
398
|
+
├── 内置预设 ──► --reset？ ──► 重置本地副本
|
|
399
|
+
│ │
|
|
400
|
+
│ ├── 本地副本存在 (~/.lux/preset/)？ ──► 从本地副本应用
|
|
401
|
+
│ └── 不存在 ──► 从内置生成 ──► 保存到 ~/.lux/preset/ ──► 应用
|
|
402
|
+
│
|
|
403
|
+
├── 自定义预设 (~/.lux/preset/fmt/<name>/) ──► 直接从本地目录应用
|
|
404
|
+
│
|
|
405
|
+
└── 未找到 ──► 模糊匹配所有可用预设（内置 + 自定义）并报错
|
|
406
|
+
│
|
|
407
|
+
▼
|
|
408
|
+
--stylelint / --editorconfig / --cspell / --husky / --lint-staged 过滤（自定义预设无对应配置时 warning）
|
|
409
|
+
│
|
|
410
|
+
▼
|
|
411
|
+
遍历每个配置文件：
|
|
412
|
+
│
|
|
413
|
+
├── 文件不存在？ ──► 创建
|
|
414
|
+
├── 已存在 + --force？ ──► 覆盖
|
|
415
|
+
└── 已存在？ ──► 跳过
|
|
416
|
+
│
|
|
417
|
+
▼
|
|
418
|
+
注入脚本到 package.json（自动检测 bun / pnpm / npm / yarn）
|
|
419
|
+
│
|
|
420
|
+
▼
|
|
421
|
+
安装 devDependencies（检测 lockfile 判断包管理器）
|
|
422
|
+
```
|
|
423
|
+
|
|
424
|
+
<br />
|
|
425
|
+
|
|
426
|
+
## 🔄重置与卸载
|
|
427
|
+
|
|
428
|
+
### 重置预设
|
|
429
|
+
|
|
430
|
+
```bash
|
|
431
|
+
# 重置内置预设（删除本地副本并从内置模板重新生成）
|
|
432
|
+
lux fmt web-vue --reset
|
|
433
|
+
lux vscode web-vue --reset
|
|
434
|
+
|
|
435
|
+
# 重新初始化所有内置预设（覆盖已有本地副本）
|
|
436
|
+
lux init --preset
|
|
437
|
+
|
|
438
|
+
# 重置自定义预设：手动删除对应目录
|
|
439
|
+
# rm -rf ~/.lux/preset/fmt/<your-custom-preset-name>
|
|
440
|
+
```
|
|
441
|
+
|
|
442
|
+
> 自定义预设使用 `--reset` 会提示警告并中止，因为不存在内置源可供恢复。
|
|
443
|
+
|
|
444
|
+
### 卸载
|
|
445
|
+
|
|
446
|
+
```bash
|
|
447
|
+
# 卸载 CLI
|
|
448
|
+
npm uninstall -g @luxkit/cli
|
|
449
|
+
|
|
450
|
+
# 清理配置目录（可选）
|
|
451
|
+
# rm -rf ~/.lux
|
|
452
|
+
|
|
453
|
+
# 清理skill，claude/opencode
|
|
454
|
+
# rm -rf ~/.claude/skill/lux
|
|
455
|
+
# rm -rf ~/.opencode/skill/lux
|
|
456
|
+
```
|
|
457
|
+
|
|
458
|
+
## 🔍故障排查
|
|
459
|
+
|
|
460
|
+
| 问题 | 解决方案 |
|
|
461
|
+
| :---------------------- | :----------------------------------------------------------------------------------------------------------------- |
|
|
462
|
+
| `package.json` 相关错误 | 确保项目根目录存在合法的 `package.json` |
|
|
463
|
+
| 预设未找到 | 运行 `lux fmt list` 查看所有可用预设，lux 会自动模糊匹配建议 |
|
|
464
|
+
| 包管理器检测不正确 | 确保 lockfile 存在（`bun.lock` / `package-lock.json` / `pnpm-lock.yaml`） |
|
|
465
|
+
| 跳过依赖安装 | 使用 `--no-install` 仅写入 `package.json`，手动安装 |
|
|
466
|
+
| 预览操作结果 | 使用 `--dry-run` 查看将执行的所有操作 |
|
|
467
|
+
| flag 无效果 | 自定义预设需包含对应的配置文件和依赖，`--stylelint`/`--cspell`/`--editorconfig`/`--husky`/`--lint-staged` 才能生效 |
|
|
468
|
+
|
|
469
|
+
<br />
|
|
470
|
+
|
|
471
|
+
## 🤝 参与贡献
|
|
472
|
+
|
|
473
|
+
欢迎提交 Bug、功能建议或代码贡献！
|
|
474
|
+
|
|
475
|
+
- 🐛 **提交 Issue**：[GitHub Issues](https://github.com/TTT1231/lux/issues)
|
|
476
|
+
- 🛠 **提交 PR**：[GitHub Pull Requests](https://github.com/TTT1231/lux/pulls)
|
|
477
|
+
- ⭐️ **Star 支持**：如果 lux 对你有帮助，欢迎 [Star](https://github.com/TTT1231/lux)！
|
|
478
|
+
|
|
479
|
+
<br />
|
|
480
|
+
|
|
481
|
+
## 📄 许可证
|
|
482
|
+
|
|
483
|
+
[ISC](https://opensource.org/licenses/ISC) — 可自由使用、修改和分发。
|
|
484
|
+
|
|
485
|
+
<p align="right"><a href="#lux">← Switch to English</a></p>
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@luxkit/cli",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.44",
|
|
4
4
|
"description": "One-click project formatting & VSCode config CLI",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
},
|
|
9
9
|
"files": [
|
|
10
10
|
"dist",
|
|
11
|
-
"
|
|
11
|
+
"README.md",
|
|
12
12
|
"CHANGELOG.md"
|
|
13
13
|
],
|
|
14
14
|
"publishConfig": {
|
package/README_ZH.md
DELETED
|
@@ -1,242 +0,0 @@
|
|
|
1
|
-
<div align="center">
|
|
2
|
-
|
|
3
|
-
# lux
|
|
4
|
-
|
|
5
|
-
**一键项目格式化 & VSCode 配置 CLI**
|
|
6
|
-
|
|
7
|
-
[](https://www.npmjs.com/package/@luxkit/cli)
|
|
8
|
-
[](https://nodejs.org/)
|
|
9
|
-
[](https://opensource.org/licenses/ISC)
|
|
10
|
-
[](https://www.typescriptlang.org/)
|
|
11
|
-
[](https://nodejs.org/api/esm.html)
|
|
12
|
-
|
|
13
|
-
[English](./README.md) | **中文**
|
|
14
|
-
|
|
15
|
-
</div>
|
|
16
|
-
|
|
17
|
-
---
|
|
18
|
-
|
|
19
|
-
### 📌 为什么选择 lux？
|
|
20
|
-
|
|
21
|
-
`lux` 是一款专为现代化开发与 **AI 时代** 打造的工程化配置 CLI 工具，一条命令完成项目代码规范配置。
|
|
22
|
-
|
|
23
|
-
- 🚀 **一键配置**：ESLint、Prettier、CSpell、Stylelint、EditorConfig 及 VSCode 工作区配置，一条命令搞定。
|
|
24
|
-
- 🤖 **AI Agent 拍档**：为 Claude、Opencode 等提供技能（Skill）支持，可直接用自然语言（如*"/lux 帮我配一套适合团队的 react 代码规范"*）让 AI 自动构建和调整预设。
|
|
25
|
-
- 📦 **框架预设开箱即用**：内置 `web-vue`、`web-react`、`node` 等场景预设。
|
|
26
|
-
- 🎨 **高度可定制**：支持提取和微调内置预设，也支持**完全自定义私有预设**，兼顾开箱即用与团队定制化需求。
|
|
27
|
-
- 🧠 **安全接入已有项目**：智能冲突解决与合并机制，自动检测 `bun`、`pnpm`、`npm`、`yarn` 依赖树。
|
|
28
|
-
|
|
29
|
-
<div align="center">
|
|
30
|
-
<img src="https://github.com/TTT1231/lux/blob/main/demo.gif?raw=true" alt="lux 演示" width="640" />
|
|
31
|
-
</div>
|
|
32
|
-
|
|
33
|
-
## ⚡快速开始
|
|
34
|
-
|
|
35
|
-
```bash
|
|
36
|
-
# 全局安装（选择你的包管理器）
|
|
37
|
-
npm install -g @luxkit/cli
|
|
38
|
-
|
|
39
|
-
# 初始化 skill 和 preset
|
|
40
|
-
lux init && lux init --preset
|
|
41
|
-
|
|
42
|
-
# 初始化你的项目 — lux 需要项目中有 package.json 来注入依赖和脚本
|
|
43
|
-
# 可使用 pnpm create vite、claude 等方式创建项目
|
|
44
|
-
# lux 通过锁文件检测包管理器（bun.lock / package-lock.json / pnpm-lock.yaml）
|
|
45
|
-
# 也可使用 --no-install 跳过依赖安装
|
|
46
|
-
|
|
47
|
-
# Lint 配置
|
|
48
|
-
lux fmt web-vue # 配置 ESLint + Prettier
|
|
49
|
-
lux fmt web-vue --stylelint # + Stylelint
|
|
50
|
-
lux fmt web-vue --editorconfig # + EditorConfig
|
|
51
|
-
lux fmt web-vue --cspell # + CSpell
|
|
52
|
-
lux fmt web-vue --lint-staged # + lint-staged（自动启用 --husky）
|
|
53
|
-
lux fmt web-vue --husky # + 仅 husky（不包含 lint-staged）
|
|
54
|
-
|
|
55
|
-
# VSCode 配置（可选，全局已配置可跳过）
|
|
56
|
-
lux vscode web-vue # 生成 .vscode/settings.json + extensions.json
|
|
57
|
-
|
|
58
|
-
# 查看可用预设
|
|
59
|
-
lux fmt list
|
|
60
|
-
lux vscode list
|
|
61
|
-
|
|
62
|
-
# 下一步：
|
|
63
|
-
# 🎨 自定义内置fmt lint预设，例如web-vue（可选）
|
|
64
|
-
# 🧩 自定义你自己的预设，例如fmt <your-lint-preset-name>（可选）
|
|
65
|
-
```
|
|
66
|
-
|
|
67
|
-
<br />
|
|
68
|
-
|
|
69
|
-
## 🎨 自定义内置预设
|
|
70
|
-
|
|
71
|
-
> 前置条件：已完成 `lux init && lux init --preset`（见快速开始）
|
|
72
|
-
|
|
73
|
-
```bash
|
|
74
|
-
# 使用 AI Agent 自定义（推荐）
|
|
75
|
-
# 在 Claude 等 AI Agent 中直接执行：
|
|
76
|
-
/lux 配置内置预设 web-react 模板，符合我的开发项目风格
|
|
77
|
-
|
|
78
|
-
# 也可手动编辑 ~/.lux/preset/ 下的预设文件
|
|
79
|
-
# 例如给 web-react 添加 cspell 脚本：
|
|
80
|
-
# 在 ~/.lux/preset/fmt/web-react/package.json 的 scripts 中添加 "cspell":"cspell \"src/**/*\""
|
|
81
|
-
```
|
|
82
|
-
|
|
83
|
-
## 🧩 完全自定义预设
|
|
84
|
-
|
|
85
|
-
> 前置条件：已完成 `lux init && lux init --preset`（见快速开始）
|
|
86
|
-
|
|
87
|
-
```bash
|
|
88
|
-
# 使用 AI Agent 创建自定义预设（推荐）
|
|
89
|
-
# 在 Claude 等 AI Agent 中直接执行：
|
|
90
|
-
/lux 配置我的格式化模板 <your-custom-fmt-preset-name>，符合我的开发项目风格
|
|
91
|
-
|
|
92
|
-
# 验证预设是否注册成功
|
|
93
|
-
lux fmt list
|
|
94
|
-
```
|
|
95
|
-
|
|
96
|
-
## 📖命令参考
|
|
97
|
-
|
|
98
|
-
| 命令 | 说明 |
|
|
99
|
-
| :-------------------------- | :----------------------------------------------------------- |
|
|
100
|
-
| `lux fmt <preset>` | 生成 Lint 配置 |
|
|
101
|
-
| `lux fmt list` | 列出可用的 Lint 预设 |
|
|
102
|
-
| `lux vscode <preset>` | 生成 VSCode 配置（项目内） |
|
|
103
|
-
| `lux vscode list` | 列出可用的 VSCode 预设 |
|
|
104
|
-
| `lux init` | 初始化 Skill 文件到 AI Agent |
|
|
105
|
-
| `lux init --preset` | 初始化所有内置预设到 `~/.lux/preset/` |
|
|
106
|
-
| `lux set <key=value> [...]` | 设置代理环境变量（如 `https_proxy="http://127.0.0.1:7890"`） |
|
|
107
|
-
| `lux unset` | 清除所有代理配置 |
|
|
108
|
-
| `lux show env` | 显示已配置的代理环境变量 |
|
|
109
|
-
| `lux vpn cmd` | 复制 CMD 代理命令到剪贴板 |
|
|
110
|
-
| `lux vpn pw` | 复制 PowerShell 代理命令到剪贴板 |
|
|
111
|
-
| `lux vpn bash` | 复制 Bash 代理命令到剪贴板 |
|
|
112
|
-
| `lux update` | 更新 `@luxkit/cli` 到最新版本 |
|
|
113
|
-
| `lux update --check` | 检查可用更新，不执行安装 |
|
|
114
|
-
|
|
115
|
-
<br />
|
|
116
|
-
|
|
117
|
-
### ⚙️命令选项
|
|
118
|
-
|
|
119
|
-
```bash
|
|
120
|
-
lux fmt <preset> [options]
|
|
121
|
-
|
|
122
|
-
--force 覆盖已有文件和脚本
|
|
123
|
-
--no-install 写入依赖到 package.json 但跳过安装
|
|
124
|
-
--dry-run 预览模式，不写入任何文件
|
|
125
|
-
--stylelint 包含 Stylelint 配置（按需启用）
|
|
126
|
-
--editorconfig 包含 EditorConfig 配置（按需启用）
|
|
127
|
-
--husky 初始化 husky Git hooks（按需启用）
|
|
128
|
-
--lint-staged 配置 lint-staged（自动启用 --husky，按需启用）
|
|
129
|
-
--cspell 包含 CSpell 配置（按需启用）
|
|
130
|
-
--reset 重置本地预设，从内置默认值重新创建
|
|
131
|
-
|
|
132
|
-
lux vscode <preset> [options]
|
|
133
|
-
|
|
134
|
-
--force 覆盖已有的 VSCode 配置文件
|
|
135
|
-
--dry-run 预览模式，不写入任何文件
|
|
136
|
-
--stylelint 包含 Stylelint 设置和扩展（按需启用）
|
|
137
|
-
--reset 重置本地预设，从内置默认值重新创建
|
|
138
|
-
```
|
|
139
|
-
|
|
140
|
-
<br />
|
|
141
|
-
|
|
142
|
-
## 🔧工作原理
|
|
143
|
-
|
|
144
|
-
```
|
|
145
|
-
lux fmt <preset> [options]
|
|
146
|
-
│
|
|
147
|
-
▼
|
|
148
|
-
解析 CLI 参数，校验项目 package.json
|
|
149
|
-
│
|
|
150
|
-
▼
|
|
151
|
-
预设类型判断
|
|
152
|
-
│
|
|
153
|
-
├── 内置预设 ──► --reset？ ──► 重置本地副本
|
|
154
|
-
│ │
|
|
155
|
-
│ ├── 本地副本存在 (~/.lux/preset/)？ ──► 从本地副本应用
|
|
156
|
-
│ └── 不存在 ──► 从内置生成 ──► 保存到 ~/.lux/preset/ ──► 应用
|
|
157
|
-
│
|
|
158
|
-
├── 自定义预设 (~/.lux/preset/fmt/<name>/) ──► 直接从本地目录应用
|
|
159
|
-
│
|
|
160
|
-
└── 未找到 ──► 模糊匹配所有可用预设（内置 + 自定义）并报错
|
|
161
|
-
│
|
|
162
|
-
▼
|
|
163
|
-
--stylelint / --editorconfig / --cspell / --husky / --lint-staged 过滤（自定义预设无对应配置时 warning）
|
|
164
|
-
│
|
|
165
|
-
▼
|
|
166
|
-
遍历每个配置文件：
|
|
167
|
-
│
|
|
168
|
-
├── 文件不存在？ ──► 创建
|
|
169
|
-
├── 已存在 + --force？ ──► 覆盖
|
|
170
|
-
└── 已存在？ ──► 跳过
|
|
171
|
-
│
|
|
172
|
-
▼
|
|
173
|
-
注入脚本到 package.json（自动检测 bun / pnpm / npm / yarn）
|
|
174
|
-
│
|
|
175
|
-
▼
|
|
176
|
-
安装 devDependencies（检测 lockfile 判断包管理器）
|
|
177
|
-
```
|
|
178
|
-
|
|
179
|
-
<br />
|
|
180
|
-
|
|
181
|
-
## 🔄重置与卸载
|
|
182
|
-
|
|
183
|
-
### 重置预设
|
|
184
|
-
|
|
185
|
-
```bash
|
|
186
|
-
# 重置内置预设（删除本地副本并从内置模板重新生成）
|
|
187
|
-
lux fmt web-vue --reset
|
|
188
|
-
lux vscode web-vue --reset
|
|
189
|
-
|
|
190
|
-
# 重新初始化所有内置预设（覆盖已有本地副本）
|
|
191
|
-
lux init --preset
|
|
192
|
-
|
|
193
|
-
# 重置自定义预设：手动删除对应目录
|
|
194
|
-
# rm -rf ~/.lux/preset/fmt/<your-custom-preset-name>
|
|
195
|
-
```
|
|
196
|
-
|
|
197
|
-
> 自定义预设使用 `--reset` 会提示警告并中止，因为不存在内置源可供恢复。
|
|
198
|
-
|
|
199
|
-
### 卸载
|
|
200
|
-
|
|
201
|
-
```bash
|
|
202
|
-
# 卸载 CLI
|
|
203
|
-
npm uninstall -g @luxkit/cli
|
|
204
|
-
|
|
205
|
-
# 清理配置目录（可选）
|
|
206
|
-
# rm -rf ~/.lux
|
|
207
|
-
|
|
208
|
-
# 清理skill，claude/opencode
|
|
209
|
-
# rm rum ~/.claude/skill/lux
|
|
210
|
-
# rm rum ~/.opencode/skill/lux
|
|
211
|
-
```
|
|
212
|
-
|
|
213
|
-
## 🔍故障排查
|
|
214
|
-
|
|
215
|
-
| 问题 | 解决方案 |
|
|
216
|
-
| :---------------------- | :----------------------------------------------------------------------------------------------------------------- |
|
|
217
|
-
| `package.json` 相关错误 | 确保项目根目录存在合法的 `package.json` |
|
|
218
|
-
| 预设未找到 | 运行 `lux fmt list` 查看所有可用预设，lux 会自动模糊匹配建议 |
|
|
219
|
-
| 包管理器检测不正确 | 确保 lockfile 存在（`bun.lock` / `package-lock.json` / `pnpm-lock.yaml`） |
|
|
220
|
-
| 跳过依赖安装 | 使用 `--no-install` 仅写入 `package.json`，手动安装 |
|
|
221
|
-
| 预览操作结果 | 使用 `--dry-run` 查看将执行的所有操作 |
|
|
222
|
-
| flag 无效果 | 自定义预设需包含对应的配置文件和依赖，`--stylelint`/`--cspell`/`--editorconfig`/`--husky`/`--lint-staged` 才能生效 |
|
|
223
|
-
|
|
224
|
-
<br />
|
|
225
|
-
|
|
226
|
-
## 🤝 参与贡献
|
|
227
|
-
|
|
228
|
-
欢迎提交 Bug、功能建议或代码贡献！
|
|
229
|
-
|
|
230
|
-
- 🐛 **提交 Issue**：[GitHub Issues](https://github.com/TTT1231/lux/issues)
|
|
231
|
-
- 🛠 **提交 PR**：[GitHub Pull Requests](https://github.com/TTT1231/lux/pulls)
|
|
232
|
-
- ⭐️ **Star 支持**：如果 lux 对你有帮助，欢迎 [Star](https://github.com/TTT1231/lux)！
|
|
233
|
-
|
|
234
|
-
<br />
|
|
235
|
-
|
|
236
|
-
## 📄 许可证
|
|
237
|
-
|
|
238
|
-
[ISC](https://opensource.org/licenses/ISC) — 可自由使用、修改和分发。
|
|
239
|
-
|
|
240
|
-
<br />
|
|
241
|
-
|
|
242
|
-
<p align="right"><a href="./README.md">← Switch to English</a></p>
|