devstar-vscode/README.md

DevStar

User Quick Start

点击插件后点击open进入home页面，未登录时可以通过插件跳转到devstar网站，登录后可以通过插件跳转到本地devstar个人主页。

登录后，登录状态会长久保存，直到主动退出登录或者卸载插件。

可供配置的字段

• Devstar Domain（注意点：https://devstar.cn和http://localhost:3000的协议头https和http不能写错或写反，否则会出现页面无反应的异常。）

注意：

1）配置修改后，重启vscode才能生效；

编译/调试

容器环境提供了开发环境，安装好编译与调试所需要的工具链。

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).”，此时点击“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添加如下的配置：

[core]
	- filemode = false
	- autocrlf = true