前端vue实战项目结构、常用编辑器vs code 配置

• 5.Complete JSDoc Tags

• 6.Custom CSS and JS Loader

• 7.Debugger for Chrome

• 8.EditorConfig for VS Code

• 9.ESLint ☆☆☆

• 10.gitignore

• 11.GitLens — Git supercharged

• 12.npm

• 13.PostCSS syntax !important

• 14.Vetur ☆

• 15.vscode-icons

• 16.vue-i18n

• 17.Markdown All in One

• 配置文件

• • 1.用户代码片段配置

• 2.settings.json配置实现自动格式化代码

• 二、 vue项目目录结构(基于vue-cli3搭建)

• • 1.assets

• 2.components

• 3.mixins

• 4.router

• 5.views

• 6.error-log.js错误日志

• 7.tools

• 8.webpack配置文件

一、vs code常用插件及配置文件（按字母排序）

=======================================================================================

1.Axios Snippets

---

超好用的 axios 代码补全片段，支持在.vue.js.html.ts文件中使用

这个插件方便代码vue js html ts及es6语法的补全

2.Beautify ☆☆

---

3.Better Comments

---

4.Chinese (Simplified) Language中文 ☆☆☆

---

安装后，在 locale.json 中添加 “locale”: “zh-cn”，即可载入中文（简体）语言包。要修改 locale.json，你可以同时按下 Ctrl+Shift+P 打开命令面板，之后输入 “config” 筛选可用命令列表，最后选择配置语言命令。请参阅文档并获取更多信息。

5.Complete JSDoc Tags

---

6.Custom CSS and JS Loader

---

7.Debugger for Chrome

---

支持谷歌在线调式，配置文件如下：

{

// 使用 IntelliSense 了解相关属性。

// 悬停以查看现有属性的描述。

// 欲了解更多信息，请访问: https://go.microsoft.com/fwlink/?linkid=830387

“version”: “0.2.0”,

“configurations”: [

{

“type”: “chrome”,

“request”: “launch”,

“name”: “Launch Chrome against localhost”,

“url”: “http://localhost:8080”,

“webRoot”: “${workspaceFolder}/src”

}

]

}

8.EditorConfig for VS Code

---

在项目根目录下配置这样一个文件

如下：

root = true

[*]

charset = utf-8

indent_style = space

indent_size = 2

end_of_line = lf

insert_final_newline = true

trim_trailing_whitespace = true

9.ESLint ☆☆☆

---

安装好插件后修改set.json配置文件实现自动监听vue、html、js文件是否满足.eslintrc.js文件里rules的规则，可以自定项目的代码规范。

set.json配置如下：

{

“files.autoSave”: “off”,

//eslint 代码自动检查相关配置

“eslint.autoFixOnSave”: true,

“eslint.validate”: [

“javascriptreact”,

“javascript”,

{

“language”: “vue”,

“autoFix”: true

},

“html”

]

}

.eslintrc.js及相关rules常用的配置解释如下：

module.exports = {

root: true,

parserOptions: {

parser: ‘babel-eslint’,

sourceType: ‘module’

},

env: {

browser: true,

node: true,

es6: true,

mocha: true

},

extends: [

// https://github.com/vuejs/eslint-plugin-vue#priority-a-essential-error-prevention

// consider switching to plugin:vue/strongly-recommended or plugin:vue/recommended for stricter rules.

‘plugin:vue/essential’,

// https://github.com/standard/standard/blob/master/docs/RULES-en.md

‘standard’

],

plugins: [

‘vue’

],

rules: { // 参考https://eslint.org/docs/rules

‘no-console’: process.env.NODE_ENV === ‘production’ ? ‘error’: ‘off’, //禁止使用console

‘no-debugger’: process.env.NODE_ENV === ‘production’ ? ‘error’ : ‘off’, // allow debugger during development

“no-alert”: process.env.NODE_ENV === ‘production’ ? ‘error’ : ‘off’,//禁止使用alert confirm prompt

“no-array-constructor”: 2,//禁止使用数组构造器

“no-bitwise”: 0,//禁止使用按位运算符

“no-caller”: 1,//禁止使用arguments.caller或arguments.callee

“no-catch-shadow”: 2,//禁止catch子句参数与外部作用域变量同名

“no-class-assign”: 2,//禁止给类赋值

“no-cond-assign”: 2,//禁止在条件表达式中使用赋值语句

“no-const-assign”: 2,//禁止修改const声明的变量

“no-constant-condition”: 2,//禁止在条件中使用常量表达式 if(true) if(1)

“no-continue”: 0,//禁止使用continue

“no-control-regex”: 2,//禁止在正则表达式中使用控制字符

“no-delete-var”: 2,//不能对var声明的变量使用delete操作符

“no-div-regex”: 1,//不能使用看起来像除法的正则表达式/=foo/

“no-dupe-keys”: 2,//在创建对象字面量时不允许键重复 {a:1,a:1}

“no-dupe-args”: 2,//函数参数不能重复

“no-duplicate-case”: 2,//switch中的case标签不能重复

“no-else-return”: 2,//如果if语句里面有return,后面不能跟else语句

“no-empty”: 2,//块语句中的内容不能为空

“no-empty-character-class”: 2,//正则表达式中的[]内容不能为空

“no-eq-null”: 0,//禁止对null使用==或!=运算符

“no-eval”: 1,//禁止使用eval

“no-ex-assign”: 2,//禁止给catch语句中的异常参数赋值

“no-extend-native”: 2,//禁止扩展native对象

“no-extra-bind”: 2,//禁止不必要的函数绑定

“no-extra-boolean-cast”: 2,//禁止不必要的bool转换

“no-extra-parens”: 2,//禁止非必要的括号

“no-extra-semi”: 2,//禁止多余的冒号

“no-fallthrough”: 1,//禁止switch穿透

“no-floating-decimal”: 2,//禁止省略浮点数中的0 .5 3.

“no-func-assign”: 2,//禁止重复的函数声明

“no-implicit-coercion”: 1,//禁止隐式转换

“no-implied-eval”: 2,//禁止使用隐式eval

“no-inline-comments”: 0,//禁止行内备注

“no-inner-declarations”: [2, “functions”],//禁止在块语句中使用声明（变量或函数）

“no-invalid-regexp”: 2,//禁止无效的正则表达式

“no-invalid-this”: 2,//禁止无效的this，只能用在构造器，类，对象字面量

“no-irregular-whitespace”: 2,//不能有不规则的空格

“no-iterator”: 2,//禁止使用__iterator__ 属性

“no-label-var”: 2,//label名不能与var声明的变量名相同

“no-labels”: 2,//禁止标签声明

“no-lone-blocks”: 2,//禁止不必要的嵌套块

“no-lonely-if”: 2,//禁止else语句内只有if语句

“no-loop-func”: 1,//禁止在循环中使用函数（如果没有引用外部变量不形成闭包就可以）

“no-mixed-requires”: [0, false],//声明时不能混用声明类型

“no-mixed-spaces-and-tabs”: [2, false],//禁止混用tab和空格

“linebreak-style”: [0, “windows”],//换行风格

“no-multi-spaces”: 1,//不能用多余的空格

“no-multi-str”: 2,//字符串不能用\换行

“no-multiple-empty-lines”: [1, {“max”: 2}],//空行最多不能超过2行

“no-native-reassign”: 2,//不能重写native对象

“no-negated-in-lhs”: 2,//in 操作符的左边不能有!

“no-nested-ternary”: 0,//禁止使用嵌套的三目运算

“no-new”: 1,//禁止在使用new构造一个实例后不赋值

“no-new-func”: 1,//禁止使用new Function

“no-new-object”: 2,//禁止使用new Object()

“no-new-require”: 2,//禁止使用new require

“no-new-wrappers”: 2,//禁止使用new创建包装实例，new String new Boolean new Number

“no-obj-calls”: 2,//不能调用内置的全局对象，比如Math() JSON()

“no-octal”: 2,//禁止使用八进制数字

“no-octal-escape”: 2,//禁止使用八进制转义序列

“no-param-reassign”: 2,//禁止给参数重新赋值

“no-path-concat”: 0,//node中不能使用__dirname或__filename做路径拼接

“no-plusplus”: 0,//禁止使用++，–

“no-process-env”: 0,//禁止使用process.env

“no-process-exit”: 0,//禁止使用process.exit()

“no-proto”: 2,//禁止使用__proto__属性

“no-redeclare”: 2,//禁止重复声明变量

“no-regex-spaces”: 2,//禁止在正则表达式字面量中使用多个空格 /foo bar/

“no-restricted-modules”: 0,//如果禁用了指定模块，使用就会报错

“no-return-assign”: 1,//return 语句中不能有赋值表达式

“no-script-url”: 0,//禁止使用javascript:void(0)

“no-self-compare”: 2,//不能比较自身

“no-sequences”: 0,//禁止使用逗号运算符

“no-shadow”: 2,//外部作用域中的变量不能与它所包含的作用域中的变量或参数同名

“no-shadow-restricted-names”: 2,//严格模式中规定的限制标识符不能作为声明时的变量名使用

“no-spaced-func”: 2,//函数调用时 函数名与()之间不能有空格

“no-sparse-arrays”: 2,//禁止稀疏数组， [1,2]

“no-sync”: 0,//nodejs 禁止同步方法

“no-ternary”: 0,//禁止使用三目运算符

“no-trailing-spaces”: 1,//一行结束后面不要有空格

“no-this-before-super”: 0,//在调用super()之前不能使用this或super

“no-throw-literal”: 2,//禁止抛出字面量错误 throw “error”;

“no-undef”: 2,//不能有未定义的变量

“no-undef-init”: 2,//变量初始化时不能直接给它赋值为undefined

“no-undefined”: 0,//不能使用undefined

“no-unexpected-multiline”: 2,//避免多行表达式

“no-underscore-dangle”: 1,//标识符不能以_开头或结尾

“no-unneeded-ternary”: 0,//禁止不必要的嵌套 var isYes = answer === 1 ? true : false;

“no-unreachable”: 2,//不能有无法执行的代码

“no-unused-expressions”: 0,//禁止无用的表达式

“no-unused-vars”: [2, {“vars”: “all”, “args”: “after-used”}],//不能有声明后未被使用的变量或参数

“no-use-before-define”: 2,//未定义前不能使用

“no-useless-call”: 2,//禁止不必要的call和apply

“no-void”: 2,//禁用void操作符

“no-var”: 0,//禁用var，用let和const代替

“no-warning-comments”: [1, { “terms”: [“todo”, “fixme”, “xxx”], “location”: “start” }],//不能有警告备注

“no-with”: 2,//禁用with

“array-bracket-spacing”: [2, “never”],//是否允许非空数组里面有多余的空格

“arrow-parens”: 0,//箭头函数用小括号括起来

“arrow-spacing”: [2,{‘before’:true,‘after’:true}],//=>的前/后括号

“accessor-pairs”: 0,//在对象中使用getter/setter

“block-scoped-var”: 0,//块语句中使用var

“brace-style”: [1, “1tbs”],//大括号风格

“callback-return”: 1,//避免多次调用回调什么的

“camelcase”: 0,//强制驼峰法命名

“comma-dangle”: [2, “never”],//对象字面量项尾不能有逗号

“comma-spacing”: [2,{‘before’: false, “after”:true}],//逗号前后的空格

“comma-style”: [2, “last”],//逗号风格，换行时在行首还是行尾

“complexity”: [0, 11],//循环复杂度

“computed-property-spacing”: 2,//是否允许计算后的键名什么的

“consistent-return”: 0,//return 后面是否允许省略

“consistent-this”: [2, “that”],//this别名

“constructor-super”: 0,//非派生类不能调用super，派生类必须调用super

“curly”: [2, “all”],//必须使用 if(){} 中的{}

“default-case”: 2,//switch语句最后必须有default

“dot-location”: 0,//对象访问符的位置，换行的时候在行首还是行尾

“dot-notation”: [0, { “allowKeywords”: true }],//避免不必要的方括号

“eol-last”: 0,//文件以单一的换行符结束

“eqeqeq”: 2,//必须使用全等

“func-names”: 0,//函数表达式必须有名字

“func-style”: [0, “declaration”],//函数风格，规定只能使用函数声明/函数表达式

“generator-star-spacing”: [2,{‘before’: true, “after”:false}],//生成器函数*的前后空格

“guard-for-in”: 0,//for in循环要用if语句过滤

“handle-callback-err”: 0,//nodejs 处理错误

“id-length”: 0,//变量名长度

“indent”: [2, 2],//缩进风格

“init-declarations”: 0,//声明时必须赋初值

“key-spacing”: [2, { “beforeColon”: false, “afterColon”: true }],//对象字面量中冒号的前后空格

“lines-around-comment”: 0,//行前/行后备注

“max-depth”: [0, 4],//嵌套块深度

“max-len”: [0, 80, 4],//字符串最大长度

“max-nested-callbacks”: [0, 2],//回调嵌套深度

“max-params”: [0, 3],//函数最多只能有3个参数

“max-statements”: [0, 10],//函数内最多有几个声明

“new-cap”: 2,//函数名首行大写必须使用new方式调用，首行小写必须用不带new方式调用

“new-parens”: 2,//new时必须加小括号

“newline-after-var”: 0,//变量声明后是否需要空一行

“object-curly-spacing”: [0, “never”],//大括号内是否允许不必要的空格

“object-shorthand”: 0,//强制对象字面量缩写语法

“one-var”: 1,//连续声明

“operator-assignment”: [0, “always”],//赋值运算符 += -=什么的

“operator-linebreak”: [2, “after”],//换行时运算符在行尾还是行首

“padded-blocks”: 0,//块语句内行首行尾是否要空行

“prefer-const”: 0,//首选const

“prefer-spread”: 0,//首选展开运算

“prefer-reflect”: 0,//首选Reflect的方法

“quotes”: 0, //禁止引号 ‘’ “” ``

“jsx-quotes”: 0, //禁止jsx引号

“quote-props”: 0,//对象字面量中的属性名是否强制双引号

“radix”: 2,//parseInt必须指定第二个参数

“id-match”: 0,//命名检测

“require-yield”: 0,//生成器函数必须有yield

“semi”: 0,//语句强制分号结尾

“semi-spacing”: 0,//分号前后空格

“sort-vars”: 0,//变量声明时排序

“space-after-keywords”: [0, “always”],//关键字后面是否要空一格

“space-before-blocks”: [2, “always”],//不以新行开始的块{前面要不要有空格

“space-before-function-paren”: [2, “never”],//函数定义时括号前面要不要有空格

“space-in-parens”: [2, “never”],//小括号里面要不要有空格

“space-infix-ops”: 2,//中缀操作符周围要不要有空格

“space-unary-ops”: [2, { “words”: true, “nonwords”: false }],//一元运算符的前/后要不要加空格

“spaced-comment”: 2,//注释风格要不要有空格什么的

“strict”: 2,//使用严格模式

“use-isnan”: 2,//禁止比较时使用NaN，只能用isNaN()

“valid-jsdoc”: 0,//jsdoc规则

“valid-typeof”: 2,//必须使用合法的typeof的值

“vars-on-top”: 2,//var必须放在作用域顶部

“wrap-iife”: [2, “inside”],//立即执行函数表达式的小括号风格

“wrap-regex”: 0,//正则表达式字面量用小括号包起来

“yoda”: [2, “never”]//禁止尤达条件

}

}

10.gitignore

---

11.GitLens — Git supercharged

---

12.npm

---

13.PostCSS syntax !important

---

在项目根目录配置如下文件

代码如下：

module.exports = {

plugins: {

“postcss-partial-import”: {},

precss: {},

“postcss-advanced-variables”: {},

autoprefixer: {}

}

}

14.Vetur ☆

---

.vue文件中标签js的亮高

15.vscode-icons

---

配置文件类型的图标

16.vue-i18n

---

这个插件能够帮到你方便查看和编写 vue-i18n

17.Markdown All in One

---

附加vs code插件安装市场 链接

配置文件

---

1.用户代码片段配置

方便模块化开发节约编辑代码时间，例如vue指令配置模板

{

// Place your 全局 snippets here. Each snippet is defined under a snippet name and has a scope, prefix, body and

// description. Add comma separated ids of the languages where the snippet is applicable in the scope field. If scope

// is left empty or omitted, the snippet gets applied to all languages. The prefix is what is

// used to trigger the snippet and the body will be expanded and inserted. Possible variables are:

// $1, $2 for tab stops, $0 for the final cursor position, and ${1:label}, ${2:another} for placeholders.

// Placeholders with the same ids are connected.

// Example:

“Print to console”: {

// “scope”: “javascript,typescript”,

“prefix”: “vue”,

“body”: [

“”,

" <div class=“$0”>$0",

“”,

“”,

“

“import ViewMixin from “@/mixins/view-mixins.js””,

“export default {”,

" name: “$0”,",

" mixins: [ViewMixin()],",

" components: {",

" },",

" data() {",

" return {",

" }",

" },",

" watch: {",

" },",

" computed: {",

" },",

" mounted() {",

" },",

" methods: {",

" },",

" destroyed() {",

" }",

“}”,

“”,

“<style lang=“postcss” scoped>”,

“”

],

“description”: “vue template order”

}

}

2.settings.json配置实现自动格式化代码

{

“editor.suggestSelection”: “first”,

“vsintellicode.modify.editor.suggestSelection”: “automaticallyOverrodeDefaultValue”,

“gitlens.advanced.messages”: {

“suppressGitVersionWarning”: true

},

“files.autoSave”: “off”,

“files.associations”: {

“*.css”: “postcss”

},

“eslint.autoFixOnSave”: true,

“eslint.validate”: [

“javascript”,

“javascriptreact”,

“html”,

{

“language”: “vue”,

“autoFix”: true

}

],

“editor.tabSize”: 2,

“terminal.integrated.rendererType”: “dom”,

“emmet.includeLanguages”: {

“postcss”: “css”

},

“[javascript]”: {

“editor.defaultFormatter”: “HookyQR.beautify”

},

“editor.codeActionsOnSave”: {

“source.fixAll.eslint”: true

},

“terminal.integrated.shell.windows”: “C:\Program Files\Git\bin\bash.exe”,

“eslint.codeAction.disableRuleComment”: {

}

// “workbench.iconTheme”: “vscode-icons”

// “workbench.colorTheme”: “SynthWave '84”

// “workbench.iconTheme”: “material-icon-theme”,

// “workbench.colorTheme”: “Material Theme”

}

二、 vue项目目录结构(基于vue-cli3搭建)

========================================================================================

项目结构如下：

1.assets

---

assets静态文件,/style公用的样式文件夹，像reset.css、normalize.css、element-ui.css、common.css、variable.css、default.css、index.css。/imge存放公用图片icon。/js公用的js插件

2.components

---

存放公用组件

3.mixins

---

存放混合于vue实例的全局方法，或在钩子执行统一的方法，一般设计开发人员用不上

4.router

---

结构如下：

routes.js存放路由的路由元信息结构

import DragColumn from ‘@/views/drag-column’

/**

• hidden:false 是否在菜单中显示

• meta: {

• requireAuth, 是否需要登录授权

• title  标题
  

• }

• **/

const routes = [

{

path: ‘/drag-column’,

component: DragColumn,

name: “DragColumn”,

meta: {

requireAuth: false,

title: ‘drag-column’

}

}

]

export default routes

guards存放路由钩子、路由守卫

export default permissionGuards = (to,from,next)=>{

if(to.matched.some()){

return MutationRecord.mete.requireAuth

}

return false

5.views

---

存放单页面应用中具体的每个组件页面，和router.js相对应

6.error-log.js错误日志

---

import Vue from ‘vue’;

if (process.env.NODE_ENV === ‘production’) {

Vue.config.errorHandler = (err, vm, info, a) => {

Vue.nextTick(() => {

vm

a

console.log(err, info);

});

};

}

7.tools

---

工具类文件夹，提供了连个快捷建立组件的方法,可在控制台输入：npm run new:comp 或 npm run new:view

代码如下：

const chalk = require(‘chalk’)

const path = require(‘path’)

const fs = require(‘fs’)

const resolveDir = (…file) => path.resolve(__dirname, …file)

// eslint-disable-next-line no-console

const log = message => console.log(chalk.green(${message}))

// eslint-disable-next-line no-console

const successLog = message => console.log(chalk.blue(${message}))

// eslint-disable-next-line no-console

const errorLog = error => console.log(chalk.red(${error}))

const {componentTemplate} = require(‘./template.js’)

const generateFile = (dir, data) => {

if (fs.existsSync(dir)) {

errorLog(${dir}文件已存在)

return

}

return new Promise((resolve, reject) => {

fs.writeFile(dir, data, ‘utf8’, err => {

if (err) {

errorLog(err.message)

reject(err)

} else {

resolve(true)

}

})

})

}

function mkdirs(directory, callback) {

let exists = fs.existsSync(directory)

if (exists) {

callback()

} else {

mkdirs(path.dirname(directory), () => {

fs.mkdirSync(directory)

callback()

})

最后

7.tools

---

工具类文件夹，提供了连个快捷建立组件的方法,可在控制台输入：npm run new:comp 或 npm run new:view

代码如下：

const chalk = require(‘chalk’)

const path = require(‘path’)

const fs = require(‘fs’)

const resolveDir = (…file) => path.resolve(__dirname, …file)

// eslint-disable-next-line no-console

const log = message => console.log(chalk.green(${message}))

// eslint-disable-next-line no-console

const successLog = message => console.log(chalk.blue(${message}))

// eslint-disable-next-line no-console

const errorLog = error => console.log(chalk.red(${error}))

const {componentTemplate} = require(‘./template.js’)

const generateFile = (dir, data) => {

if (fs.existsSync(dir)) {

errorLog(${dir}文件已存在)

return

}

return new Promise((resolve, reject) => {

fs.writeFile(dir, data, ‘utf8’, err => {

if (err) {

errorLog(err.message)

reject(err)

} else {

resolve(true)

}

})

})

}

function mkdirs(directory, callback) {

let exists = fs.existsSync(directory)

if (exists) {

callback()

} else {

mkdirs(path.dirname(directory), () => {

fs.mkdirSync(directory)

callback()

})

最后