VS Code项目中通过npm包的方式共享代码片段的方案实现

简介: 上周在 “VS Code项目中共享自定义的代码片段方案” 的文章中提到过一个共享代码片段的方案,上周经过调研后并没有发现现成的插件,就抽了点空实现了这个方案,最终产出Share Snippets 这个插件去实现这个设想

Share Snippets介绍


借助Share Snippets,你可以通过npm包的形式分享你的代码片段,让其它的开发者能够轻松愉快的体验上,更新迭代方便


方案对比


项目级共享代码片段


方案 学习成本 传播能力 生效方式 缺点
在.vscode目录编写片段规则 项目中编写后直接生效 不方便传播,更换项目需要重新C/V
开发snippets插件 安装对应的插件在VS Code中 更换设备需要重新安装相关的插件
通过npm包 使用npm install package 即可


特点


借助Share Snippet无需你开发Snippet插件,就能轻松的让其它人使用你的代码片段

代码片段的规则完全参照VS Code官方文档的自定义代码片段规则


特点总结


  • 容易传播
  • 引入方便
  • 升级更新方便
  • 学习成本极低
  • 。。。


demo.code-snippets


{
  "Print Text": {
    "scope":"javascript,typescript,vue,react",
    "prefix": "lg",
    "body": "console.log($1)",
    "description": "console.log"
  }
}


tips:四个属性都为必填值才能生效


注意


  1. 插件会在VS Code启动的时候进行一次文件的扫描
  2. 可以通过命令输入Refresh进行重新扫描
  3. 插件只会扫描share_snippets目录下以.code-snippets结尾的文件
  4. 无论目录层级多深只要是在share_snippets目录下以.code-snippets结尾的文件都能被扫描到并在项目中启用


比如


node_modules
└── package1Name
│   └──share_snippets
│       ├── comment
│       │   └── test1.code-snippets
│       └── test2.code-snippets
└── package2Name
    └──share_snippets
        ├── comment
        │   └── test1.code-snippets
        └── test2.code-snippets
share_snippets
    ├── comment
    │   └── test1.code-snippets
    └── vue
        └── test2.code-snippets


指令


首先需要按F1打开命令输入框


指令名称 作用
Refresh 重新扫描项目中的片段文件


未来


  • 优化重新扫描项目代码片段的指令
  • 加入可配置文件,优化片段代码中冗余的scope内容
  • 片段内容body支持指定的文件(即将指定的文件内容作为片段的内容)


npm 包开发示例


非常简单,和直接编写官方.code-snippets文件一模一样


share-snippets-demo



可以clone或者fork项目,然后编写自己的代码片段,发布到NPM


最后


希望此插件能够帮助你提高编码的体验与效率,提升编码的幸福感😊,使用途中有任何问题,请直接与我联系


相关链接




相关文章
|
2月前
|
网络安全 计算机视觉
【node】 npm install 报错:code 128
【node】 npm install 报错:code 128
64 1
|
2月前
|
JavaScript Linux 数据安全/隐私保护
node内网安装npm私服以及依赖包上传发布verdaccio
node内网安装npm私服以及依赖包上传发布verdaccio
226 1
|
2月前
设置VSCode运行任务命令快捷键Alt+R,通常用于npm start(对频繁使用该命令可节省50%的输入命令行打字时间)
设置VSCode运行任务命令快捷键Alt+R,通常用于npm start(对频繁使用该命令可节省50%的输入命令行打字时间)
|
4天前
npm ERR! code ERESOLVEnpm ERR! ERESOLVE could not resolvenpm ERR!-解决
npm ERR! code ERESOLVEnpm ERR! ERESOLVE could not resolvenpm ERR!-解决
12 3
|
5天前
npm构建vite项目
npm构建vite项目
7 2
|
5天前
使用npm构建vite+vue+ts项目的两种方式
使用npm构建vite+vue+ts项目的两种方式
9 0
使用npm构建vite+vue+ts项目的两种方式
|
2月前
|
前端开发 JavaScript 数据安全/隐私保护
从0到1开发一个自己的npm包完整过程
创建自己的 npm 包涉及六个步骤:1) 注册 npm 账号;2) 使用 `npm init` 初始化项目,确保 package.json 的 name 唯一且 private 为 false;3) 开发项目,可封装 UI 组件、函数库或命令行工具;4) 本地调试,通过 `npm link` 在项目中测试;5) `npm login` 登录账号,可能需切换至官方仓库;6) 使用 `npm publish` 发布项目。注意版本号递增,无意义的包不建议发布。
40 2
从0到1开发一个自己的npm包完整过程
|
2月前
|
JSON 小程序 前端开发
小程序中使用npm安装vant组件实现按需引入减少代码包大小,避免触发用户隐私协议
微信小程序按需引入 vant 组件,自动清除项目中未使用的 vant 组件,减少代码包大小,避免因未使用到的 vant 组件触发隐私协议提交审核时被拒
39 1
小程序中使用npm安装vant组件实现按需引入减少代码包大小,避免触发用户隐私协议
|
16天前
|
安全 JavaScript 前端开发
怎么发布npm包?
该文介绍了如何在JavaScript环境中发布npm包的步骤。首先,确保npm客户端配置使用官方源,以避免安全和兼容性问题。接着,登录npm账号。然后,检查`package.json`文件,其中包的`name`应唯一,版本号遵循语义化版本控制。更新版本号后,使用`npm publish`发布包。最后,通过在新环境中全局安装并测试包来验证发布是否成功
|
2月前
使用npm install时遇到问题:npm ERR! code ERESOLVE
使用npm install时遇到问题:npm ERR! code ERESOLVE

推荐镜像

更多