diff --git a/.eslintrc.js b/.eslintrc.js index 0428bb5..f4d0c28 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -1,4 +1,5 @@ -module.exports = { //https://eslint.org/docs/latest/ +module.exports = { + //https://eslint.org/docs/latest/ root: true, // 环境变量 https://eslint.org/docs/latest/user-guide/configuring/language-options#specifying-environments env: { @@ -13,7 +14,7 @@ module.exports = { //https://eslint.org/docs/latest/ parserOptions: { ecmaVersion: 12, parser: '@typescript-eslint/parser', - sourceType: 'module' + sourceType: 'module', }, // 想要Linting规则的插件 https://eslint.org/docs/latest/user-guide/configuring/plugins plugins: ['vue', '@typescript-eslint', 'prettier'], @@ -24,12 +25,12 @@ module.exports = { //https://eslint.org/docs/latest/ 'plugin:prettier/recommended', '@vue/eslint-config-typescript/recommended', '@vue/eslint-config-prettier', - '@vue/typescript/recommended' + '@vue/typescript/recommended', ], rules: { // TSESLint docs https://typescript-eslint.io/rules/ 'no-var': 'error', // 禁止使用var 'no-console': 'warn', // 禁止出现console - "no-debugger": "off", // 关闭debugger警告 - } -}; \ No newline at end of file + 'no-debugger': 'off', // 关闭debugger警告 + }, +}; diff --git a/.gitignore b/.gitignore index e8bfd90..d710410 100644 --- a/.gitignore +++ b/.gitignore @@ -15,6 +15,7 @@ dist-ssr # Editor directories and files .vscode/* !.vscode/extensions.json +!.vscode/settings.json .idea .DS_Store *.suo diff --git a/.husky/commit-msg b/.husky/commit-msg new file mode 100644 index 0000000..80416c7 --- /dev/null +++ b/.husky/commit-msg @@ -0,0 +1,4 @@ +#!/usr/bin/env sh +. "$(dirname -- "$0")/_/husky.sh" + +npx --no-install commitlint --edit "$1" diff --git a/.husky/pre-commit b/.husky/pre-commit new file mode 100644 index 0000000..18193ff --- /dev/null +++ b/.husky/pre-commit @@ -0,0 +1,4 @@ +#!/usr/bin/env sh +. "$(dirname -- "$0")/_/husky.sh" + +npm run lint && npm run prettier diff --git a/.prettierrc.js b/.prettierrc.js index fc2fbe0..b14aac5 100644 --- a/.prettierrc.js +++ b/.prettierrc.js @@ -1,27 +1,21 @@ -module.exports = { // https://prettier.io/docs/en/options.html - arrowParens: 'avoid', - // bracketSameLine: false, - // bracketSpacing: true, - // embeddedLanguageFormatting: 'auto', - // htmlWhitespaceSensitivity: 'css', - // insertPragma: false, - // jsxSingleQuote: false, - printWidth: 120, - // proseWrap: 'preserve', - // quoteProps: 'as-needed', - // requirePragma: false, - // semi: true, - singleQuote: true, - tabWidth: 2, - trailingComma: 'none', - // useTabs: false, - // vueIndentScriptAndStyle: false, - overrides: [ - { - files: '*.html', - options: { - parser: 'html', - }, - }, - ], +module.exports = { + // https://prettier.io/docs/en/options.html + printWidth: 80, //单行长度 + tabWidth: 2, //缩进长度 + useTabs: false, //使用空格代替tab缩进 + semi: true, //句末使用分号 + singleQuote: true, //使用单引号 + quoteProps: 'as-needed', //仅在必需时为对象的key添加引号 + jsxSingleQuote: true, // jsx中使用单引号 + trailingComma: 'all', //多行时尽可能打印尾随逗号 + bracketSpacing: true, //在对象前后添加空格-eg: { foo: bar } + jsxBracketSameLine: true, //多属性html标签的‘>’折行放置 + arrowParens: 'always', //单参数箭头函数参数周围使用圆括号-eg: (x) => x + requirePragma: false, //无需顶部注释即可格式化 + insertPragma: false, //在已被preitter格式化的文件顶部加上标注 + proseWrap: 'preserve', //不知道怎么翻译 + htmlWhitespaceSensitivity: 'ignore', //对HTML全局空白不敏感 + vueIndentScriptAndStyle: false, //不对vue中的script及style标签缩进 + endOfLine: 'lf', //结束行形式 + embeddedLanguageFormatting: 'auto', //对引用代码进行格式化 }; diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..21317a3 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,20 @@ +{ + // 主题 + // "workbench.colorTheme": "Atom One Light", + // 缩进 + "editor.tabSize": 2, + // 保存eslint校验 + "editor.codeActionsOnSave": { + "source.fixAll.eslint": true + }, + "eslint.format.enable": true, + // 校验那些文件 + "eslint.validate": ["typescript", "javascript", "vue", "html"], + "nuxt.isNuxtApp": false, + // 终端显示 + "eslint.alwaysShowStatus": true, + // 加载配置文件 + "eslint.options": { "configFile": ".eslintrc.js" }, + // 保存自动格式化 + "editor.formatOnSave": true +} diff --git a/commitlint.config.js b/commitlint.config.js new file mode 100644 index 0000000..422b194 --- /dev/null +++ b/commitlint.config.js @@ -0,0 +1 @@ +module.exports = { extends: ['@commitlint/config-conventional'] }; diff --git a/index.html b/index.html index a1c4f26..fb37072 100644 --- a/index.html +++ b/index.html @@ -1,13 +1,13 @@ - - - - - Ench-Admin - - -
- - + + + + + Ench-Admin + + +
+ + diff --git a/package.json b/package.json index 9b1e579..c313931 100644 --- a/package.json +++ b/package.json @@ -2,16 +2,20 @@ "name": "enchadmin", "private": true, "version": "0.0.0", - "type": "module", "scripts": { "dev": "vite", "build": "vue-tsc --noEmit && vite build", - "preview": "vite preview" + "preview": "vite preview", + "prettier": "prettier --write \"src/**/*.{js,json,tsx,css,less,scss,vue,html,md}\"", + "lint": "eslint . --ext .vue,.js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts,.json --fix", + "prepare": "husky install" }, "dependencies": { "vue": "^3.2.37" }, "devDependencies": { + "@commitlint/cli": "^17.0.3", + "@commitlint/config-conventional": "^17.0.3", "@typescript-eslint/eslint-plugin": "^5.32.0", "@typescript-eslint/parser": "^5.32.0", "@vitejs/plugin-vue": "^3.0.0", @@ -23,9 +27,10 @@ "eslint-plugin-import": "^2.26.0", "eslint-plugin-prettier": "^4.2.1", "eslint-plugin-vue": "^9.3.0", + "husky": "^8.0.0", "prettier": "^2.7.1", "typescript": "^4.6.4", "vite": "^3.0.0", "vue-tsc": "^0.38.4" } -} \ No newline at end of file +} diff --git a/src/App.vue b/src/App.vue index 2efc3d0..6bd8c4f 100644 --- a/src/App.vue +++ b/src/App.vue @@ -5,21 +5,21 @@ import HelloWorld from './components/HelloWorld.vue'; diff --git a/src/components/HelloWorld.vue b/src/components/HelloWorld.vue index 5230910..3b2dffd 100644 --- a/src/components/HelloWorld.vue +++ b/src/components/HelloWorld.vue @@ -1,9 +1,9 @@