命名
驼峰式命名法介绍
-
Pascal Case 大驼峰式命名法:首字母大写。eg:StudentInfo、UserInfo、ProductInfo
-
Camel Case 小驼峰式命名法:首字母小写。eg:studentInfo、userInfo、productInfo
文件资源命名
-
文件名不得含有空格
-
文件名建议只使用小写字母,不使用大写字母。( 例:user )
-
文件名包含多个单词时,单词之间建议使用半角的连词线 ( - ) 分隔。( 例:user-manage )
-
引入资源使用相对路径,不要指定资源所带的具体协议 ( http:,https: ) ,除非这两者协议都不可用。
【不推荐:
<script src="http://cdn.com/foundation.min.js"></script>
【 推荐
<script src="//cdn.com/foundation.min.js"></script>
】
常量(const)
- 命名方法 : 全部大写
- 命名规范 : 使用大写字母和下划线来组合命名,下划线用以分割单词。
【 例:
var MAX_COUNT = 10;
var URL = "http://www.baidu.com"
】
class、id命名
- class 以小写形式命名,多个单词以中横线 ’ - ’ 连接
- id 以大写形式命名,多个单词首字母大写,以中横线 ’ - ’ 连接
<!-- class命名方式 -->
<div class="side"></div>
<div class="left-content"></div>
<!-- id命名方式 -->
<div id="Side"></div>
<div id="Left-Content"></div>
方法(function)
- 命名方式 : 小驼峰方式 ( 构造函数使用大驼峰命名法 )
- 命名规则 : 前缀为动词
//获取姓名
function getName{
return this.name
}
vue文件命名
- 命名方式 : 小驼峰方式
- 命名规则 : 前缀为动词/名词
components/
|- baseButton.vue
|- baseTable.vue
|- baseIcon.vue
components/
|- appButton.vue
|- appTable.vue
|- appIcon.vue
Project Manage相关配置
[{
"name": "vertical-industries",
"rootPath": "D:\\vertical-industries",
"paths": [],
"group": "",
"enabled": true
},
{
"name": "vertical-cms",
"rootPath": "D:\\vertical-cms",
"paths": [],
"group": "",
"enabled": true
}]
VScode编辑器相关配置
- 首先安装Settings Sync插件
- 然后进入到
C:\Users\mayn\AppData\Roaming\Code\User
目录下找到syncLocalSettings.json文件
【找不到就在我的电脑里搜索syncLocalSettings.json这个文件】,将里面的"token"赋值成为以下字符串
"token": "4905f65c30b7989faf8b8795641b54bcf781a6bd",
- 打开编辑器 点击文件 -> 首选项 -> 设置 打开settings.json,清空所有内容,添加如下代码:
{
"auto-rename-tag.activationOnLanguage": ["html", "xml", "php", "javascript"],
// 设置编辑器字号大小
"editor.fontSize": 16,
// 让函数(名)和后面的括号之间加个空格
"eslint.autoFixOnSave": true,
"eslint.validate": [
"javascript",
"javascriptreact",
{
"language": "html",
"autoFix": true
},
{
"language": "vue",
"autoFix": true
}
],
"explorer.confirmDelete": false,
"editor.tabCompletion": "on",
"files.autoSave": "afterDelay",
// 根据文件后缀名定义vue文件类型
"files.associations": {
"*.vue": "vue"
},
"git.autofetch": true,
"javascript.format.insertSpaceBeforeFunctionParenthesis": true,
//开启 eslint 支持
"prettier.eslintIntegration": true,
//使用单引号
"prettier.singleQuote": true,
//结尾不加分号
"prettier.semi": false,
"sync.gist": "2bc224c3f4119e21dc3a578348839c8a",
"terminal.integrated.shell.windows": "C:\\Windows\\System32\\cmd.exe",
// .vue文件template格式化支持,并使用js-beautify-html插件
"vetur.format.defaultFormatter.html": "js-beautify-html",
// #让vue中的js按编辑器自带的ts格式进行格式化
"vetur.format.defaultFormatter.js": "vscode-typescript",
// js-beautify-html格式化配置,属性强制换行
"vetur.format.defaultFormatterOptions": {
"js-beautify-html": {
"wrap_attributes": "force-aligned"
// #vue组件中html代码格式化样式
},
"prettier": {
"singleQuote": true,
"semi": false
}
},
"[jsonc]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[javascript]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[json]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
}
}
完毕之后,在编辑器中按下 Alt+Shift+D 快捷键下载团队统一使用的插件
如果在下载备份过程中出错,需要按下ctrl+shift+p键,输入 Sync:Reset Extension Settings 重置选项才可以再次执行 Alt+Shift+D 。
编辑器快捷键
1、注释:
单行注释:ctrl+/, 注释后再按取消
取消单行注释:alt+shift+A 注释后再按取消
2、移动行
向上移动一行:alt+up
向下移动一行:alt+down
3、显示/隐藏左侧目录栏
ctrl + b
4、复制当前行
向上复制一行:shift+alt+up
向下复制一行:shift+alt+down
5、删除当前行
shift + ctrl + k
6、控制台显示隐藏
ctrl + ~
7、查找文件
ctrl + p
8、代码格式化
shift + alt +f
9、新建窗口
ctrl + shift + n
10、行增加缩进
ctrl + [
11、行减少缩进
ctrl + ]
12、关闭编辑窗口
ctrl + w
13、关闭所有窗口
ctrl + k + w
ESlint.js 配置
在vscode 的使用过程中,eslint 会实时检查代码规范;如果一行一行错误信息逐行检查处理,效率极低,且重复劳动,耗时费力,在插件横行的web前端时代,工具带来的好处就是自动化处理,带来强大生产力,那么vscode如何自动处理这类警告信息呢?
module.exports = {
root: true,
parserOptions: {
parser: 'babel-eslint',
sourceType: 'module'
},
env: {
browser: true,
node: true,
es6: true,
},
extends: ['plugin:vue/recommended', 'eslint:recommended'],
// add your custom rules here
// it is base on https://github.com/vuejs/eslint-config-vue
rules: {
"vue/max-attributes-per-line": [2, {
"singleline": 10,
"multiline": {
"max": 1,
"allowFirstLine": false
}
}],
"vue/singleline-html-element-content-newline": "off",
"vue/multiline-html-element-content-newline":"off",
"vue/name-property-casing": ["error", "PascalCase"],
"vue/no-v-html": "off",
'accessor-pairs': 2,
'arrow-spacing': [2, {
'before': true,
'after': true
}],
'block-spacing': [2, 'always'],
'brace-style': [2, '1tbs', {
'allowSingleLine': true
}],
'camelcase': [0, {
'properties': 'always'
}],
'comma-dangle': [2, 'never'],
'comma-spacing': [2, {
'before': false,
'after': true
}],
'comma-style': [2, 'last'],
'constructor-super': 2,
'curly': [2, 'multi-line'],
'dot-location': [2, 'property'],
'eol-last': 2,
'eqeqeq': ["error", "always", {"null": "ignore"}],
'generator-star-spacing': [2, {
'before': true,
'after': true
}],
'handle-callback-err': [2, '^(err|error)$'],
'indent': [2, 2, {
'SwitchCase': 1
}],
'jsx-quotes': [2, 'prefer-single'],
'key-spacing': [2, {
'beforeColon': false,
'afterColon': true
}],
'keyword-spacing': [2, {
'before': true,
'after': true
}],
'new-cap': [2, {
'newIsCap': true,
'capIsNew': false
}],
'new-parens': 2,
'no-array-constructor': 2,
'no-caller': 2,
'no-console': process.env.NODE_ENV === 'production' ? 'error' : 'off',
'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off',
'no-class-assign': 2,
'no-cond-assign': 2,
'no-const-assign': 2,
'no-control-regex': 0,
'no-delete-var': 2,
'no-dupe-args': 2,
'no-dupe-class-members': 2,
'no-dupe-keys': 2,
'no-duplicate-case': 2,
'no-empty-character-class': 2,
'no-empty-pattern': 2,
'no-eval': 2,
'no-ex-assign': 2,
'no-extend-native': 2,
'no-extra-bind': 2,
'no-extra-boolean-cast': 2,
'no-extra-parens': [2, 'functions'],
'no-fallthrough': 2,
'no-floating-decimal': 2,
'no-func-assign': 2,
'no-implied-eval': 2,
'no-inner-declarations': [2, 'functions'],
'no-invalid-regexp': 2,
'no-irregular-whitespace': 2,
'no-iterator': 2,
'no-label-var': 2,
'no-labels': [2, {
'allowLoop': false,
'allowSwitch': false
}],
'no-lone-blocks': 2,
'no-mixed-spaces-and-tabs': 2,
'no-multi-spaces': 2,
'no-multi-str': 2,
'no-multiple-empty-lines': [2, {
'max': 1
}],
'no-native-reassign': 2,
'no-negated-in-lhs': 2,
'no-new-object': 2,
'no-new-require': 2,
'no-new-symbol': 2,
'no-new-wrappers': 2,
'no-obj-calls': 2,
'no-octal': 2,
'no-octal-escape': 2,
'no-path-concat': 2,
'no-proto': 2,
'no-redeclare': 2,
'no-regex-spaces': 2,
'no-return-assign': [2, 'except-parens'],
'no-self-assign': 2,
'no-self-compare': 2,
'no-sequences': 2,
'no-shadow-restricted-names': 2,
'no-spaced-func': 2,
'no-sparse-arrays': 2,
'no-this-before-super': 2,
'no-throw-literal': 2,
'no-trailing-spaces': 2,
'no-undef': 2,
'no-undef-init': 2,
'no-unexpected-multiline': 2,
'no-unmodified-loop-condition': 2,
'no-unneeded-ternary': [2, {
'defaultAssignment': false
}],
'no-unreachable': 2,
'no-unsafe-finally': 2,
'no-unused-vars': [2, {
'vars': 'all',
'args': 'none'
}],
'no-useless-call': 2,
'no-useless-computed-key': 2,
'no-useless-constructor': 2,
'no-useless-escape': 0,
'no-whitespace-before-property': 2,
'no-with': 2,
'one-var': [2, {
'initialized': 'never'
}],
'operator-linebreak': [2, 'after', {
'overrides': {
'?': 'before',
':': 'before'
}
}],
'padded-blocks': [2, 'never'],
// 强制使用单引号
quotes: ['error', 'single'],
// 强制不使用分号结尾
semi: ['error', 'never'],
'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, 'always', {
'markers': ['global', 'globals', 'eslint', 'eslint-disable', '*package', '!', ',']
}],
'template-curly-spacing': [2, 'never'],
'use-isnan': 2,
'valid-typeof': 2,
'wrap-iife': [2, 'any'],
'yield-star-spacing': [2, 'both'],
'yoda': [2, 'never'],
'prefer-const': 2,
'no-debugger': process.env.NODE_ENV === 'production' ? 2 : 0,
'object-curly-spacing': [2, 'always', {
objectsInObjects: false
}],
'array-bracket-spacing': [2, 'never']
}
}
.gitignore 配置
.DS_Store
node_modules
/dist
package-lock.json
# local env files
.env.local
.env.*.local
.history
# Log files
npm-debug.log*
yarn-debug.log*
yarn-error.log*
# Editor directories and files
.idea
.vscode
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?