阅读 740

能让你开发效率翻倍的 15款VSCode 插件/扩展配置

VSCode 是微软开发的的一款代码编辑器,就如官网上说的一样:

VSCode 重新定义了代码编辑器

VScode 已经自带了很多丰富的功能, 如果想要更多功能?就需要装VSCode扩展. 比如: 添加新语言、主题、调试器并连接到其他服务等功能。

下面我们就来看看 15 款实用的 VScode 扩展

外观配置

VSCode 汉化工具🎈

汉化

Chinese (Simplified) Language Pack for Visual Studio Code是一款适用于 VS Code 的中文(简体)语言包插件。

安装之后一秒汉化 VS code ,再也不用担心看不懂英文😁。

VSCode 主题

One Dark Pro🎆

One-Dark-Pro-vs-plguin

umijs框架引领者-云谦老师推荐的VSCode 主题

1624956225469_66F6CF01-5B1E-47EC-9B5A-93931BA11497

可以发现,One Dark Pro主题看起来更加柔顺,更加护眼

给文件/文件夹设置图标

给文件/文件夹设置图标的扩展,可以让你的项目文件类型一目了然

推荐以下两款,任选其一:

Material Icon Theme🎇

Material-Icon-Theme-vs-plguin

安装启用后,打开VSCode的命令面板:

  • mac的快捷键是shift+command+p

在命令面板中输入Material Icon Theme并选择它,就可以设置文件及文件夹的icon了

20210629170740

vscode-icons🧨

vscode-icons-vs-plguin

安装启用后,打开VSCode的命令面板:

  • mac下的快捷键是shift+command+p

在命令面板中输入vscode-icons并选择它,就可以设置文件及文件夹的icon了

20210629095014

效果对比

20210629170132


代码风格检查

ESLint✨

eslint-vscode-plguin

ESLint 配置配合 ESLint 命令可以帮助我们找出有问题的编码模式或不符合规则的代码。

eslint-run-cli

ESLint 配置与ESLint 的 VSCode 扩展 结合使用可以自动帮助我们找出有问题的编码模式或不符合规则的代码

ESLint 配置好之后,我们接下来看看启用/禁用 ESLint 扩展的效果

禁用 ESLint 扩展的效果

禁用 ESLint 扩展时,当我们编写不符合 ESLint 规范的代码时,只有启动项目或执行 ESLint 命令才会报错:

禁用ESLint

执行 ESLint 命令`才能检查代码错误:

eslint-run-cli

启用 ESLint 扩展的效果

开启 ESLint 扩展时,当我们编写不符合 ESLint 规范的代码时,代码中会自动出现警告/报错:

启用ESLint


Prettier🎉

prettier-vscode-plugin

Prettier 是一个代码格式化的工具.某些与代码校验有关的规则(例如,语句末尾是否加分号)就可以由 Prettier 自动处理。

Prettier 的 VSCode 扩展 可以帮助我们找出有问题的编码模式或不符合规则的代码

接下来我们做一个小demo来体验一下Prettier的效果

1. 初始化项目+安装Prettier依赖

$ npm init -y

$ yarn add prettier 
复制代码

新建一个index.js并加入如下内容

const a = "a"

function test() {
  return "666"
}

const demo = data => {
  return data;
}
复制代码

新建.prettierrc.js并加入如下内容

module.exports = {
    // 超过最大值换行
    "printWidth": 100,
    // 行末是否加分号
    "semi": true,
    // 用单引号代替双引号
    "singleQuote": true,
    // tab键宽度,默认为2
    "tabWidth": 2,
    // 最后一个对象元素加逗号
    "trailingComma": "all",
    // 对象,数组加空格
    "bracketSpacing": true,
    // jsx > 是否另起一行
    "jsxBracketSameLine": false,
    // (x) => {} 是否要有小括号
    "arrowParens": "always",
    // 是否要注释来决定是否格式化代码
    "requirePragma": false,
    // 是否要换行
    "proseWrap": "preserve"
}
复制代码

2. 安装Prettier扩展

3. 修改VSCode的setting.json文件

{
    "[javascriptreact]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
    "[javascript]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
    "editor.formatOnSave": true,
}
复制代码

在上面的代码帮我们实现了以下功能

  • reactJavaScript的格式化方式都设置为prettier方式
  • 在保存时自动格式化代码

3. 格式化效果验证

最后,我们修改index.js的任意内容然后点击保存。我们可以发现代码已经被自动格式化为.prettierrc.js中要求的格式了

// 使用单引号替换双引号
const a = 'a';

function test() {
  return '666';
}
// 给箭头函数的参数加上括号
const demo = (data) => {
  return data;
};
复制代码

EditorConfig🎊

EditorConfig 有助于维护跨多个编辑器和 IDE 从事同一项目的多个开发人员的一致编码风格,团队必备神器。

在多人合作的项目中,每个人的开发习惯是不同的。以缩进来说,有的人习惯使用 space 键来进行缩进,有的人喜欢用 tab 键,有的人喜欢设置缩进为 4 个空格,有的人喜欢设置为 2 个空格。这样产生的后果就是每个人修改后的代码在格式上总是不统一的,那么提交到 git 上就会代码风格不一致,变得丑陋无比。

我们使用EditorConfig后,就可以保持统一。比如:

  • 统一代码缩进风格是space键还是tab
  • 是否删除行尾的空格
  • 设置换行符类型,值为lfcrcrlf
  • ......

注意: .editorconfig或覆盖.prettierrc.js的配置,为了避免混淆。请务必保证二者的的格式化方式一致

EditorConfig 的 VSCode 扩展 可以帮助我们找出有问题的编码模式或不符合规则的代码

接下来我们做一个小demo体验一下EditorConfig 的效果

1. 安装editorconfig 的扩展

2. 添加.editorconfig

在项目根目录添加.editorconfig并加入如下内容

# http://editorconfig.org
root = true

[*]
indent_style = tab
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.md]
trim_trailing_whitespace = false

[Makefile]
indent_style = tab

复制代码

在上面配置文件中:

  • indent_style:表示缩进风格是 tab键还是space-空格键
  • indent_size:缩进大小2
  • end_of_line:换行符lf
  • charset:字符集utf-8
  • trim_trailing_whitespace:是否删除行尾的空格
  • insert_final_newline:是否在文件的最后插入一个空行

3. 格式化效果验证

  1. 任意修改 .editorconfig文件中的indent_size 属性值。

  2. 修改项目的JS文件后保存代码,观察是否有变化

stylelint🎃

stylelint

stylelint是一个 css 规范校验工具,也支持 lesscss 预处理器。有关 stylelint 的详细讨论可以查看这篇文章

stylelint 的 VSCode 扩展 可以帮助我们找出有问题的编码模式或不符合规则的代码

接下来我们做一个小demo体验一下 stylelint 的效果

1.安装扩展

2. 项目初始化

$ npm init -y
复制代码

3. 安装依赖

yarn add stylelint stylelint-config-standard --dev
复制代码

4. 添加.stylelintrc.js文件

在项目根目录添加.stylelintrc.js文件并加入如下内容

module.exports = {
	extends: 'stylelint-config-standard',
	rules: {
		// your rules
	},
	// 忽略其他文件,只校验样式相关的文件
	ignoreFiles: [
		'node_modules/**/*',
		'public/**/*',
		'dist/**/*',
		'**/*.js',
		'**/*.jsx',
		'**/*.tsx',
		'**/*.ts',
	],
};

复制代码

5. 添加index.css

新建index.css并加入以下内容

1625541929943_01EE4654-BB47-4E7E-90EF-0821DE1F23C0

可以发现,如果样式代码不符合规范,styleint会在代码中给出提示


功能增强

Git History🎄

20210629173922

对于一些开发者习惯使用编辑器中的Git管理工具的,不太喜欢要打开另外一个Git UI工具的同学,这一款插件满足你查询所有Git记录的需求。

  • 查看和搜索git日志中的图形和详细信息。
  • 查看文件以前的副本。
  • 查看和搜索历史
  • 比较分支/提交记录/文件
  • ......

20210603110116

gitlens🎋

gitlens-vs-plguuin

Git LensVSCode 结合 Git 的使用体验优化到了极致,能让我们在不离开编辑器,不执行任何命令的情况下知晓光标所在位置代码的修改时间、作者信息等


编码效率

tabnine🎍

tabnine-vs-plguin

使用AI优化代码的自动补全功能,有了它,再也不需要其他代码提示工具了

with-and-without-tabnine-java

markdown写作

现在大部分博客平台都支持 Markdown编辑,这可以很方便直接将我们写的内容复制到多个写作平台

我们在VSCode中进行Markdown编辑当然也少不了安装一些"必备"扩展

Markdown 百宝箱🎎

markdown-all-in-one

markdown-all-in-one是在VSCode中编写Markdown 最好用的工具之一,各种快捷键,创建表格,预览,应有尽有

  • 根据标题自动生成目录
  • Markdown 转 HTML
  • 根据第一个序号,后面的序号自动生成
  • ......

20210629171218

Markdown 转 PDF 🎏

20210706112758

比如我们偶尔可以使用Markdown编写简历,写好了转换成PDF,着实非常方便

本地图片文件自动上传🎐

PicGo

Markdown写作当然少不了贴图, 但是 Markdown只支持图片地址,那么我们如何将本地的图片文件转换为远程图片地址呢?

这里推荐PicGo,它是一个用于快速上传图片并获取图片 URL 链接的工具

  • PicGo 本体支持多种图床
    • 七牛云
    • 腾讯云
    • 阿里云
    • GitHub
    • Gitee
    • ...
  • 支持上传图片后自动复制链接到剪贴板

如何使用

  1. 安装 PicGo 的 VSCode 插件插件
  2. PicGo 图床相关配置
  3. 复制(Ctrl+C)想要上传/插入的图片
  4. 进入Markdown编辑器,鼠标放在需要插入图片的位置
  5. 上传图片
    1. Windows 上传图片的快捷键``
    2. Mac 上传图片的快捷键option+command+u
  6. 如果上传成功,会自动生成图片地址

代码截图工具🎑

polacode-vscode-plguin

对于文章中的代码,有人习惯用 markdown 本身的代码片段,也有人习惯放代码截图。但是手工截图很保证尺寸统一大小,不太美观。这里推荐用插件polacode。它是一款可以自动将代码转换为图片的 VSCode 扩展

  • 支持整个文件代码转为图片
  • 支持鼠标选中部分代码转换为图片
  • 支持为图片添加阴影或背景

使用方式也非常简单。安装启用后,打开VSCode的命令面板:

  • mac下的快捷键是shift+command+p

在命令面板中输入polacode并选择它,就可以开始截图了

polacode-vscode-plguin-usage

可以把代码保存为统一大小的图片,然后结合PicGo扩展,自动将图片地址插入到markdown文章中。

VSCode的自动同步功能

如果你有多台电脑,想在不同电脑之间同步 VSCode 配置,但是又不需要安装额外的扩展插件,就用它吧。

“VSCode”左下角->“设置同步”->"登录需要同步的账户"->"立即同步"即可

最后

文章浅陋,欢迎各位看官评论区留下的你的见解!

觉得有收获的同学欢迎点赞,关注一波!

good

往期好文

文章分类
前端
文章标签