feat(项目配置新增): 🚀 新增项目配置内容: 代码规范

.eslintrc.cjs

@@ -0,0 +1,42 @@
+process.env.ESLINT_TSCONFIG = 'tsconfig.json'
+module.exports = {
+    env: {
+        browser: true,
+        es2021: true
+    },
+    extends: [
+        'plugin:prettier/recommended',
+        'plugin:vue/vue3-recommended',
+        'plugin:@typescript-eslint/recommended',
+        'plugin:nuxt/recommended',
+        "plugin:tailwindcss/recommended",
+        "@antfu"
+    ],
+    parserOptions: {
+        ecmaVersion: 'latest',
+        parser: '@typescript-eslint/parser',
+        sourceType: 'module'
+    },
+    plugins: ['@typescript-eslint', 'tailwindcss'],
+    rules: {
+        'vue/multi-word-component-names': 0, //关闭vue文件和组件命名校验
+        'vue/singleline-html-element-content-newline': 'off',
+        'vue/multiline-html-element-content-newline': 'off',
+        'vue/max-attributes-per-line': 0,
+        'no-console': process.env.NODE_ENV === 'production' ? 'error' : 'warn',
+        'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'warn',
+        'prettier/prettier': [
+            'error',
+            {
+                printWidth: 140, //代码单行长度
+                tabWidth: 2, //tab键缩进为2空格
+                useTabs: false, //使用空格缩进
+                singleQuote: true, //js单引号
+                semi: false, //去分号
+                // trailingComma: 'none', //无尾逗号
+                arrowParens: 'avoid', //箭头函数尽可能省略括号
+                jsxBracketSameLine: true //标签换行后>单独一行
+            }
+        ]
+    }
+}

.husky/commit-msg

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

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+yarn lint-staged

commitlint.config.js

@@ -0,0 +1,128 @@
+// @see: https://cz-git.qbenben.com/zh/guide
+/** @type {import('cz-git').UserConfig} */
+
+module.exports = {
+    ignores: [commit => commit.includes('init')],
+    extends: ['@commitlint/config-conventional'],
+    rules: {
+        // @see: https://commitlint.js.org/#/reference-rules
+        'body-leading-blank': [2, 'always'],
+        'footer-leading-blank': [1, 'always'],
+        'header-max-length': [2, 'always', 108],
+        'subject-empty': [2, 'never'],
+        'type-empty': [2, 'never'],
+        'subject-case': [0],
+        'type-enum': [
+            2,
+            'always',
+            [
+                'feat',
+                'fix',
+                'docs',
+                'style',
+                'refactor',
+                'perf',
+                'test',
+                'build',
+                'ci',
+                'chore',
+                'revert',
+                'wip',
+                'workflow',
+                'types',
+                'release',
+            ],
+        ],
+    },
+    prompt: {
+        messages: {
+            // type: 'Select the type of change that you're committing:',
+            // scope: 'Denote the SCOPE of this change (optional):',
+            // customScope: 'Denote the SCOPE of this change:',
+            // subject: 'Write a SHORT, IMPERATIVE tense description of the change:\n',
+            // body: 'Provide a LONGER description of the change (optional). Use "|" to break new line:\n',
+            // breaking: 'List any BREAKING CHANGES (optional). Use "|" to break new line:\n',
+            // footerPrefixsSelect: 'Select the ISSUES type of changeList by this change (optional):',
+            // customFooterPrefixs: 'Input ISSUES prefix:',
+            // footer: 'List any ISSUES by this change. E.g.: #31, #34:\n',
+            // confirmCommit: 'Are you sure you want to proceed with the commit above?',
+            // 中文版
+            type: '选择你要提交的类型 :',
+            scope: '选择一个提交范围（可选）:',
+            customScope: '请输入自定义的提交范围 :',
+            subject: '填写简短精炼的变更描述 :\n',
+            body: '填写更加详细的变更描述（可选）。使用 "|" 换行 :\n',
+            breaking: '列举非兼容性重大的变更（可选）。使用 "|" 换行 :\n',
+            footerPrefixsSelect: '选择关联issue前缀（可选）:',
+            customFooterPrefixs: '输入自定义issue前缀 :',
+            footer: '列举关联issue (可选) 例如: #31, #I3244 :\n',
+            confirmCommit: '是否提交或修改commit ?',
+        },
+        types: [
+            // 英文
+            // { value: 'feat', name: 'feat:     🚀  A new feature', emoji: '🚀' },
+            // { value: 'fix', name: 'fix:      🧩  A bug fix', emoji: '🧩' },
+            // { value: 'docs', name: 'docs:     📚  Documentation only changes', emoji: '📚' },
+            // { value: 'style', name: 'style:    🎨  Changes that do not affect the meaning of the code', emoji: '🎨' },
+            // { value: 'refactor', name: 'refactor: ♻️   A code change that neither fixes a bug nor adds a feature', emoji: '♻️' },
+            // { value: 'perf', name: 'perf:     ⚡️  A code change that improves performance', emoji: '⚡️' },
+            // { value: 'test', name: 'test:     ✅  Adding missing tests or correcting existing tests', emoji: '✅' },
+            // { value: 'build', name: 'build:    📦️   Changes that affect the build system or external dependencies', emoji: '📦️' },
+            // { value: 'ci', name: 'ci:       🎡  Changes to our CI configuration files and scripts', emoji: '🎡' },
+            // { value: 'chore', name: 'chore:    🔨  Other changes that don't modify src or test files', emoji: '🔨' },
+            // { value: 'revert', name: 'revert:   ⏪️  Reverts a previous commit', emoji: '⏪️' },
+            // 中文版
+            // { value: '特性', name: '特性:   🚀  新增功能', emoji: '🚀' },
+            // { value: '修复', name: '修复:   🧩  修复缺陷', emoji: '🧩' },
+            // { value: '文档', name: '文档:   📚  文档变更', emoji: '📚' },
+            // { value: '格式', name: '格式:   🎨  代码格式（不影响功能，例如空格、分号等格式修正）', emoji: '🎨' },
+            // { value: '重构', name: '重构:   ♻️  代码重构（不包括 bug 修复、功能新增）', emoji: '♻️' },
+            // { value: '性能', name: '性能:   ⚡️  性能优化', emoji: '⚡️' },
+            // { value: '测试', name: '测试:   ✅  添加疏漏测试或已有测试改动', emoji: '✅' },
+            // { value: '构建', name: '构建:   📦️  构建流程、外部依赖变更（如升级 npm 包、修改 webpack 配置等）', emoji: '📦️' },
+            // { value: '集成', name: '集成:   🎡  修改 CI 配置、脚本', emoji: '🎡' },
+            // { value: '回退', name: '回退:   ⏪️  回滚 commit', emoji: '⏪️' },
+            // { value: '其他', name: '其他:   🔨  对构建过程或辅助工具和库的更改（不影响源文件、测试用例）', emoji: '🔨' },
+            // 中英混合版
+            { value: 'feat', name: 'feat:       🚀  新增功能', emoji: '🚀' },
+            { value: 'fix', name: 'fix:        🧩  修复缺陷', emoji: '🧩' },
+            { value: 'docs', name: 'docs:       📚  文档变更', emoji: '📚' },
+            { value: 'style', name: 'style:      🎨  代码格式（不影响功能，例如空格、分号等格式修正）', emoji: '🎨' },
+            { value: 'refactor', name: 'refactor:   ♻️  代码重构（不包括 bug 修复、功能新增）', emoji: '♻️' },
+            { value: 'perf', name: 'perf:      ⚡️  性能优化', emoji: '⚡️' },
+            { value: 'test', name: 'test:       ✅  添加疏漏测试或已有测试改动', emoji: '✅' },
+            { value: 'build', name: 'build:      📦️  构建流程、外部依赖变更（如升级 npm 包、修改 webpack 配置等）', emoji: '📦️' },
+            { value: 'ci', name: 'ci:         🎡  修改 CI 配置、脚本', emoji: '🎡' },
+            { value: 'revert', name: 'revert:     ⏪️  回滚 commit', emoji: '⏪️' },
+            { value: 'chore', name: 'chore:      🔨  对构建过程或辅助工具和库的更改（不影响源文件、测试用例）', emoji: '🔨' },
+        ],
+        useEmoji: true,
+        themeColorCode: '',
+        scopes: [],
+        allowCustomScopes: true,
+        allowEmptyScopes: true,
+        customScopesAlign: 'bottom',
+        customScopesAlias: 'custom',
+        emptyScopesAlias: 'empty',
+        upperCaseSubject: false,
+        allowBreakingChanges: ['feat', 'fix'],
+        breaklineNumber: 100,
+        breaklineChar: '|',
+        skipQuestions: [],
+        issuePrefixs: [{ value: 'closed', name: 'closed:   ISSUES has been processed' }],
+        customIssuePrefixsAlign: 'top',
+        emptyIssuePrefixsAlias: 'skip',
+        customIssuePrefixsAlias: 'custom',
+        allowCustomIssuePrefixs: true,
+        allowEmptyIssuePrefixs: true,
+        confirmColorize: true,
+        maxHeaderLength: Infinity,
+        maxSubjectLength: Infinity,
+        minSubjectLength: 0,
+        scopeOverrides: undefined,
+        defaultBody: '',
+        defaultIssues: '',
+        defaultScope: '',
+        defaultSubject: '',
+    },
+}

nuxt.config.ts

@@ -4,21 +4,18 @@
  * @LastEditors  : 15257184434 [email protected]
  * @LastEditTime : 2023-01-15 09:56:26
  * @FilePath     : \varlet-nuxt3-example\nuxt.config.ts
- * @Description  : 
- * 
- * Copyright (c) 2023 by 15257184434 [email protected], All Rights Reserved. 
+ * @Description  :
+ *
+ * Copyright (c) 2023 by 15257184434 [email protected], All Rights Reserved.
  */
 import { defineNuxtConfig } from 'nuxt/config'
 
 export default defineNuxtConfig({
   srcDir: 'src/',
   build: {
-    transpile: ['@varlet/ui', 'dayjs']
+    transpile: ['@varlet/ui', 'dayjs'],
   },
-  modules: [
-    '@pinia/nuxt',
-    '@vueuse/nuxt',
-  ],
+  modules: ['@pinia/nuxt', '@vueuse/nuxt', '@nuxtjs/tailwindcss'],
   css: ['~/styles/init.css', '~/styles/main.css', 'animate.css/animate.css'],
   app: {
     head: {
@@ -43,13 +40,16 @@ export default defineNuxtConfig({
         { name: 'og:url', content: 'https://gaojianghua.cn/docs/' },
         { name: 'og:title', content: 'Wolffy-Document' },
         { name: 'og:image', content: 'https://gaojianghua.oss-cn-hangzhou.aliyuncs.com/home/%E7%81%B0%E5%A4%AA%E7%8B%BC.png' },
-        { name: 'og:description', content: '技术博客--前端后端运维知识点收录: Vue, React, Taro, ReactNative, Webpack, Vite, UniApp, 小程序, H5, Docker, Git, GoLang, Node, Nest, Mysql, Redis, 数据结构, 算法' },
+        {
+          name: 'og:description',
+          content:
+            '技术博客--前端后端运维知识点收录: Vue, React, Taro, ReactNative, Webpack, Vite, UniApp, 小程序, H5, Docker, Git, GoLang, Node, Nest, Mysql, Redis, 数据结构, 算法',
+        },
       ],
       link: [
         { rel: 'icon', type: 'image/svg+xml', href: 'https://gaojianghua.oss-cn-hangzhou.aliyuncs.com/home/tianlun.ico' },
         { rel: 'dns-prefetch', href: 'https://gaojianghua.oss-cn-hangzhou.aliyuncs.com' },
-      ]
-    }
-  }
+      ],
+    },
+  },
 })
-

package.json

@@ -1,23 +1,59 @@
 {
   "private": true,
+  "main": "index.js",
+  "author": "高江华 <[email protected]>",
+  "license": "MIT",
   "scripts": {
     "build": "nuxt build",
     "dev": "nuxt dev",
     "generate": "nuxt generate",
-    "preview": "nuxt preview"
+    "preview": "nuxt preview",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "lint-staged": "lint-staged",
+    "postinstall": "husky install"
   },
   "devDependencies": {
+    "@antfu/eslint-config": "^0.34.1",
+    "@commitlint/cli": "^17.4.2",
+    "@commitlint/config-conventional": "^17.4.2",
+    "@nuxtjs/tailwindcss": "^6.2.0",
+    "commitizen": "^4.2.6",
+    "cz-git": "^1.4.1",
+    "eslint": "^8.32.0",
+    "eslint-config-prettier": "^8.6.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-tailwindcss": "^3.8.0",
+    "husky": "^8.0.3",
+    "lint-staged": "^13.1.0",
     "nuxt": "^3.0.0",
     "postcss-px-to-viewport": "^1.1.1",
-    "prettier": "^2.5.1"
+    "prettier": "^2.8.3",
+    "typescript": "^4.9.4"
   },
   "dependencies": {
     "@pinia/nuxt": "^0.4.6",
     "@varlet/touch-emulator": "^2.6.2",
     "@varlet/ui": "^2.6.0",
     "@vueuse/core": "^9.10.0",
     "@vueuse/nuxt": "^9.10.0",
+    "daisyui": "^2.47.0",
+    "eslint-plugin-json": "^3.1.0",
+    "eslint-plugin-nuxt": "^4.0.0",
     "pinia": "^2.0.28",
     "sass": "^1.57.1"
+  },
+  "lint-staged": {
+    "*.{js,ts,tsx,jsx}": [
+      "eslint --fix --ext"
+    ],
+    "*.vue": [
+      "eslint --fix --ext"
+    ]
+  },
+  "config": {
+    "commitizen": {
+      "path": "node_modules/cz-git"
+    }
   }
 }

tailwind.config.js

@@ -0,0 +1,8 @@
+/** @type {import('tailwindcss').Config} */
+module.exports = {
+  content: [],
+  theme: {
+    extend: {},
+  },
+  plugins: [require('daisyui')], // 以插件的方式引入
+}