VSCode开发提效指南(前端开发版)
共 10908字,需浏览 22分钟
·
2023-10-09 17:36
点击关注公众号,回复”登录码”
即可获取专属Dooring账号
❝作为前端开发,工作中最常使用的编辑器就是VSCode,但是你有比较深入地去发掘过VScode的各种开发配置吗?本文介绍了一些简单但是却能明显提高前端开发效率的配置&tips
❞
一、VSCode快捷键
❝Mac相比较于Window的一大优势就在于,它有着丰富的快捷键操作,仅仅依靠键盘(而不用分出手去动触控板/鼠标)就能完成很多操作,从而带来办公效率的提升。同样,对于VSCode,善用好快捷键,可以实现:「减少鼠标操作 = 节省时间 = 不会消耗耐心 = 提高效率」
❞
1.文本编辑
shift + command + k #删除当前行:
command + backspace #删除光标前所有字符
command + option + up/down #光标同时选中多行
shift + left/right/up/down #选中字符
option + 左/右键 #移动到单词最左/右侧
command + up/down #跳转到顶部、底部
option + 上/下键 #将当前代码移动到上/下一行
shift + option +up/down #复制当前行到上方/下方
command + k,然后再按下 command + J # 展开所有代码行
command + k,然后再按下 command + 0 # 折叠所有代码行
alt + z #自动换行
shift + option + F #格式化所有代码
command + K command + F #格式化选中代码
2.视图管理
command + shift + n #新建窗口
command + 1/2/3 #选中不同的拆分栏
command + b #打开、关闭侧边栏
ctrl + ~ #打开关闭控制台
3.文件相关
command + n # 新建文件
command + shift + f # 全局查找
command + p # 快速打开最近打开的文件
ctrl + r # 快速打开最近打开的文件夹/项目
4.设置相关
command + , # 打开设置面板
「如何打开setting.json文件」
command + p
,然后输入一个>
前缀,然后再输入setting.json
(或者其它设置中的选项均可),即可显示出对应的选项
顺带扩展一下,command + p
之后输入一个?
,可以显示出支持的所有操作
二、自动格式化&修复
1. formatter自动格式化
在settings.json
(工作区的或用户的皆可)中添加
{
"editor.formatOnSave": true,
}
通过设置保存时自动格式化之后,搭配上「Prettier 插件」或者「VSCode默认的语言功能」,就能够实现保存时自动根据对应的规则进行代码格式的修复。但是仅靠当前的设置, 「ESLint/StyleLint 的规则还无法在保存时自动进行修复」!
2. Lintter自动修复
不知道你是否遇到过这样的场景:
在代码中先后import了不同的对象,然后在对象下面就多了一条黄线,鼠标放上去就显示
然后你点击【快速修复】,这一行代码黄线是消失了,但你往下一看,还有一条黄线
于是你又需要精准地把光标移动到黄线上面,等待1秒,出现提示框,然后点击【快速修复】
如果只是一两个,问题还不大。但现实往往是一个文件中经常会从外部引入大量的对象。然后你不管,看着黄线难受;管吧,又浪费了大量时间做这个工作!
但实际上,通过一条VSCode配置,就可以实现一键修复所有的lint规则错误!
要让各种Lintter在保存时能够自动进行修复,需要在settings.json
中找到editor.codeActionsOnSave
这个配置项进行配置
{
"editor.codeActionsOnSave": {
"source.fixAll.stylelint": true,
"source.fixAll.eslint": true
}
}
3. 不同类型文件使用不同规则
「默认格式化程序」,可以选择VSCode自带的语言功能,或者如Prettier这样的格式化工具
首先是格式化工具的配置,这个可以编辑器,【右键】-【使用...格式化文档】-【配置默认格式化程序】进行设置
设置后同样会保存在settings.json
文件中。
「对于各种Lintter工具」,则需要到各自的配置文件中进行配置,例如:
{
"overrides": [
{
"files": [
"**/*.vue"
],
"customSyntax": "postcss-html"
},
{
"files": [
"**/*.less"
],
"customSyntax": "postcss-less"
}
],
}
三、自定义snippets
参考文章:一个案例学会 VSCode Snippets,极大提高开发效率 - 知乎 (zhihu.com)
在VSCode输入一些常用的函数名时,有时可以看到会弹出一些选项,然后选中就可以快速填充代码。效率很高。
但是这些都是VSCode默认的填充内容,如果我们想要自己定制一些可填充的代码段可以吗?答案是可以的!接下来先来看两个使用案例:
使用示例
「使用案例一」
如图,新建vue
文件后,输入一个vue
,弹出选项,选中然后自动填充预置的代码。
「使用案例二」
在vue
的SFC中的标签内部,输入try
,弹出选项,选中自动填充预置的代码段。
配置方法
打开VSCode - 【文件】 - 【首选项】 - 【配置用户代码片段】
然后,它会弹出一个窗口,让你选择配置的文件,配置范围有多种:global、project、language。(「language的使用范围有限,比如vue.json设置的,无法在vue的SFC的scipt标签内部使用」)
接着,VSCode生成了一个vue.json
文件,还给出了使用 「介绍」 和 「Example」,(相信看了这么通俗易懂的介绍,不会还有人不会用吧)
最后,保存,再切换到.vue
文件中,输入vue
,「注意:这里只有在顶层输入有效!在script
标签内输入是无法触发的!」 。所以最大的作用是用来初始化文件代码
四、推荐插件
-
koroFileHeader,自动生成代码文件头注释,函数注释
-
GitLens,强大的Git图形化工具 -
Auto Rename Tag,自动重命名配对的HTML/XML标记 -
outline-map,可视, 可互动的大纲地图,如下图
-
change-case,转换命名风格,例如从 camel
(小驼峰)转成Pascal
(大驼峰)
五、同步VSCode配置
这里提供了github和本地两种方式,推荐github(存在云端随时随地获取),登录一下github并授权,然后按照提示一步一步完成即可。
六、settings.json
settings.json
文件就是VSCode所有设置保存的地方。
-
Default Settings(JSON),「默认,全局用户共享」 -
User Settings(JSON),「当前用户」。设置面板中的(用户)设置就对应这个文件,所有的修改都在该文件中生效 -
Workspace Settings(JSON),「工作区」
分别代表了不同的影响范围。「优先级关系」:「工作区 > 用户设置 > 默认设置」,当有相同项时,前者覆盖后者
七、.editconfig
1. EditorConfig是什么
帮助开发人员在不同的编辑器和IDE之间定义和维护一致的编码样式,统一编码风格的配置文件。
EditorConfig一般以.editorconfig
文件的形式存在,并且还需要搭配插件才能在IDE(如VSCode)中使用,以下是一个文件示例
# top-most EditorConfig file
root = true
# Unix-style newlines with a newline ending every file
[*]
end_of_line = lf
insert_final_newline = true
# Matches multiple files with brace expansion notation
# Set default charset
[*.{js,py}]
charset = utf-8
# 4 space indentation
[*.py]
indent_style = space
indent_size = 4
# Tab indentation (no size specified)
[Makefile]
indent_style = tab
# Indentation override for all JS under lib directory
[lib/**.js]
indent_style = space
indent_size = 2
# Matches the exact files either package.json or .travis.yml
[{package.json,.travis.yml}]
indent_style = space
indent_size = 2
如上:
-
.editorconfig
文件顶部,必须写上root = true
(文档中是这么解释的:Set to true to stop.editorconfig
files search on current file.)
❝如果到达根文件路径或找到root=true的editorconfig文件,则将停止搜索.editorconfig文件。
❞
-
使用通配符,可以针对不同类型的文件使用不同的编辑风格(下面的内容覆盖上面) -
.editorconfig
文件的注释以#
开头,必须单独放在一行,不能放在行尾 -
.editorconfig
文件本身必须是UTF-8
编码
2. path匹配规则
3. 配置项
以下列举可以配置的项目
indent_style # 缩进风格,tab或space
indent_size # 每个缩进单位的列数,当它被设置为tab时,将使用tab_width的值(如果tab_width指定了的话)
tab_width # 一个tab制表符代表的列数,默认为indent_size的值,通常不需要指定。
trim_trailing_whitespace # 删除换行符之前(即行尾)的任何空白字符,true 或 false
insert_final_newline # 用一个空白行结束文件,true 或 false
end_of_line # 行尾用什么符号结束,lf、cr、crlf
charset # 规定文件的字符集,utf-8、utf-8-bom、utf-16be、utf-16le、latinl
root # 在文件顶部声明的属性,如果设置为true,则编辑器对EditorConfig文件的搜索到这个文件停止
-
没有在 .editorconfig
文件中配置的项,将使用IDE默认的配置 -
将指定项设置为 unset
,可以清除所有之前的.editorconfig
对它的设置,从而使用IDE默认值 -
通常一些配置项是不用指定的。比如指定了 indent_style = tab
之后,就不用再指定indent_size
这个配置了
在 EditorConfig Properties · editorconfig/editorconfig Wiki (github.com) 中还介绍了一些扩展的配置项(但是EditorConfig表示并不想标准化它们,不过可以使用),下面列举一些常用的:
quote_type # 字符串的引号类型(限于支持多种引用符号的语言),single、double、auto
curly_bracket_next_line # 左侧大括号 { 是否要另起一行,true/false
spaces_around_brackets # 大括号{}前后是否加空格,none、inside、outside、both
spaces_around_operators # 运算符前后是否加空格,true、false、hybrid
indent_brace_style # 缩进风格,K&R、Allman、GNU、Horstmann等等,具体示例见下文
「indent_brace_style」,缩进风格,下面通过示例展示不同的缩进风格
// K&R
while (x == y) {
something();
somethingelse();
}
// Allman
while (x == y)
{
something();
somethingelse();
}
// GNU
while (x == y)
{
something();
somethingelse();
}
// Horstmann
while (x == y)
{ something();
somethingelse();
}
// Lisp
while (x == y) {
something();
somethingelse(); }
4. 安装插件
VSCode必须安装插件才能解析.editorconfig
文件。
GitHub - editorconfig/editorconfig-vscode: EditorConfig extension for Visual Studio Code
5. .editorconfig和Prettier的关系
如果项目目录中同时存在 Prettier 和 .editorconfig
文件,Prettier会将.editorconfig
文件中的规则转换为相应的Prettier配置。更多细节请看:Configuration File · EditorConfig
八、.vscode目录
❝有一些项目从远程仓库clone下来之后,可以看到带了.vscode/目录,你知道这个目录是用来干什么的吗?
❞
1 .vscode目录是做什么的
存放工作区的项目配置和工具相关文件
2 setting.json
该文件用来设置项目用到的「设置」(工作区设置),该文件的设置会覆盖掉vscode编辑器的全局配置
{
"editor.defaultFormatter": "esbenp.prettier-vscode",
"editor.formatOnSave": true,
"editor.codeActionsOnSave": {
"source.fixAll": true,
"source.fixAll.eslint": true,
"source.fixAll.stylelint": true
},
"stylelint.validate": ["css", "less", "scss", "vue"]
}
3 extensions.json
该文件用来设置项目用到的「插件推荐列表」
先定义一个extensions.json文件
{
"recommendations": [
"dbaeumer.vscode-eslint",
"esbenp.prettier-vscode",
"Vue.volar"
]
}
然后到【插件】侧边栏,按下图点击,就会出现上述文件推荐的插件了,然后选择安装即可!
以上内容是笔者在开发工作中不断积累下来的,码字不易,如果这篇文章对你有所帮助的话,请赏个赞支持一下吧,你的点赞收藏就是我最大的更新动力!
如果以上内容有不对的地方,欢迎评论区指正;如果你也有好的提效tips上面没有提到的话,也欢迎在评论区分享🌹🌹