README.md · openKylin/ide-project-manager

# 项目管理器 Kylin Project Manager

[中文](#中文说明)|[English](#englishdescription)

## 中文说明

## 1、插件安装

- 通过插件筛选器，找到 Kylin Project Manager 插件
- 点击安装
- 完成安装。
- 如果是版本升级则需要重新加载主程序插件才生效，请根据提示操作完成安装。

## 2、项目管理插件操作区

- 在资源管理器展开“项目操作区”
- 基本操作：提供项目创建、配置、构建、调试、运行等相关功能入口；
- 任务列表：通过解析当前工作区第一个项目的tasks.json，显示各个任务按钮，悬停显示任务信息，点击执行具体任务。
- 调试配置列表：通过解析当前工作区第一个项目的launch.json，显示各个调试按钮，悬停显示调试信息，点击进入调试页面执行该调试。
- 执行CMake/Makefile：通过通过解析当前工作区第一个项目的CMakeLists.txt/Makefile，显示各个构建工具命令，点击调起终端执行。（暂不支持）
- 执行Node.js配置脚本：通过解析当前工作区第一个项目的package.json，显示脚本按钮，悬停显示脚本信息，点击调起终端通过npm执行。
- 如果项目内容发生变化，可点击右上角刷新图标刷新操作区；
- 支持自定义按钮，点击右上角添加自定义按钮；

### 3.1 添加自定义按钮...

- 点击右上角添加自定义按钮...
- 弹出下拉选择。

- 包括：
  - 添加自定义IDE命令调用按钮
    ``` 
    可以添加一个自定义按钮：
    ·输入按钮标题XXX；
    ·输入Kylin-IDE的commmand；
    ·刷新操作区后自定义按钮区显示XXX按钮；
    ·点击该按钮可以执行该command；
    ```
  - 添加自定义终端命令执行按钮
    ``` 
    可以添加一个自定义按钮：
    ·输入按钮标题；
    ·输入Linux终端命令；
    ·刷新操作区后自定义按钮区显示XXX按钮；
    ·点击该按钮可以打开一个Kylin-ID内置终端并执行该命令；
    ```
  - 打开tasks.json添加任务配置
    ``` 
    可以调起Kylin-IDE的任务配置，选择内置任务或手动输入添加任务；
    ```
  - 打开launch.json添加调试配置
    ``` 
    可以调起Kylin-IDE的调试配置，选择内置配置或手动添加配置；

## 3、创建新的项目

- 点击“创建新的项目”，也可以通过 Ctrl+Shift+P 调起命令窗口，输入“创建项目”或“project.createProject”，选择 PROJECT:创建项目，调起页面。
- 在右侧编辑区弹出“创建项目”页面。
- 页面内包括：
  - 语言类型选择（可以选择过滤不同的语言）
  - 标签过滤器（可以选择不同的标签对于项目类型进行过滤，支持多选）
  - Demo项目列表
    - 可以点击Demo项目图标进入对应的Demo项目创建页面。
  - Demo项目创建
    - 显示当前Demo项目的录入内容页面。
    - 提供 关闭、上一步/下一步、创建 等功能按钮。
    - 提供“开发环境快速部署”入口。

### 3.1、创建C/C++项目

- 在资源管理器展开“项目操作区”
- 点击“创建新的项目”，也可以通过 Ctrl+Shift+P 调起命令窗口，输入“创建项目”或“project.createProject”，选择 PROJECT:创建项目，调起页面。
- 在右侧编辑区弹出“创建项目”页面。
- 选择：C语言项目/C语言库项目/C++语言项目/C++语言库项目可以进入C/C++语言项目创建

#### 3.1.1、第一页 选择项目类型

- 点击“项目类型”
- 可以切换选择支持的项目类型。
- 点击“项目构建方式”
- 可以切换选择支持的项目构建方式，如“makefile”、“cmake”等。
- 点击下一页

#### 3.1.2、第二页 项目基本信息

- 输入合法项目名称(必填)
- 选择项目目录(必填)
- 输入更多信息
- 点击下一页

#### 3.1.3、第三页 编译链接库选项

- 选择C/C++语言标准
- 选择三方库引用
- 更多编译参数
- 点击下一页

#### 3.1.3、第四页 更多选项

- 输入合法编译输出文件名(必填)
- 调试运行参数
- 是否检查项目依赖
- 点击创建

#### 3.1.4、创建成功

- 弹出 C/C++环境检查通过提示
- 弹出创建项目成功提示
- 弹出询问在当前窗口打开新项目还是新建窗口打开？
- 打开新项目页面
- 点击“是，我信任此作者”，即可进行后续项目编写使用。

### 3.2、创建Java项目

- 在资源管理器展开“项目操作区”
- 点击“创建新的项目”，也可以通过 Ctrl+Shift+P 调起命令窗口，输入“创建项目”或“project.
createProject”，选择 PROJECT:创建项目，调起页面。
- 在右侧编辑区弹出“创建项目”页面。
- 选择Java项目

#### 3.2.1、输入信息

- 输入合法项目名称(必填)
- 选择项目目录(必填)
- 选择系统已有JDK目录，或切换输入JDK 目录(必填)
- 输入“输出目录”
- 点击创建

#### 3.2.2、创建成功

- 弹出创建项目成功提示
- 弹出询问在当前窗口打开新项目还是新建窗口打开？
- 打开新项目页面
- 点击“是，我信任此作者”，即可进行后续项目编写使用。

### 3.3、基于Maven的Java项目

- 检查maven插件安装，未安装弹出安装提示
- 安装完成或已安装，点击进入maven插件的项目创建流程

### 3.4、基于Gradle的Java项目

- 检查gradle插件安装，未安装弹出安装提示
- 安装完成或已安装，点击进入gradle插件的项目创建流程

### 3.5、基于maven构建javafx项目

- 检查maven插件安装，未安装弹出安装提示
- 安装完成或已安装，点击进入maven插件的 创建javaFx的DEMO项目流程

### 3.6、构建SpringBoot项目

- 检查springBoot插件安装，未安装弹出安装提示
- 安装完成或已安装，点击进入springBoot插件的项目创建流程

### 3.7、创建Python应用项目

- 在资源管理器展开“项目操作区”
- 点击“创建新的项目”，也可以通过 Ctrl+Shift+P 调起命令窗口，输入“创建项目”或“project.
createProject”，选择 PROJECT:创建项目，调起页面。
- 在右侧编辑区弹出“创建项目”页面。
- 选择Python应用项目

#### 3.7.1、输入信息

- 输入合法项目名称(必填)
- 选择项目目录(必填)
- 输入“执行文件”，用来生成 [执行文件].py文件
- 点击创建

#### 3.7.2、创建成功

### 3.8、创建JavaScript应用项目

- 在资源管理器展开“项目操作区”
- 点击“创建新的项目”，也可以通过 Ctrl+Shift+P 调起命令窗口，输入“创建项目”或“project.
createProject”，选择 PROJECT:创建项目，调起页面。
- 在右侧编辑区弹出“创建项目”页面。
- 选择JavaScript应用项目

#### 3.8.1、输入信息

- 输入合法项目名称(必填)
- 选择项目目录(必填)
- 输入“执行文件”，用来生成 [执行文件].py文件
- 点击创建

#### 3.8.2、创建成功

### 3.9、Go项目

- 在资源管理器展开“项目操作区”
- 点击“创建新的项目”，也可以通过 Ctrl+Shift+P 调起命令窗口，输入“创建项目”或“project.
createProject”，选择 PROJECT:创建项目，调起页面。
- 在右侧编辑区弹出“创建项目”页面。
- 选择Go项目

#### 3.9.1、输入信息

- 选择支持的项目构建方式，如“makefile”、“cmake”等。
- 输入合法项目名称(必填)
- 选择项目目录(必填)
- 输入“编译输出文件”
- 点击创建

#### 3.9.2、创建成功

## 4、配置

- 打开测试项目
- 点击“配置”
- 在右侧编辑区弹出“配置项目”页面。

包括以下：
  - 编辑调试配置文件launch.json，点击打开文件编辑调试配置。（如当前项目没有，会弹出创建选择）
    创建方法如下：

- 点击菜单中的运行->添加配置

- launch.json文件创建成功
  - 编辑task配置文件tasks.json，点击打开文件编辑编译、运行等任务。（如果当前项目没有，会弹出创建选择）

创建方法如下：

- 点击菜单中的终端->配置任务->使用模板创建tasks.json文件->others

- tasks.json文件创建成功

创建的tasks.json默认内容如下：

```json
      {
      // See https://go.microsoft.com/fwlink/?LinkId=733558
      // for the documentation about the tasks.json format
      "version": "2.0.0",
      "tasks": [
          {
              "label": "echo",
              "type": "shell",
              "command": "echo Hello"
          }
        ]
      }
      ```

- 根据项目情况修改tasks.json文件，以testJava为例修改后内容如下：

```json
      {
          "label": "build", 
          "type": "shell", 
          "options": {
              "cwd": "${workspaceFolder}"
          }, 
          "command": "javac", 
          "args": [
              "src/main.java",
              "-sourcepath",
              "src",
              "-classpath",
              "${config:java.project.referencedLibraries}",
              "-d", 
              "${config:java.project.outputPath}"
          ]
      }, 
      {
          "label": "run", 
          "type": "shell", 
          "options": {
              "cwd": "${workspaceFolder}"
          }, 
          "command": "java", 
          "args": [
              "-cp", 
              "${config:java.project.outputPath}", 
              "main"
          ], 
          "dependsOn": [
              "javac"
          ]
      }
      ```

修改后，即可支持通过任务进行构建、运行等操作。

更多tasks和launch相关内容请参考文档：https://gitee.com/openkylin/extensions-repo/blob/master/user-guide/files/%E5%A6%82%E4%BD%95%E9%85%8D%E7%BD%AE%E5%B7%A5%E7%A8%8B%E7%9A%84%E6%9E%84%E5%BB%BA-%E8%B0%83%E8%AF%95-%E8%BF%90%E8%A1%8C.md

## 5、构建

构建功能入口，为项目开发提供快捷操作。

- 依赖.vscode/tasks.json 文件定义。
- 点击会打开tasks.json的 build项目执行，通过终端执行构建。
- 如果基于cmake工具，且cmake-tools插件已安装，则会弹出选择“使用CMake tools构建”或“使用build任务构建”，根据用户选择决定。

## 6、运行

运行功能入口，为项目开发提供快捷操作。

- 依赖.vscode/tasks.json 文件定义。
- 点击会打开tasks.json的所有项目，选择run项目，选择继续而不扫描任务输出，通过终端执行程序运行。
- 如果基于cmake工具，且cmake-tools插件已安装，则会弹出选择“使用CMake tools运行”或“使用run任务运行”，根据用户选择决定。

## 7、调试

调试功能入口，点击进入“调试”功能

- 依赖.vscode/launch.json文件
- 点击“调试”按钮，进入调试页面。

- 如图，此时项目没有launch.json文件。
- 点击“创建 launch.json 文件。

- 弹出选择调试器，请根据项目类型选择相应的调试器。
- 创建完成，会进入运行调试页面。可以按项目需要修改launch.json，可以点击左侧选择需要的调试配置项

- 点击绿色三角开始调试。

## 8、插件依赖说明

- java：
  - openjdk 11+
- 打包：
  - dpkg
  - rpm
  - maven 3.6.3+

## 9、下载链接

- **Kylin Project Manager**:支持麒麟V10操作系统的创建项目和打包插件，支持X86、ARM、LongArch架构

- [Kylin Project Manager-Repository链接](https://gitee.com/openkylin/ide-project-manager)

- [Kylin Project Manager -下载链接](https://gitee.com/openkylin/ide-project-manager/releases)

## 10、源码构建说明

### 10.1 yarn 失败

配置淘宝源
     yarn config set registry http://registry.npmmirror.com/

### 10.2 插件构建

cd ${projectpath}/web
    yarn
    cd ${projectpath}/
    yarn
    yarn run compile

### 10.3 打包

cd ${projectpath}/
    yarn
    yarn run compile
    yarn run package

## EnglishDescription

### Introduction

## 1. Extension installation

- Find the Kylin Project Manager extension through the extension filter

- Click to install

- Complete the installation.

- If it is a version upgrade, the main program extension needs to be reloaded to take effect. Please follow the prompts to complete the installation.

## 2. Project management extension operation area

- Expand the "Project Operations Area" in Explorer

- Basic operation: Provide entry points for project creation, configuration, construction, debugging, running functions;

- Task List: By parsing the tasks.json of the first project in the current workspace, display various task buttons, hover to display task information, and click to execute specific tasks.

- Debugging Configure List: By parsing the launch. json of the first project in the current workspace, display various debugging buttons, hover to display debugging information, and click to enter the debugging page to execute the debugging.

- Execute CMake/Makefile: Display various build tool commands by parsing the first project's CMakeLists.txt/Makefile in the current workspace, and click to start terminal execution.

- Execute a Node.js script: By parsing the package.json of the first project in the current workspace, display the script button, hover to display the script information, and click to launch the terminal for execution via npm.

- If the project content changes, you can click the refresh icon in the upper right corner to refresh the operation area;

- Support custom buttons, click on the top right corner to add custom buttons;

###3.1 Add Custom Button

- Click the Add Custom button in the upper right corner
- Pop up dropdown selection.
- Including:
  - Add custom IDE command call button
    ``` 
    You can add a custom button, enter the button title, and IDE commmand; After refreshing the operation area, click the add button to execute the command;
    ```
  - Add custom terminal command execution button
    ``` 
    You can add a custom button, enter the button title, and Linux terminal commands; After refreshing the operation area, click the add button to open a Kylin ID built- in terminal and execute the command;
    ```
  - Open tasks.json to add task configuration
    ``` 
    You can adjust the task configuration of Kylin IDE, select or manually add tasks;
    ```
  - Open launcher. json to add debugging configuration
    ``` 
    You can adjust the debugging configuration of Kylin IDE by selecting or manually adding configurations;
    ```

## 3. Create new project

- Click on "Create New Project" or use Ctrl+Shift+P to bring up a command window, enter "Create Project" or "project. createProject", select PROJECT: Create Project, and bring up the page.

- The "Create Project" page pops up in the editing area on the right.

- The page includes:

- Language type selection (can choose to filter different languages)

- Tag filter (can select different tags to filter project types, supports multiple selections)
  
  - List of Demo Projects

- You can click on the Demo project icon to enter the corresponding Demo project creation page.

- Demo project creation

- Display the input content page of the current demo project.

- Provide buttons for closing, previous/next, creating, and other functions.

- Provide an entrance for "rapid deployment of development environment".

## 4. Configure the project

- Open test projects

- Click on 'Configure the Project'

- The "Configuration Items" page pops up in the editing area on the right.

Including the following:

- Open the debugging configuration file launch.json, click to open the file and edit the debugging configuration. (If the current project does not have one, a create selection will pop up)

```
  For more tasks and launch related content, please refer to the document:
  https://gitee.com/openkylin/extensions-repo/blob/master/user-guide/files/%E5%A6%82%E4%BD%95%E9%85%8D%E7%BD%AE%E5%B7%A5%E7%A8%8B%E7%9A%84%E6%9E%84%E5%BB%BA-%E8%B0%83%E8%AF%95-%E8%BF%90%E8%A1%8C.md
```

## 5. Compilation

Compilation function entry, providing quick operations for project development.

- Dependency on the. vscode/tasks.json file definition.

- Clicking will open the build project execution for tasks.json, which will be compiled through the terminal.

## 6. Operation

Run the function entry to provide quick operations for project development.

- Dependency on the. vscode/tasks.json file definition.

- Clicking will open all the projects in tasks.json, select the run project, choose to continue without scanning the task output, and run the program through the terminal execution.

## 7. Debugging

Debug function entry, click to enter the "Debug" function

- Dependency on the. vscode/launch.json file

- Click the "Deb

## 8. Extension Dependencies

- Java:
  - OpenJDK 11+
- Packaging:
  - dpkg
  - rpm
  - Maven 3.6.3+

## 9. Download link

- **Kylin Project Manager**: Create Project and make package for the Kylin V10 operating system, supporting X86, ARM, and LongArch architectures

- [Kylin Project Manager - links to the Repository] (<https://gitee.com/openkylin/ide-project-manager>)

- [Kylin Project Manager - download link] (<https://gitee.com/openkylin/ide-project-manager/releases>)

## 10. Source Code Build Instructions

### 10.1 Yarn Failure

Configure Taobao registry
    yarn config set registry http://registry.npmmirror.com/

### 10.2 Extension Build

cd ${projectpath}/web
    yarn
    cd ${projectpath}/
    yarn
    yarn run compile

### 10.3 Packaging

cd ${projectpath}/
    yarn
    yarn run compile
    yarn run package

openKylin/ide-project-manager

简介

发行版 (5)

贡献者

近期动态

openKylin/ide-project-manager .gitee-modal { width: 500px !important; }

简介

发行版 (5)

贡献者

近期动态

搜索帮助

openKylin/ide-project-manager