利用vite+vue3+ts+pinia搭建基础项目

96 阅读5分钟

利用vite+vue3+ts+pinia搭建基础项目

1、npm init vite@latest

命名项目的名称

image.png

2、上下键选择vue回车

3、上下键选择TypeScript回车

4、进入项目,启动项目

image.png

5、代码风格统一

  • eslint安装

yarn add eslint --dev

# eslint 插件安装

yarn add eslint-plugin-vue --dev

yarn add @typescript-eslint/eslint-plugin --dev

yarn add eslint-plugin-prettier --dev

# typescript parser

yarn add @typescript-eslint/parser --dev

项目下新建.eslintrc.js

module.exports = { 
root: true, 
env: { browser: true, node: true, es2021: true, }, 
parser: "vue-eslint-parser", 
extends: [ "eslint:recommended", 
"plugin:vue/vue3-recommended", 
"plugin:@typescript-eslint/recommended",
"plugin:prettier/recommended", // eslint-config-prettier 的缩写 "prettier", 
], 
parserOptions: { 
ecmaVersion: 12, 
parser: "@typescript-eslint/parser", 
sourceType: "module", 
ecmaFeatures: { jsx: true, }, 
}, // eslint-plugin-vue @typescript-eslint/eslint-plugin eslint-plugin-prettier的缩写 
plugins: ["vue", "@typescript-eslint", "prettier"], 
rules: { 
"@typescript-eslint/ban-ts-ignore": "off", 
"@typescript-eslint/no-unused-vars": "off", 
"@typescript-eslint/explicit-function-return-type": "off", 
"@typescript-eslint/no-explicit-any": "off", 
"@typescript-eslint/no-var-requires": "off", 
"@typescript-eslint/no-empty-function": "off",
"@typescript-eslint/no-use-before-define": "off",
"@typescript-eslint/ban-ts-comment": "off", 
"@typescript-eslint/ban-types": "off",
"@typescript-eslint/no-non-null-assertion": "off",
"@typescript-eslint/explicit-module-boundary-types": "off", 
"no-var": "error", 
"prettier/prettier": "error", 
// 禁止出现console 
"no-console": "warn", 
// 禁用debugger 
"no-debugger": "warn", 
// 禁止出现重复的 case 标签 
"no-duplicate-case": "warn", 
// 禁止出现空语句块 
"no-empty": "warn", 
// 禁止不必要的括号 
"no-extra-parens": "off", 
// 禁止对 function 声明重新赋值 
"no-func-assign": "warn", 
// 禁止在 return、throw、continue 和 break 语句之后出现不可达代码 
"no-unreachable": "warn", 
// 强制所有控制语句使用一致的括号风格 
curly: "warn", 
// 要求 switch 语句中有 default 分支 
"default-case": "warn", 
// 强制尽可能地使用点号 
"dot-notation": "warn", 
// 要求使用 === 和 !== 
eqeqeq: "warn", 
// 禁止 if 语句中 return 语句之后有 else 块 
"no-else-return": "warn", 
// 禁止出现空函数 
"no-empty-function": "warn", 
// 禁用不必要的嵌套块 
"no-lone-blocks": "warn", 
// 禁止使用多个空格 
"no-multi-spaces": "warn", 
// 禁止多次声明同一变量 
"no-redeclare": "warn", 
// 禁止在 return 语句中使用赋值语句 
"no-return-assign": "warn", 
// 禁用不必要的 return await 
"no-return-await": "warn", 
// 禁止自我赋值 
"no-self-assign": "warn", 
// 禁止自身比较 
"no-self-compare": "warn", 
// 禁止不必要的 catch 子句 
"no-useless-catch": "warn", 
// 禁止多余的 return 语句 
"no-useless-return": "warn", 
// 禁止变量声明与外层作用域的变量同名 
"no-shadow": "off", 
// 允许delete变量 
"no-delete-var": "off", 
// 强制数组方括号中使用一致的空格 
"array-bracket-spacing": "warn", 
// 强制在代码块中使用一致的大括号风格 
"brace-style": "warn", 
// 强制使用骆驼拼写法命名约定 
camelcase: "warn", 
// 强制使用一致的缩进 
indent: "off", 
// 强制在 JSX 属性中一致地使用双引号或单引号 // 
'jsx-quotes': 'warn', 
// 强制可嵌套的块的最大深度4 
"max-depth": "warn", 
// 强制最大行数 300 // 
"max-lines": ["warn", { "max": 1200 }], 
// 强制函数最大代码行数 50 
'max-lines-per-function': ['warn', { max: 70 }], 
// 强制函数块最多允许的的语句数量20 
"max-statements": ["warn", 100], 
// 强制回调函数最大嵌套深度 
"max-nested-callbacks": ["warn", 3], 
// 强制函数定义中最多允许的参数数量 
"max-params": ["warn", 3], 
// 强制每一行中所允许的最大语句数量 
"max-statements-per-line": ["warn", { max: 1 }], 
// 要求方法链中每个调用都有一个换行符 
"newline-per-chained-call": ["warn", { ignoreChainWithDepth: 3 }], 
// 禁止 if 作为唯一的语句出现在 else 语句中 
"no-lonely-if": "warn", 
// 禁止空格和 tab 的混合缩进 
"no-mixed-spaces-and-tabs": "warn", 
// 禁止出现多行空行 
"no-multiple-empty-lines": "warn", 
// 禁止出现; 
semi: ["warn", "never"], 
// 强制在块之前使用一致的空格 
"space-before-blocks": "warn", 
// 强制在 function的左括号之前使用一致的空格 
'space-before-function-paren': ['warn', 'never'], 
// 强制在圆括号内使用一致的空格 
"space-in-parens": "warn", 
// 要求操作符周围有空格 
"space-infix-ops": "warn", 
// 强制在一元操作符前后使用一致的空格 
"space-unary-ops": "warn", 
// 强制在注释中 // 或 /* 使用一致的空格 // 
"spaced-comment": "warn", 
// 强制在 switch 的冒号左右有空格 
"switch-colon-spacing": "warn", 
// 强制箭头函数的箭头前后使用一致的空格 
"arrow-spacing": "warn", "no-var": "warn", "prefer-const": "warn", "prefer-rest-params": "warn", "no-useless-escape": "warn", "no-irregular-whitespace": "warn", "no-prototype-builtins": "warn", "no-fallthrough": "warn", "no-extra-boolean-cast": "warn", "no-case-declarations": "warn", "no-async-promise-executor": "warn", }, globals: { defineProps: "readonly", defineEmits: "readonly", defineExpose: "readonly", withDefaults: "readonly", }, };

项目下新建 .eslintignore

# eslint 忽略检查 (根据项目需要自行添加)

node\_modules

dist

prettier支持

项目下新建.prettier.js

module.exports = { 
tabWidth: 2, 
jsxSingleQuote: true, 
jsxBracketSameLine: true, 
printWidth: 100, 
singleQuote: true, 
semi: false, 
overrides: [ 
  { 
    files: '*.json', 
    options: { 
      printWidth: 200, 
    }, 
  }, 
], 
arrowParens: 'always', 
}

配置文件引用别名alias

直接修改vite.config.ts文件配置

import { defineConfig } from "vite";

import vue from "@vitejs/plugin-vue";

import path from "path";

// <https://vitejs.dev/config/>

export default defineConfig({

  plugins: [vue()],

  resolve: {

     alias: {

        "@": path.resolve(__dirname, "src"),

      },

    },

});

修改tsconfig.json

{

"compilerOptions": {

  "target": "esnext",

  "module": "esnext",

  "moduleResolution": "node",

  "strict": true,

  "jsx": "preserve",

  "sourceMap": true,

  "resolveJsonModule": true,

  "esModuleInterop": true,

  "lib": ["esnext", "dom"],

  "baseUrl": ".",

  "paths": {

  "@/*": ["src/*"]

  }

  },

  "include": ["src/**/*.ts", "src/**/*.d.ts", "src/**/*.tsx", "src/**/*.vue"]

}

配置css预处理器scss


yarn add sass-loader --dev

yarn add dart-sass --dev

yarn add sass --dev

在 src 文件下新增 style 文件夹 => main.scss 文件

$test-color: rgb(0, 4, 255);

路由安装

yarn add vue-router@4

在 src 文件下新增 router 文件夹 => index.ts 文件

import { createRouter, createWebHistory, RouteRecordRaw } from "vue-router";

const routes: RouteRecordRaw[] = [];

const router = createRouter({

  history: createWebHistory(),

  routes,

});

export default router;

状态管理pinia

安装pinia: yarn add pinia@next

在src文件夹下新增store文件夹 在store中新增main.ts

import { defineStore } from "pinia";

export const useMainStore = defineStore({

  id: "main",

  state: () => ({

    name: "群主",

  }),

  getters: {

    nameLength: (state) => state.name.length,

  },

  actions: {

    setName(name: string) {

      this.name = name;

    },

  },

});

环境变量配置

vite提供了两种模式:具有开发服务器的开发模式development和生产模式production

项目根目录新建:.env.development

NODE_ENV=development

VITE_APP_WEB_URL= 'www.baidu.com'

项目根目录新建:.env.production

NODE_ENV=production

VITE_APP_WEB_URL= 'www.baidu.com'

使用方式:import.meta.env.VITE_APP_WEB_URL