CODESS 代码片段工具，自定义您的 vscode 代码片段。

# CODESS 代码片段工具

我们优化了文档。

[官网 CODESS]( https://codess.dumogu.top/)，[在线工具]( https://codess.dumogu.top/try)，[文档]( https://codess.dumogu.top/doc/help)

codess 是一个管理 vscode 代码片段提示的一个 npm 包，codess 可以安装网站上的公共包，也可以安装本地自定义的包，codess 安装的包是片段包，是一个代码片段的集合，里面有很多自定义的代码片段。

您如果不了解什么是 vscode 代码片段提示的话请看下一章，您如果不了解 codess 的工作原理的话，请看另一章节。

## 您只需要几步就能使用 codess 了

#### 1：第一步，安装 codess

您得确定您已经安装过 node.js

```javascript
npm install --global codess
```

#### 2：第二步，使用 codess 安装一个代码包

这里我们安装一个叫做 codess-example 的包，版本是 1.0.0 ，注意：因为代码片段需要基于一个 node 项目，所以您可以随意建一个 node 项目试试。没有版本号的话安装默认版本。

```javascript
codess install codess-example@1.0.0
```

#### 3：第三步，随意打开项目中得一个 js 文件，并在其中输入:for

现在您的 vscode 已经可以很智能的根据触发词筛选出您想要的代码片段了。如果您不想打开 vscode ，您可以使用[片段包预览]( https://codess.dumogu.top/manage-packets/codess-example/1.0.0/codess-preview)来模拟 vsoode 输入触发词会有什么片段提示。

codess 结构化的管理您的代码片段，方便快捷。

## 一些常用的用法

除了安装，您还可以初始化，卸载，安装本地包。

#### 初始化

```javascript
codess init
```

#### 卸载包

```javascript
codess uninstall codess-example@1.0.0
```

#### 打包

直接根据配置文件打包为 `.code-snippets` vscode 配置文件。其中有远程包的会重新下载。

```javascript
codess build
```

#### 清除已生成的 vscode 代码片段配置

清除当前项目下已生成的 vscode 代码片段配置 ./vscode/*.codess.code-snippets

```javascript
codess clear-snippets
```

#### codess 配置文件

codess 配置文件是项目根目录下的 `codess.config.json` 文件。

```json
{
    // 依赖的代码片段包列表
    "dependent": [],
    // 包安装记录，主要记录已安装包的信息
    "installRecord": {},
    // codess 官方文档
    "document": "https://codess.dumogu.top/doc"
}
```

示例：

```json
{
    "dependent": [
        {
            // 包名
            "package": "vue",
            // 包触发词
            "prefix": "v",
        },
        {
          "package": "file:snippets",// 一个本地片段包 ./snippets/
          "prefix": "my"
        }
    ],
    "installRecord": {
      "vue": {
          "home": "",
          "description": "",
          "fersion": "3",
          "iterationNumber": "1"
        }
    },
    "document": "https://codess.dumogu.top/doc"
}
```