KostalCodeProjectDevelopmentPlatform README

一、环境准备

1. 配置环境变量

一般不需要配置，默认即可

点击vscode左下角设置按钮，并点击设置文字按钮打开设置页面
输入KostalCodeProjectDevelopmentPlatform搜索本插件配置

MSYS:配置make工具环境, KOSTAL Eclipse中已集成
MINGW:配置make文件或bat文件使用的一些命令工具环境, KOSTAL Eclipse中已集成

TIP:上述环境后续将在本插件中集成

2. 创建kpm-package.json文件

在项目根目录下创建名为kpm-package.json的文件

示例

{
    "name": "projectName",
    "type": "KOSTAL_CODE_PROJECT",
    "version": "0.0.0",
    "author": "hzc",
    "private": false,
    "scripts": {},
    "additional": {
        "compiler": "iar",
        "compileMakeFilePath": "./Tools/ToolsConfig/compile_opt.mk"
    },
    "dependencies": {},
    "devDependencies": {}
}

name:项目的名字，现阶段可以不填，也可以没有
type:KOSTAL代码项目必须填写KOSTAL_CODE_PROJECT
version:项目版本号，现阶段可以不填，也可以没有
author:项目作者，可以不填，也可以没有
private:项目是否是私有的，现阶段可以不填，也可以没有
scripts:项目post build或pre build执行的脚本配置，必须配合kpm使用
additional:额外的配置项，不同的项目类型有不同的配置项，以下子配置仅针对KOSTAL_CODE_PROJECT
- compiler:项目编译所使用的编译器类型，现阶段支持iar,ghs,tasking，用于编译时提取编译警告和错误，并在问题页面显示
- compileMakeFilePath:KOSTAL代码项目compile make文件的相对路径(相对项目根目录)，用于自动获取在make文件中定义的CC_DEFLIST宏，在编辑代码时可识别到这里定义的宏

3. C或CPP项目集成环境安装-vscode插件(在插件市场搜索安装)

一般第一次打开C或CPP文件，vscode会自动提醒安装

C/C++
C/C++ Extension Pack
C/C++ Themes

二、使用

确保项目根目录已有kpm-package.json文件

1. 插件的激活

打开已有kpm-package.json的项目，插件会自动激活。如果是第一次创建kpm-package文件的话，在创建之后使用ctrl+shift+alt+k快捷键，可主动激活插件。插件激活后，你将在资源管理器视图的下方看到MAKE TARGET和KPM DEPENDENCIES界面.

MAKE TARGET界面
该界面有一些常用的make命令，现在是固定的几个项，后续更新会增加用户可主动添加Make命令的功能
KPM DEPENDENCIES界面
KPM包依赖展示界面

2. KOSTAL代码项目compile make文件定义的宏获取(快捷键`ctrl+shift+alt+r`)

KOSTAL代码项目中常常有一些宏定义在compile_opt.mk这种文件中，这里的宏在Eclipse项目中没有办法识别，在代码中看起来这段代码没有使能，但是实际编译是使能的，导致一些不必要的逻辑错误出现。本插件可提取compile_opt.mk这种文件中定义的宏，可在代码编辑时显示出这些宏导致的使能或失能。

TIP:要求compile_opt.mk文件中必须要以下列形式定义宏

CC_DEFLIST = xxx\
			 xxxx\
			 xxxxx\

Enjoy!

KostalCodeProjectDevelopmentPlatform

HZC