84 lines
3.2 KiB
Markdown
84 lines
3.2 KiB
Markdown
# DevStar
|
||
|
||
## User Quick Start
|
||
|
||
进入home页面，home页面的功能都需要登录后才能使用。
|
||
|
||
登录后，登录状态会长久保存，直到主动退出登录或者卸载插件。
|
||
|
||
### 可供配置的字段
|
||
|
||
- Devstar Domain（注意点：`https://devstar.cn`和`http://localhost:3000`的协议头`https`和`http`不能写错或写反，否则会出现页面无反应的异常。）
|
||
|
||
注意：
|
||
|
||
1）配置修改后，重启vscode才能生效；
|
||
|
||
### 创建新仓库/创建新项目
|
||
|
||
目前可供选择的字段
|
||
|
||
- name* 必填
|
||
- default_branch
|
||
- description
|
||
- gitignores
|
||
- issue_labels
|
||
- license
|
||
- object_format_name
|
||
- private
|
||
- readme
|
||
- template
|
||
- trust_model
|
||
|
||
### 打开项目
|
||
|
||
打开项目是指在vscode上打开远程容器中创建好的项目。选择项目名称右侧对应的Open project，即可打开项目。
|
||
|
||
### 编译/调试
|
||
|
||
容器环境提供了开发环境，安装好编译与调试所需要的工具链。
|
||
|
||
## Developer Quick Start
|
||
|
||
### 准备开发环境
|
||
|
||
#### Windows/MacOS/Linux
|
||
|
||
需要预置开发环境：Nodejs、Typescript开发环境
|
||
|
||
1. git clone项目到本地，然后通过VSCode打开项目。
|
||
2. 下载项目所需依赖，执行命令：`npm install`。
|
||
|
||
#### DevContainer环境
|
||
|
||
1. git clone项目到本地，然后通过VSCode打开项目
|
||
2. 项目提供了devcontainer的开发配置，通过vscode打开本项目后，会提示“Folder contains a Dev Container configuration file. Reopen folder to develop in a container ([learn more](https://aka.ms/vscode-remote/docker)).”，此时点击“Reopen in Container”，自动进入vscode的devcontainer环境中。
|
||
3. 本项目的devcontainer预置了Node.js & Typescript的开发环境。在vscode的命令行工具执行`npm install`命令，下载项目所需依赖。
|
||
|
||
### 编译插件
|
||
|
||
1. 项目目录`.vscode/launch.json`中提供了编译与启动插件的配置。
|
||
2. 按`F5`即可编译和测试插件。
|
||
|
||
### 打包&发布插件
|
||
|
||
1. 打包和发布插件均需要用到`@vscode/vsce`包，项目依赖中已包含。
|
||
2. 打包插件
|
||
1. 方法一：通过Ctrl+Shift+P启动Command Palette，选择Tasks: Run Task，然后选择最下方的Show All Tasks...，最后选择npm: vscode:package。
|
||
2. 方法二：打开package.json文件，找到`scripts`字段，它上方有`Debug`按钮，点击之后会让你选择要执行的task，选择vscode:package。
|
||
3. 发布插件
|
||
1. 发布之前需要先完成打包。
|
||
2. 发布插件需要publisher的Personal Access Token（token项目负责人）。（Token**有效时间**：1年）
|
||
3. 发布方法
|
||
1. 方法一：步骤与打包插件的方法一基本一样，除了最后一步选择npm: vscode:publish。接着会弹出要求填写Personal Access Token的prompt，填上回车即可。
|
||
2. 方法二：步骤与打包插件的方法二基本一样，除了最后一步选择npm: vscode:publish。接着会弹出要求填写Personal Access Token的prompt，填上回车即可。
|
||
|
||
### 特殊：Git
|
||
|
||
由于先在主机上clone下来项目，在devcontainer上再打开以后，git认为所有的文件都更改了。需要在`.git/config`添加如下的配置：
|
||
|
||
```bash
|
||
[core]
|
||
- filemode = false
|
||
- autocrlf = true
|
||
``` |