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


最后


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


相关链接




相关文章
|
JavaScript 前端开发 Java
npm学习一:npm 包管理工具 学习、使用。
这篇文章介绍了npm的基础知识和常用命令,包括安装包、查看包信息、管理依赖等操作,并提供了如何删除npm安装的镜像以及如何彻底删除node_modules文件夹的具体步骤。
352 2
|
11月前
|
存储 JavaScript 前端开发
在NodeJS中使用npm包进行JS代码的混淆加密
总的来说,使用“javascript-obfuscator”包可以帮助我们在Node.js中轻松地混淆JavaScript代码。通过合理的配置,我们可以使混淆后的代码更难以理解,从而提高代码的保密性。
1087 9
|
12月前
|
开发工具 git
vscode推送项目到github仓库故障解决1
本文介绍了如何优雅解决本地仓库与远程仓库历史记录不一致的问题,并提供避免未来问题的最佳实践。核心在于理解问题根源(如历史记录差异和常见原因),采用推荐的解决方案(先本地初始化再关联远程仓库),并遵循一致的工作流程、团队协作规范及熟悉 Git 命令。通过强制推送或合并无关历史记录等方式处理现有冲突,同时养成良好习惯以预防类似问题。
|
网络协议 Linux 网络安全
docker centos镜像 npm安装包时报错“npm ERR! code ECONNRESET”
通过上述步骤,您可以有效解决在 Docker 中使用 CentOS 镜像安装 npm 包时遇到的 "npm ERR! code ECONNRESET" 错误。希望这些方法能帮助您顺利进行 npm 包的安装。
922 26
|
JavaScript
nodejs安装之npm ERR! code CERT_HAS_EXPIREDnpm ERR! errno CERT_HAS_EXPIRED reason: certificate has expired-证书错误通用问题解决方案-优雅草央千澈
nodejs安装之npm ERR! code CERT_HAS_EXPIREDnpm ERR! errno CERT_HAS_EXPIRED reason: certificate has expired-证书错误通用问题解决方案-优雅草央千澈
3051 27
|
Linux Go iOS开发
怎么禁用 vscode 中点击 go 包名时自动打开浏览器跳转到 pkg.go.dev
本文介绍了如何在 VSCode 中禁用点击 Go 包名时自动打开浏览器跳转到 pkg.go.dev 的功能。通过将 gopls 的 `ui.navigation.importShortcut` 设置为 "Definition",可以实现仅跳转到定义处而不打开链接。具体操作步骤包括:打开设置、搜索 gopls、编辑 settings.json 文件并保存更改,最后重启 VSCode 使设置生效。
683 9
怎么禁用 vscode 中点击 go 包名时自动打开浏览器跳转到 pkg.go.dev
|
存储 资源调度 JavaScript
npm、cnpm 和 pnpm 是三种常用的 Node.js 包管理工具
npm、cnpm 和 pnpm 是三种常用的 Node.js 包管理工具。npm 是官方默认的包管理器,提供依赖管理、安装和更新等功能;cnpm 是由阿里巴巴开发的 npm 镜像,专为中国大陆用户优化,解决下载速度慢的问题;pnpm 通过硬链接技术提高安装速度并节省磁盘空间,特别适合磁盘资源紧张的环境。三者命令类似,但各有特色,开发者可根据需求选择合适的工具。
1668 5
|
JavaScript 前端开发 Java
npm学习一:npm 包管理工具 学习、使用。
这篇文章是关于npm包管理工具的学习、使用指南,包括npm概述、基础命令和如何安装webpack。
529 3
npm学习一:npm 包管理工具 学习、使用。
|
前端开发 JavaScript 数据库
VSCode编程助手工程能力体验报告(一):通义灵码 - 帮你高效切入新项目、编码和提升质量
我是一位软件工程师,用通义灵码个人版vscode插件的workspace做项目分析和复盘,对比之前没有灵码,现在提效了80%,本文介绍了具体的使用流程。
4321 3
|
Ubuntu Linux 编译器
Linux/Ubuntu下使用VS Code配置C/C++项目环境调用OpenCV
通过以上步骤,您已经成功在Ubuntu系统下的VS Code中配置了C/C++项目环境,并能够调用OpenCV库进行开发。请确保每一步都按照您的系统实际情况进行适当调整。
2823 3

热门文章

最新文章

推荐镜像

更多
  • NPM