csnp,更快的生成自己的 VS Code 代码片段

283 阅读1分钟

介绍

csnp 是一个由 typescript 编写的 node 脚本,

基于 VS Code 内置「自定义代码片段」的功能(官方文档介绍)

给予开发者可以快速和方便地创建 VS Code 代码片段的能力。

使用场景

日常编码中,常常会遇到需要调试代码的场景,通常最简单的方式就是使用「打印」方法,

例如在 js 文件中,我需要通过键入指令「-log + 回车」生成代码 console.log('-> log', _)_ 为光标所处位置)。

在 VS Code 的 .code-snippets 后缀文件中,

  • 指令 -log 代表一个 prefix

  • 代码片段 console.log('-> log', _) 代表一个 body

通过 csnp 指令可以快速生成 log.csnp 文件,.csnp 可将「prefix + body」通过 markdown 语法进行管理,.csnp 文件会生成在项目的根路径下。

.vscode/.csnp/js/log.csnp

此处的 js 在 csnp 中代表一个代码片段的类型,既 csnp type。

快速上手

# 1. 全局安装
$ npm i -g csnp

# 2. 初始化 csnp 文件
$ csnp

# 3. 打开 csnp 文件,编辑属于自己的代码片段

# 4. 生成 code snipepts
$ csnp push

.csnp 文件

---
name: Log
prefix: '-log'
description: log sth
---
console.log('-> log', $1)

log.csnp 通过执行 csnp push 命令转换为 js.code-snippets 文件后,即可使用指令 -log

.code-snippets 文件

js.code-snippets 文件是一段 json,VS Code 会自动解析此后缀的文件。

{
  "Log": {
    "prefix": "-log",
    "body": [
      "console.log($1)"
    ],
    "description": "log sth"
  }
}

Github 链接

如果觉得好用的话,想要一个 star ⭐️ ~ QaQ 3q。