21.1 插件开发环境搭建

21.1.1 系统要求

基本要求

类别	最低要求	推荐配置

操作系统| Windows 10+ / macOS 10.15+ / Linux (Ubuntu 20.04+, Debian 11+)| Windows 11 / macOS 12+ / Linux (Ubuntu 22.04+, Debian 12+)

软件依赖

软件名称	最低版本	推荐版本

Claude Code| 1.0.0| latest Node.js| 14.0.0| 18.0.0+ Python| 3.8| 3.10+ Git| 2.20.0| latest

21.1.2 安装开发工具

1. 安装 Node.js

推荐使用 nvm 进行 Node.js 版本管理：

    bash


    # 安装 nvm
    curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
    source ~/.bashrc

    # 安装并使用 Node.js 18
    nvm install 18
    nvm use 18

    # 验证安装
    node --version
    npm --version

### 2\. 安装 Python

#### macOS

    bash


    brew install python@3.10

#### Ubuntu/Debian

    bash


    sudo apt update
    sudo apt install python3.10 python3.10-venv python3-pip

#### Windows

从 Python 官方网站下载安装程序。

    bash


    # 验证安装
    python3 --version
    pip3 --version

### 3\. 安装 Git

#### macOS

    bash


    brew install git

#### Ubuntu/Debian

    bash


    sudo apt install git

#### Windows

从 Git 官方网站下载安装程序。

python

    bash


    # 验证安装
    git --version

### 4\. 安装 Claude Code CLI

    bash


    # 使用 npm 安装
    npm install -g @anthropic-ai/claude-code

    # 验证安装
    claude --version

## 21.1.3 安装插件开发工具

### 1\. 安装插件脚手架工具

    bash


    # 安装插件脚手架
    npm install -g @claude-code/plugin-scaffold

    # 验证安装
    claude-plugin-scaffold --version

### 2\. 安装插件开发工具

    bash


    # 安装开发工具
    npm install -g @claude-code/plugin-devtools

    # 验证安装
    claude-plugin-devtools --version

### 3\. 安装插件测试工具

    bash


    # 安装测试工具
    npm install -g @claude-code/plugin-test

    # 验证安装
    claude-plugin-test --version

## 21.1.4 创建开发环境

### 1\. 创建项目目录

    bash


    # 创建插件项目目录
    mkdir my-plugin
    cd my-plugin

    # 初始化项目
    npm init -y

### 2\. 安装开发依赖

    bash


    # 安装插件 SDK
    npm install @claude-code/plugin-sdk --save-dev

    # 安装 TypeScript（推荐）
    npm install typescript @types/node --save-dev

    # 安装测试框架
    npm install jest @types/jest --save-dev

    # 安装代码检查工具
    npm install eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin --save-dev

### 3\. 配置 TypeScript

    json


    // tsconfig.json
    {
      "compilerOptions": {
        "target": "ES2020",
        "module": "commonjs",
        "lib": ["ES2020"],
        "outDir": "./dist",
        "rootDir": "./src",
        "strict": true,
        "esModuleInterop": true,
        "skipLibCheck": true,
        "forceConsistentCasingInFileNames": true,
        "resolveJsonModule": true,
        "declaration": true,
        "declarationMap": true,
        "sourceMap": true,
        "moduleResolution": "node"
      },
      "include": ["src/**/*"],
      "exclude": ["node_modules", "dist", "**/*.test.ts"]
    }

### 4\. 配置 ESLint

    json


    // .eslintrc.json
    {
      "parser": "@typescript-eslint/parser",
      "extends": [
        "eslint:recommended",
        "plugin:@typescript-eslint/recommended"
      ],
      "plugins": ["@typescript-eslint"],
      "rules": {
        "@typescript-eslint/no-unused-vars": "error",
        "@typescript-eslint/explicit-function-return-type": "warn",
        "@typescript-eslint/no-explicit-any": "warn"
      }
    }

### 5\. 配置 Jest

    json


    // jest.config.json
    {
      "preset": "ts-jest",
      "testEnvironment": "node",
      "roots": ["<rootDir>/src"],
      "testMatch": ["**/__tests__/**/*.ts", "**/?(*.)+(spec|test).ts"],
      "collectCoverageFrom": [
        "src/**/*.ts",
        "!src/**/*.d.ts",
        "!src/**/*.test.ts"
      ]
    }

### 6\. 配置 package.json

    json


    {
      "name": "my-plugin",
      "version": "1.0.0",
      "description": "My Claude Code Plugin",
      "main": "dist/index.js",
      "types": "dist/index.d.ts",
      "scripts": {
        "build": "tsc",
        "dev": "tsc --watch",
        "test": "jest",
        "test:watch": "jest --watch",
        "lint": "eslint src/**/*.ts",
        "lint:fix": "eslint src/**/*.ts --fix",
        "clean": "rm -rf dist"
      },
      "keywords": [
        "claude-code",
        "plugin"
      ],
      "author": "Your Name",
      "license": "MIT",
      "devDependencies": {
        "@claude-code/plugin-sdk": "^1.0.0",
        "@types/jest": "^29.0.0",
        "@types/node": "^18.0.0",
        "@typescript-eslint/eslint-plugin": "^5.0.0",
        "@typescript-eslint/parser": "^5.0.0",
        "eslint": "^8.0.0",
        "jest": "^29.0.0",
        "ts-jest": "^29.0.0",
        "typescript": "^4.9.0"
      }
    }

## 21.1.5 创建插件项目结构

### 标准项目结构

    bash


    my-plugin/
    ├── src/
    │   ├── index.ts              # 插件入口
    │   ├── plugin.ts            # 插件主类
    │   ├── tools/               # 工具定义
    │   │   ├── tool1.ts
    │   │   └── tool2.ts
    │   ├── commands/            # 命令定义
    │   │   ├── command1.ts
    │   │   └── command2.ts
    │   ├── utils/               # 工具函数
    │   │   └── helpers.ts
    │   └── types/               # 类型定义
    │       └── index.ts
    ├── __tests__/               # 测试文件
    │   ├── plugin.test.ts
    │   ├── tools/
    │   │   └── tool1.test.ts
    │   └── commands/
    │       └── command1.test.ts
    ├── dist/                    # 编译输出
    ├── templates/               # 模板文件
    ├── docs/                    # 文档
    ├── examples/                # 示例
    ├── .eslintrc.json          # ESLint 配置
    ├── .gitignore              # Git 忽略文件
    ├── jest.config.json        # Jest 配置
    ├── package.json            # 项目配置
    ├── plugin.yaml             # 插件清单
    ├── tsconfig.json           # TypeScript 配置
    └── README.md               # 项目说明

### 创建目录结构

    bash


    # 创建目录结构
    mkdir -p src/tools src/commands src/utils src/types __tests__/tools __tests__/commands dist templates docs examples

    # 创建基本文件
    touch src/index.ts src/plugin.ts src/types/index.ts
    touch .eslintrc.json jest.config.json tsconfig.json plugin.yaml README.md
    touch .gitignore

### 配置 .gitignore

    gitignore


    # Dependencies
    node_modules/

    # Build output
    dist/

    # Test coverage
    coverage/

    # IDE
    .vscode/
    .idea/
    *.swp
    *.swo

    # OS
    .DS_Store
    Thumbs.db

    # Logs
    *.log
    npm-debug.log*

    # Environment
    .env
    .env.local

    # Temporary files
    *.tmp
    .cache/

## 21.1.6 配置开发环境

### 1\. 配置 IDE

#### VS Code 配置

    json


    // .vscode/settings.json
    {
    "typescript.tsdk": "node_modules/typescript/lib",
    "editor.formatOnSave": true,
    "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true
    },
    "files.exclude": {
    "**/node_modules": true,
    "**/dist": true,
    "**/coverage": true
    }
    }

#### VS Code 扩展推荐

    json


    // .vscode/extensions.json
    {
      "recommendations": [
        "dbaeumer.vscode-eslint",
        "esbenp.prettier-vscode",
        "ms-vscode.vscode-typescript-next"
      ]
    }

#### VS Code 任务

    json


    // .vscode/tasks.json
    {
      "version": "2.0.0",
      "tasks": [
        {
          "type": "npm",
          "script": "build",
          "problemMatcher": "$tsc",
          "group": {
            "kind": "build",
            "isDefault": true
          }
        },
        {
          "type": "npm",
          "script": "test",
          "problemMatcher": "$tsc",
          "group": {
            "kind": "test",
            "isDefault": true
          }
        },
        {
          "type": "npm",
          "script": "lint",
          "problemMatcher": "$eslint-stylish",
          "group": "build"
        }
      ]
    }

### 2\. 配置调试

    json


    // .vscode/launch.json
    {
      "version": "0.2.0",
      "configurations": [
        {
          "name": "Debug Plugin",
          "type": "node",
          "request": "launch",
          "runtimeExecutable": "npm",
          "runtimeArgs": ["run", "dev"],
          "console": "integratedTerminal",
          "internalConsoleOptions": "neverOpen"
        },
        {
          "name": "Debug Tests",
          "type": "node",
          "request": "launch",
          "runtimeExecutable": "npm",
          "runtimeArgs": ["run", "test:watch"],
          "console": "integratedTerminal",
          "internalConsoleOptions": "neverOpen"
        }
      ]
    }

### 3\. 配置 Git Hooks

    bash


    # 安装 husky
    npm install husky --save-dev

    # 初始化 husky
    npx husky install

    # 添加 pre-commit hook
    npx husky add .husky/pre-commit "npm run lint && npm run test"

## 21.1.7 创建插件清单

### plugin.yaml 配置

    yaml


    # plugin.yaml
    name: my-plugin
    version: 1.0.0
    description: My Claude Code Plugin
    author: Your Name
    license: MIT
    homepage: https://github.com/yourname/my-plugin
    repository: https://github.com/yourname/my-plugin

    # 插件入口
    main: dist/index.js
    types: dist/index.d.ts

    # 插件权限
    permissions:
      file:
        - read: "/"
      network:
        - https: ["api.example.com"]

    # 插件依赖
    dependencies:
      claude-code: ">=1.0.0"

    # 开发依赖
    devDependencies:
      typescript: "^4.9.0"
      jest: "^29.0.0"

    # 插件配置
    config:
      timeout: 30
      retries: 3

    # 插件元数据
    metadata:
      category: development
      tags:
        - code-generation
        - productivity
      keywords:
        - plugin
        - claude-code

## 21.1.8 验证开发环境

### 1\. 创建测试文件

    typescript


    // src/index.ts
    export * from './plugin';

    typescript


    // src/plugin.ts
    import { Plugin } from '@claude-code/plugin-sdk';

    export class MyPlugin extends Plugin {
      constructor() {
        super({
          name: 'my-plugin',
          version: '1.0.0',
          description: 'My Claude Code Plugin'
        });
      }

      async initialize(): Promise<void> {
        console.log('Plugin initialized');
      }

      async start(): Promise<void> {
        console.log('Plugin started');
      }

      async stop(): Promise<void> {
        console.log('Plugin stopped');
      }
    }

### 2\. 编译项目

    bash


    # 编译 TypeScript
    npm run build

    # 检查编译输出
    ls -la dist/

### 3\. 运行测试

    bash


    # 运行测试
    npm test

    # 运行测试并生成覆盖率报告
    npm run test -- --coverage

### 4\. 运行代码检查

    bash


    # 运行 ESLint
    npm run lint

    # 自动修复问题
    npm run lint:fix

## 21.1.9 开发工作流

### 1\. 开发流程

    bash


    # 1. 创建功能分支
    git checkout -b feature/new-feature

    # 2. 开发功能
    # 编辑代码...

    # 3. 运行测试
    npm test

    # 4. 运行代码检查
    npm run lint

    # 5. 编译项目
    npm run build

    # 6. 提交更改
    git add .
    git commit -m "Add new feature"

    # 7. 推送到远程
    git push origin feature/new-feature

    # 8. 创建 Pull Request

### 2\. 调试流程

    bash


    # 1. 启动开发模式
    npm run dev
    # 2. 在 VS Code 中设置断点
    # 3. 按 F5 启动调试
    # 4. 在调试控制台中查看输出

### 3\. 测试流程

    bash


    # 1. 编写测试
    # 创建测试文件...

    # 2. 运行测试
    npm test

    # 3. 查看测试覆盖率
    npm run test -- --coverage

    # 4. 运行特定测试
    npm test -- --testNamePattern="MyPlugin"

## 21.1.10 常见问题解决

### 1\. TypeScript 编译错误

    bash


    # 清理编译缓存
    npm run clean
    npm run build

    # 重新安装依赖
    rm -rf node_modules package-lock.json
    npm install

### 2\. 测试失败

    bash


    # 更新 Jest 配置
    npm install --save-dev jest@latest ts-jest@latest

    # 清理 Jest 缓存
    npm test -- --clearCache

### 3\. ESLint 错误

    bash


    # 自动修复 ESLint 错误
    npm run lint:fix

    # 更新 ESLint 配置
    npm install --save-dev @typescript-eslint/parser@latest @typescript-eslint/eslint-plugin@latest

### 4\. 插件无法加载

    bash


    # 检查插件清单
    cat plugin.yaml

    # 验证编译输出
    ls -la dist/

    # 重新编译
    npm run clean
    npm run build

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624

21.1 插件开发环境搭建 ​

21.1.1 系统要求 ​

基本要求 ​

软件依赖 ​

21.1.2 安装开发工具 ​

1. 安装 Node.js ​