# super-ide-vscode

**Repository Path**: SuperIDE/super-ide-vscode

## Basic Information

- **Project Name**: super-ide-vscode
- **Description**: Super IDE  vscode插件
- **Primary Language**: Unknown
- **License**: AGPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 0
- **Created**: 2023-02-01
- **Last Updated**: 2025-03-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Super IDE for VSCode

## 用户安装使用指南

### 安装

#### 安装插件
去VSCode插件市场搜索“Super IDE”，找到名为“SI: Super IDE“的插件，下载即可。

![image-20230913114746553](https://gitee.com/SuperIDE/super-ide-vscode/raw/master/images/image-20230913114746553.png)

（如果是win平台，还需要自行下载wsl与vscode上的wsl插件）

#### 安装super-ide

1. 如果是**win**平台，打开插件则会自动打开wsl，并将插件安装在wsl（第一次打开），接着打开wsl上的vscode界面。此时再打开该界面上的插件，则会自动下载并安装好super-ide。即用户将在wsl linux上开发。
2. 如果是**其他**平台，第一次打开插件则会自动下载并安装好super-ide。

### 使用

#### Upload

1. Upload
   1. 在platformio.ini中填写uploader字段（可以填写已安装好的程序路径或者官方支持的uploader name）
   2. 点击PROJECT TASKS中的Upload选项或者状态栏的Upload，则会自动启动platformio.ini中定义好的uploader（如果uploader所定义的是官方支持的uploader软件且未安装好，则会自动下载并安装好指定的软件）
2. Local Upload
   1. 本功能只在vscode窗口处于远程状态下才能生效。
   2. 在platformio.ini中填写local_uploader字段（可以填写填写已安装好的程序路径或者官方支持的uploader name）
   3. 点击PROJECT TASKS中的Local Upload选项或者状态栏的Local Upload按钮，则会提醒用户将编译好的firmware文件下载到本地，并自动在本地启动platformio.ini中定义好的local_uploader（如果local_uploader所定义的是官方支持的uploader软件且未安装好，则会自动下载并安装好指定的软件）。

## 开发者指南

### 开发环境配置

（如果是win平台，需要安装wsl与vscode上的wsl插件）

1. 下载VSCode。
2. 下载nodejs。
3. 将本项目clone到本地，然后进入项目目录。
4. 执行`npm install`将项目需要的依赖都下载好。
   1. 如果在windows上，使用npm下载某个项目的依赖可能会出现较多问题，可以下载`yarn`（`npm install -g yarn`），然后使用`yarn build`来将依赖下载好。

完成上述配置即可开始开发本插件。


### 运行调试方法

插件代码写好后，按`F5`开启调试。

### 构建打包的过程

1. 下载vsce：`npm install -g @vscode/vsce`。
2. 执行打包命令：`vsce package`。

### Publish

1. 找相关人员获取publisher (mengning)的`Personal Access Token`。
2. 在项目目录下执行：`vsce login mengning`来登录插件市场，并将要求的`Personal Access Token`输入，等待登录成功。
3. 登录成功后，使用`vsce publish`即可将插件发布到插件市场。


## [开发者帮助文档](https://gitee.com/SuperIDE/super-ide-vscode/tree/master/doc)

todo

## License

Copyright (c) 2022-present Mengning <mengning997@163.com>

The Super IDE is licensed under the AGPL 3.0 license or commercial license.