Vue3+Ts+Vite -- 后台管理项目

1.搭建环境及配置文件

        配置vue组件的类型 env.t.ts

/// <reference types="vite/client" />
declare module '*.vue' { 
    import  { DefineComponent } from 'vue'
    const component: DefineComponent
    export default component
}

        配置eslint 跟prettierrc代码规范

一. 代码规范

1.1. 集成editorconfig配置

EditorConfig 有助于为不同 IDE 编辑器上处理同一项目的多个开发人员维护一致的编码风格。

.editorconfig文件的配置，需要安装插件EditorConfig for VS Code

# http://editorconfig.org
root = true
[*] # 表示所有文件适用
charset = utf-8 # 设置文件字符集为 utf-8
indent_style = space # 缩进风格（tab | space）
indent_size = 2 # 缩进大小
end_of_line = lf # 控制换行类型(lf | cr | crlf)
trim_trailing_whitespace = true # 去除行尾的任意空白字符
insert_final_newline = true # 始终在文件末尾插入一个新行
[*.md] # 表示仅 md 文件适用以下规则
max_line_length = off
trim_trailing_whitespace = false

VSCode需要安装一个插件：EditorConfig for VS Code

1.2. 使用prettier工具

        Prettier 是一款强大的代码格式化工具，支持 JavaScript、TypeScript、CSS、SCSS、Less、JSX、Angular、Vue、GraphQL、JSON、Markdown 等语言，基本上前端能用到的文件格式它都可以搞定，是当下最流行的代码格式化工具。

1.安装prettier

npm install prettier -D

2.配置.prettierrc文件：

• useTabs：使用tab缩进还是空格缩进，选择false；

• tabWidth：tab是空格的情况下，是几个空格，选择2个；

• printWidth：当行字符的长度，推荐80，也有人喜欢100或者120；

• singleQuote：使用单引号还是双引号，选择true，使用单引号；

• trailingComma：在多行输入的尾逗号是否添加，设置为 none，比如对象类型的最后一个属性后面是否加一个，；

• semi：语句末尾是否要加分号，默认值true，选择false表示不加；

{
  "useTabs": false,
  "tabWidth": 2,
  "printWidth": 80,
  "singleQuote": true,
  "trailingComma": "none",
  "semi": false
}

3.创建.prettierignore忽略文件

/dist/*
.local
.output.js
/node_modules/**
​
**/*.svg
**/*.sh
​
/public/*

4.VSCode需要安装prettier的插件

        

5.VSCod中的配置（有插件可以不使用命令）

• settings =>format on save => 勾选上

• settings => editor default format => 选择 prettier

6.测试prettier是否生效

• 测试一：在代码中保存代码；

• 测试二：配置一次性修改的命令；

在package.json中配置一个scripts：

    "prettier": "prettier --write ."

1.3. 使用ESLint检测

1.在前面创建项目的时候，我们就选择了ESLint，所以Vue会默认帮助我们配置需要的ESLint环境。

2.VSCode需要安装ESLint插件：

3.解决eslint和prettier冲突的问题：

安装插件：（vue在创建项目时，如果选择prettier，那么这两个插件会自动安装）

npm install eslint-plugin-prettier eslint-config-prettier -D

添加prettier插件：eslint文件的冲突配置 

  extends: [
    "plugin:vue/vue3-essential",
    "eslint:recommended",
    "@vue/typescript/recommended",
    "@vue/prettier",
    "@vue/prettier/@typescript-eslint",
    'plugin:prettier/recommended' 
  ],

4.VSCode中eslint的配置

  "eslint.lintTask.enable": true,
  "eslint.alwaysShowStatus": true,
  "eslint.validate": [
    "javascript",
    "javascriptreact",
    "typescript",
    "typescriptreact"
  ],
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true
  },

5.eslint忽略警告

复制 蓝色代码 在eslint配置文件当中配置rules

          rules: {
                    "@typescript-eslint/no-unused-vars":"off"
                   }

/* eslint-env node */
require("@rushstack/eslint-patch/modern-module-resolution")

module.exports = {
  root: true,
  extends: [
    "plugin:vue/vue3-essential",
    "eslint:recommended",
    "@vue/eslint-config-typescript",
    "@vue/eslint-config-prettier/skip-formatting",
    "plugin:prettier/recommended"
  ],
  parserOptions: {
    ecmaVersion: "latest"
  },
  rules: {
    "@typescript-eslint/no-unused-vars":"off"
   }
}

1.4. git Husky和eslint（后续）

虽然我们已经要求项目使用eslint了，但是不能保证组员提交代码之前都将eslint中的问题解决掉了：

• 也就是我们希望保证代码仓库中的代码都是符合eslint规范的；

• 那么我们需要在组员执行 git commit 命令的时候对其进行校验，如果不符合eslint规范，那么自动通过规范进行修复；

那么如何做到这一点呢？可以通过Husky工具：

• husky是一个git hook工具，可以帮助我们触发git提交的各个阶段：pre-commit、commit-msg、pre-push

如何使用husky呢？

这里我们可以使用自动配置命令：

npx husky-init && npm install

这里会做三件事：

1.安装husky相关的依赖：

2.在项目目录下创建 .husky 文件夹：

3.在package.json中添加一个脚本：

接下来，我们需要去完成一个操作：在进行commit时，执行lint脚本：

这个时候我们执行git commit的时候会自动对代码进行lint校验。

1.5. git commit规范（后续）

1.5.1. 代码提交风格

通常我们的git commit会按照统一的风格来提交，这样可以快速定位每次提交的内容，方便之后对版本进行控制。

但是如果每次手动来编写这些是比较麻烦的事情，我们可以使用一个工具：Commitizen

• Commitizen 是一个帮助我们编写规范 commit message 的工具；

1.安装Commitizen

npm install commitizen -D

2.安装cz-conventional-changelog，并且初始化cz-conventional-changelog：

npx commitizen init cz-conventional-changelog --save-dev --save-exact

这个命令会帮助我们安装cz-conventional-changelog：

并且在package.json中进行配置：

这个时候我们提交代码需要使用 npx cz：

• 第一步是选择type，本次更新的类型

Type	作用
feat	新增特性 (feature)
fix	修复 Bug(bug fix)
docs	修改文档 (documentation)
style	代码格式修改(white-space, formatting, missing semi colons, etc)
refactor	代码重构(refactor)
perf	改善性能(A code change that improves performance)
test	测试(when adding missing tests)
build	变更项目构建或外部依赖（例如 scopes: webpack、gulp、npm 等）
ci	更改持续集成软件的配置文件和 package 中的 scripts 命令，例如 scopes: Travis, Circle 等
chore	变更构建流程或辅助工具(比如更改测试环境)
revert	代码回退

• 第二步选择本次修改的范围（作用域）

• 第三步选择提交的信息

• 第四步提交详细的描述信息

• 第五步是否是一次重大的更改

• 第六步是否影响某个open issue

我们也可以在scripts中构建一个命令来执行 cz：

1.5.2. 代码提交验证

如果我们按照cz来规范了提交风格，但是依然有同事通过 git commit 按照不规范的格式提交应该怎么办呢？

• 我们可以通过commitlint来限制提交；

1.安装 @commitlint/config-conventional 和 @commitlint/cli

npm i @commitlint/config-conventional @commitlint/cli -D

2.在根目录创建commitlint.config.js文件，配置commitlint

module.exports = {
  extends: ['@commitlint/config-conventional']
}

3.使用husky生成commit-msg文件，验证提交信息：

npx husky add .husky/commit-msg "npx --no-install commitlint --edit $1"

二. 接口文档

接口文档v1版本：

mall_cms

baseURL的值：

http://152.136.185.210:5000
http://152.136.185.210:4000

设置全局token的方法：

const res = pm.response.json();
pm.globals.set("token", res.data.token);

接口文档v2版本：（有部分更新）

mall_cms_v2

三、目录结构

重置css样式

        normalize.css         npm install normalize.css

        reset.css

        在main.ts当中导入

import "normalize.css"
import { createApp } from "vue"
import App from "./App.vue"

createApp(App).mount("#app")

安装less的开发依赖

npm Install less -D

重置reset.less文件

body, div, dl, dt, dd, ul, ol, li, h1, h2, h3, h4, h5, h6, pre, code, form, fieldset, legend, input, button, textarea, p, blockquote, th, td {
    margin: 0;
    padding: 0;
}


a {
    color: #333;
    text-decoration: none;
}

img {
    border: none;
    vertical-align: top;
}
ol, ul, li {
    list-style: none;
}

四、路由配置

        安装路由（如果前面项目没有选择router）

        npm install vue-router

配置路由文件

import { createRouter,createWebHashHistory } from "vue-router";
const router = createRouter({
    history: createWebHashHistory(),
    routes: [

    ]
})
export default router;

引入到main.ts当中去

import router from "./router"
createApp(App).use(router).mount("#app")

配置代码片段（snippet generator）

<template>
  <div class="${1:home}">
    <h2>${1:home}</h2>
  </div>
</template>
<script setup lang="ts">


</script>
<style scoped>
.${1:home}{
color: red;
}

</style>

配置页面路由（login，main页面的路由）

import { createRouter, createWebHashHistory } from "vue-router"
const router = createRouter({
  history: createWebHashHistory(),
  routes: [
    {
      path: "/",
      redirect: "/main"
    },
    {
      path: "/login",
      component: () => import("../views/login/login.vue")
    },
    {
      path: "/main",
      component: () => import("../views/main/main.vue")
    }
  ]
})
export default router

五、状态管理工具-pinia

        安装pinia         npm install pinia

1.创建配置文件

import { createPinia } from "pinia"

const pinia = createPinia()

export default pinia

2.在mian.ts当中引入

import pinia from "./store"
app.use(pinia)

3.创建counter文件

import { defineStore } from "pinia"

const userCounterStore = defineStore("counter", {
  state: () => {
    return {
      // 所有这些属性都将自动推断其类型
      counter: 0,
      name: "Eduardo",
      isAdmin: true
    }
  },
  getters: {
    doubleCounter(state) {
      return state.counter * 2
    }
  },
  actions: {
    changeCounterAction(newCounter: number) {
      this.counter = newCounter
    }
  }
})

export default userCounterStore

4.使用store

<template>
  <header>
    <div class="wrapper">
      App
      {{ counterStore.counter }}
      <RouterView />
    </div>
  </header>
</template>
<script setup lang="ts">
import userCounterStore from "./store/counter"
const counterStore = userCounterStore()
</script>

<style scoped></style>

根据环境不同改变环境

console.log(import.meta.env.DEV) //是否开发环境
console.log(import.meta.env.PROD) //是否生产环境
console.log(import.meta.env.SSR) //是否服务端渲染

六、安装element-plus

npm install element-plus --save

全局注册：

import { createApp } from "vue"
import App from "./App.vue"
import ElementPlus from "element-plus"
import "element-plus/dist/index.css"

const app = createApp(App)
app.use(ElementPlus)
app.mount("#app")

 button没有类型

Volar 支持​

如果您使用 Volar，请在 tsconfig.json 中通过 compilerOptions.type 指定全局组件类型。

json

// tsconfig.json
{
  "compilerOptions": {
    // ...
    "types": ["element-plus/global"]
  }
}

 在tsconfig.app.json修改配置

{
  "extends": "@vue/tsconfig/tsconfig.dom.json",
  "include": ["env.d.ts", "src/**/*", "src/**/*.vue"],
  "exclude": ["src/**/__tests__/*"],
  "compilerOptions": {
    "composite": true,
    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.app.tsbuildinfo",
    "baseUrl": ".",
    "paths": {
      "@/*": ["./src/*"]
    },
    "noImplicitAny": false,
    "types": ["element-plus/global"]
  }
}

 按需引入

        npm install -D unplugin-vue-components unplugin-auto-import

按需导入​

您需要使用额外的插件来导入要使用的组件。

自动导入推荐​

首先你需要安装unplugin-vue-components 和 unplugin-auto-import这两款插件

shell

npm install -D unplugin-vue-components unplugin-auto-import

然后把下列代码插入到你的 Vite 或 Webpack 的配置文件中

Vite环境​

ts

// vite.config.ts
import { defineConfig } from 'vite'
import AutoImport from 'unplugin-auto-import/vite'
import Components from 'unplugin-vue-components/vite'
import { ElementPlusResolver } from 'unplugin-vue-components/resolvers'

export default defineConfig({
  // ...
  plugins: [
    // ...
    AutoImport({
      resolvers: [ElementPlusResolver()],
    }),
    Components({
      resolvers: [ElementPlusResolver()],
    }),
  ],
})

 配置类型tsconfig.app.json

 "include": ["env.d.ts", "src/**/*", "src/**/*.vue", "auto-imports.d.ts", "components.d.ts"],

动态路由

安装   npm install coderwhy -g

coderwhy add3page_setup category -d src/views/main/product/category

 const localRouter: RouteRecordRaw[] = []
      const files: Record<string, any> = import.meta.glob("../../router/main/**/*.ts", {
        eager: true
      })
      for (const key in files) {
        const module = files[key]
        localRouter.push(module.default)
        console.log(module.default)
      }
      // console.log(files)
      //2.根据菜单匹配正确的路由
      for (const menu of this.userMenus) {
        for (const submenu of menu.children) {
          const route = localRouter.find((item) => item.path === submenu.url)
          if (route) router.addRoute("main", route)
        }
      }
      router.push("/main")
    }
  },