# vscode-plugin

**Repository Path**: pepper-ham/vscode-plugin

## Basic Information

- **Project Name**: vscode-plugin
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-03-28
- **Last Updated**: 2025-09-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# vscode-plugin

一款AI开发vscode插件

需要实现的功能

- [x] 打开远程仓库地址
- [x] git快速提交
- [x] git自定义提交
- [x] 自动化生成api文档
- [ ] 根据api生成可复制的代码
- [ ] 自动化生成注释(待定)


1.按 F5 启动调试，它会自动运行 watch 任务

2.或者手动运行 pnpm run watch 来启动监视模式

3.使用 pnpm run compile 来一次性编译代码



参考文档

[从0到1开发一款自己的vscode插件](https://juejin.cn/post/7010765441144455199)

[最简单版VScode发布插件教程]()

1.全局安装需要用到的依赖。
> npm i yo generate-code -g

2.使用以下命令创建项目
> yo code

将会依次问你七个问题。

    1.选择你想要创建的插件类型。会根据你选择的类型，下载对应的模板。
    2.插件的名称。
    3.插件的唯一标识id。
    4插件的描述。
    5.是否需要git。
    6.构建工具是否使用webpack。
    7.选择包管理工具。

```json
{
	"name": "demo", // 插件名
	"displayName": "插件", // 显示在应用市场的名字
	"description": "我的第一个插件测试", // 具体描述
	"version": "0.0.1", // 插件的版本号
	"engines": {
		"vscode": "^1.60.0" // 最低支持的vscode版本
	},
	"categories": [
		"Other" // 扩展类别
	],
    // 激活事件组，在那些事件情况下被激活
	"activationEvents": [
		"onCommand:demo.helloWorld"
	],
    // 插件的主入口文件
	"main": "./extension.js",
    // 贡献点
	"contributes": {
        // 命令
		"commands": [
			{
				"command": "demo.helloWorld",
				"title": "Hello World"
			}
		]
	},
	"scripts": {
		"lint": "eslint .",
		"pretest": "npm run lint",
		"test": "node ./test/runTest.js"
	},
    // 开发依赖项
	"devDependencies": {
		"@types/vscode": "^1.60.0",
		"@types/glob": "^7.1.3",
		"@types/mocha": "^8.2.2",
		"@types/node": "14.x",
		"eslint": "^7.27.0",
		"glob": "^7.1.7",
		"mocha": "^8.4.0",
		"typescript": "^4.3.2",
		"vscode-test": "^1.5.2"
	}
}
```

### 发布 

> 这里是手动发布的流程。

1.打开[vscode marketplace](https://marketplace.visualstudio.com/vscode)

2.点击右上角的Publish extensions

3.创建一个publisher

4.填写Name、ID、Description，上传Logo

5.点击New extension，选择Visual Studio Code，将打包的vsix文件上传。

6.等五分钟左右，就可以在插件市场搜到自己的插件了！

安装对应的模块vsce
 
> npm i vsce -g

利用vsce进行打包，生成对应的vsix文件

> vsce package


### 使用规范
本地调试时先运行 

1. npm run compile 
2. npm run watch

生成api请求

1. 生成api请求地址的文件名默认为swagger中的tag标签,但如果标签为中文,则获取接口的前缀如:/aaa/bbb 则文件名为aaa.ts
2. 默认排除接口字段中的header,如需要，请自行添加