blackteay/nova-admin
1
0
Fork 0
mirror of https://github.com/chansee97/nova-admin.git synced 2025-04-05 19:41:59 +08:00
Code Issues Packages Projects Releases Wiki Activity

chore(husky): 增加husky git hook commitlint

Browse Source
This commit is contained in:
‘chen.home’ 2022-08-04 22:25:22 +08:00
parent 7b6408d1ca
commit aaf247bb73
15 changed files with 103 additions and 78 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
.eslintrc.js
View File

@ -1,4 +1,5 @@
module.exports = { //https://eslint.org/docs/latest/ module.exports = {
//https://eslint.org/docs/latest/
root: true, root: true,
// 环境变量 https://eslint.org/docs/latest/user-guide/configuring/language-options#specifying-environments // 环境变量 https://eslint.org/docs/latest/user-guide/configuring/language-options#specifying-environments
env: { env: {
@ -13,7 +14,7 @@ module.exports = { //https://eslint.org/docs/latest/
parserOptions: { parserOptions: {
ecmaVersion: 12, ecmaVersion: 12,
parser: '@typescript-eslint/parser', parser: '@typescript-eslint/parser',
sourceType: 'module' sourceType: 'module',
}, },
// 想要Linting规则的插件 https://eslint.org/docs/latest/user-guide/configuring/plugins // 想要Linting规则的插件 https://eslint.org/docs/latest/user-guide/configuring/plugins
plugins: ['vue', '@typescript-eslint', 'prettier'], plugins: ['vue', '@typescript-eslint', 'prettier'],
@ -24,12 +25,12 @@ module.exports = { //https://eslint.org/docs/latest/
'plugin:prettier/recommended', 'plugin:prettier/recommended',
'@vue/eslint-config-typescript/recommended', '@vue/eslint-config-typescript/recommended',
'@vue/eslint-config-prettier', '@vue/eslint-config-prettier',
'@vue/typescript/recommended' '@vue/typescript/recommended',
], ],
rules: { rules: {
// TSESLint docs https://typescript-eslint.io/rules/ // TSESLint docs https://typescript-eslint.io/rules/
'no-var': 'error', // 禁止使用var 'no-var': 'error', // 禁止使用var
'no-console': 'warn', // 禁止出现console 'no-console': 'warn', // 禁止出现console
"no-debugger": "off", // 关闭debugger警告 'no-debugger': 'off', // 关闭debugger警告
} },
}; };

1
.gitignore vendored
View File

@ -15,6 +15,7 @@ dist-ssr
# Editor directories and files # Editor directories and files
.vscode/* .vscode/*
!.vscode/extensions.json !.vscode/extensions.json
!.vscode/settings.json
.idea .idea
.DS_Store .DS_Store
*.suo *.suo

4
.husky/commit-msg Normal file
View File

@ -0,0 +1,4 @@
#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"
npx --no-install commitlint --edit "$1"

4
.husky/pre-commit Normal file
View File

@ -0,0 +1,4 @@
#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"
npm run lint && npm run prettier

46
.prettierrc.js
View File

@ -1,27 +1,21 @@
module.exports = { // https://prettier.io/docs/en/options.html module.exports = {
arrowParens: 'avoid', // https://prettier.io/docs/en/options.html
// bracketSameLine: false, printWidth: 80, //单行长度
// bracketSpacing: true, tabWidth: 2, //缩进长度
// embeddedLanguageFormatting: 'auto', useTabs: false, //使用空格代替tab缩进
// htmlWhitespaceSensitivity: 'css', semi: true, //句末使用分号
// insertPragma: false, singleQuote: true, //使用单引号
// jsxSingleQuote: false, quoteProps: 'as-needed', //仅在必需时为对象的key添加引号
printWidth: 120, jsxSingleQuote: true, // jsx中使用单引号
// proseWrap: 'preserve', trailingComma: 'all', //多行时尽可能打印尾随逗号
// quoteProps: 'as-needed', bracketSpacing: true, //在对象前后添加空格-eg: { foo: bar }
// requirePragma: false, jsxBracketSameLine: true, //多属性html标签的‘>’折行放置
// semi: true, arrowParens: 'always', //单参数箭头函数参数周围使用圆括号-eg: (x) => x
singleQuote: true, requirePragma: false, //无需顶部注释即可格式化
tabWidth: 2, insertPragma: false, //在已被preitter格式化的文件顶部加上标注
trailingComma: 'none', proseWrap: 'preserve', //不知道怎么翻译
// useTabs: false, htmlWhitespaceSensitivity: 'ignore', //对HTML全局空白不敏感
// vueIndentScriptAndStyle: false, vueIndentScriptAndStyle: false, //不对vue中的script及style标签缩进
overrides: [ endOfLine: 'lf', //结束行形式
{ embeddedLanguageFormatting: 'auto', //对引用代码进行格式化
files: '*.html',
options: {
parser: 'html',
},
},
],
}; };

20
.vscode/settings.json vendored Normal file
View File

@ -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
}

1
commitlint.config.js Normal file
View File

@ -0,0 +1 @@
module.exports = { extends: ['@commitlint/config-conventional'] };

20
index.html
View File

@ -1,13 +1,13 @@
<!DOCTYPE html> <!DOCTYPE html>
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="UTF-8" /> <meta charset="UTF-8" />
<link rel="icon" type="image/svg+xml" href="/pixel.svg" /> <link rel="icon" type="image/svg+xml" href="/pixel.svg" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Ench-Admin</title> <title>Ench-Admin</title>
</head> </head>
<body> <body>
<div id="app"></div> <div id="app"></div>
<script type="module" src="/src/main.ts"></script> <script type="module" src="/src/main.ts"></script>
</body> </body>
</html> </html>

11
package.json
View File

@ -2,16 +2,20 @@
"name": "enchadmin", "name": "enchadmin",
"private": true, "private": true,
"version": "0.0.0", "version": "0.0.0",
"type": "module",
"scripts": { "scripts": {
"dev": "vite", "dev": "vite",
"build": "vue-tsc --noEmit && vite build", "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": { "dependencies": {
"vue": "^3.2.37" "vue": "^3.2.37"
}, },
"devDependencies": { "devDependencies": {
"@commitlint/cli": "^17.0.3",
"@commitlint/config-conventional": "^17.0.3",
"@typescript-eslint/eslint-plugin": "^5.32.0", "@typescript-eslint/eslint-plugin": "^5.32.0",
"@typescript-eslint/parser": "^5.32.0", "@typescript-eslint/parser": "^5.32.0",
"@vitejs/plugin-vue": "^3.0.0", "@vitejs/plugin-vue": "^3.0.0",
@ -23,9 +27,10 @@
"eslint-plugin-import": "^2.26.0", "eslint-plugin-import": "^2.26.0",
"eslint-plugin-prettier": "^4.2.1", "eslint-plugin-prettier": "^4.2.1",
"eslint-plugin-vue": "^9.3.0", "eslint-plugin-vue": "^9.3.0",
"husky": "^8.0.0",
"prettier": "^2.7.1", "prettier": "^2.7.1",
"typescript": "^4.6.4", "typescript": "^4.6.4",
"vite": "^3.0.0", "vite": "^3.0.0",
"vue-tsc": "^0.38.4" "vue-tsc": "^0.38.4"
} }
} }

20
src/App.vue
View File

@ -5,21 +5,21 @@ import HelloWorld from './components/HelloWorld.vue';
</script> </script>
<template> <template>
<div> <div>
<a href="https://vitejs.dev" target="_blank"> <a href="https://vitejs.dev" target="_blank">
<img src="/pixel.svg" class="logo" /> <img src="/pixel.svg" class="logo" />
</a> </a>
</div> </div>
<HelloWorld msg="Ench-Admin 中后台模板" /> <HelloWorld msg="Ench-Admin 中后台模板" />
</template> </template>
<style scoped> <style scoped>
.logo { .logo {
height: 6em; height: 6em;
padding: 1.5em; padding: 1.5em;
will-change: filter; will-change: filter;
} }
.logo:hover { .logo:hover {
filter: drop-shadow(0 0 2em #ed9d0aaa); filter: drop-shadow(0 0 2em #ed9d0aaa);
} }
</style> </style>

16
src/components/HelloWorld.vue
View File

@ -1,9 +1,9 @@
<script setup lang="ts"> <script setup lang="ts">
import { ref } from 'vue' import { ref } from 'vue';
defineProps<{ msg: string }>() defineProps<{ msg: string }>();
const count = ref(0) const count = ref(0);
</script> </script>
<template> <template>
@ -13,15 +13,17 @@ const count = ref(0)
<button type="button" @click="count++">count is {{ count }}</button> <button type="button" @click="count++">count is {{ count }}</button>
<p> <p>
Edit Edit
<code>components/HelloWorld.vue</code> to test HMR <code>components/HelloWorld.vue</code>
to test HMR
</p> </p>
</div> </div>
<p> <p>
Check out Check out
<a href="https://vuejs.org/guide/quick-start.html#local" target="_blank" <a href="https://vuejs.org/guide/quick-start.html#local" target="_blank">
>create-vue</a create-vue
>, the official Vue + Vite starter </a>
, the official Vue + Vite starter
</p> </p>
<p> <p>
Install Install

8
src/main.ts
View File

@ -1,5 +1,5 @@
import { createApp } from 'vue' import { createApp } from 'vue';
import './style.css' import './style.css';
import App from './App.vue' import App from './App.vue';
createApp(App).mount('#app') createApp(App).mount('#app');

7
src/vite-env.d.ts vendored
View File

@ -1,7 +0,0 @@
/// <reference types="vite/client" />
declare module '*.vue' {
import type { DefineComponent } from 'vue'
const component: DefineComponent<{}, {}, any>
export default component
}

2
tsconfig.json
View File

@ -13,5 +13,5 @@
"lib": ["ESNext", "DOM"], "lib": ["ESNext", "DOM"],
"skipLibCheck": true "skipLibCheck": true
}, },
"include": ["src/**/*.ts", "src/**/*.d.ts", "src/**/*.tsx", "src/**/*.vue"], "include": ["src/**/*.ts", "src/**/*.d.ts", "src/**/*.tsx", "src/**/*.vue"]
} }

8
vite.config.ts
View File

@ -1,7 +1,7 @@
import { defineConfig } from 'vite' import { defineConfig } from 'vite';
import vue from '@vitejs/plugin-vue' import vue from '@vitejs/plugin-vue';
// https://vitejs.dev/config/ // https://vitejs.dev/config/
export default defineConfig({ export default defineConfig({
plugins: [vue()] plugins: [vue()],
}) });