項目結構

my-vue3-project
├─ .env   						//預設環境變數
├─ .env.development  			//開發環境變數
├─ .eslintrc-auto-import.json	//（autoimport變數，eslint配置）由auto-import插件生成
├─ .eslintrc.js 				//eslint配置文件
├─ .gitignore
├─ auto-imports.d.ts			//（autoimport變數，ts聲明文件）由auto-import插件生成
├─ index.html
├─ jsconfig.json
├─ package-lock.json
├─ package.json
├─ src
│  ├─ App.vue
│  ├─ components
│  ├─ main.js
│  ├─ manifest.json				//uniapp項目配置文件
│  ├─ pages
│  │  └─ index
│  │     └─ IndexView.vue
│  ├─ pages.json 	 			//頁面配置文件
│  ├─ services 					// 請求後端服務目錄
│  │  ├─ api.js  				// 後端api
│  │  └─ http.js				//請求
│  ├─ shime-uni.d.ts
│  ├─ static					//靜態文件目錄
│  │  └─ logo.png
│  ├─ store	 					//pinia全局狀態庫
│  │  └─ useUserStore.js
│  ├─ uni.scss
│  └─ utils						//公共的工具方法
└─ vite.config.js

創建歷程

項目創建^[1]

npx degit dcloudio/uni-preset-vue#vite my-vue3-project

• Vue3/Vite 版要求 node 版本^14.18.0 || >=16.0.0
• 如果使用 HBuilderX（3.6.7 以下版本）運行 Vue3/Vite 創建的最新的 cli 工程，需要在 HBuilderX 運行配置最底部設置 node 路徑 為自己本機高版本 node 路徑（註意需要重啟 HBuilderX 才可以生效）
• HBuilderX Mac 版本菜單欄左上角 HBuilderX->偏好設置->運行配置->node 路徑
• HBuilderX Windows 版本菜單欄 工具->設置->運行配置->node 路徑

項目依賴安裝

Eslint

Eslint 的相關配置可參考文章：Web 項目如何配置 Eslint
註意：在配置完 Eslint 之後，在項目中使用 uni 的時候會報 uni 未被定義的錯，需在.eslintrc.js 中加上以下代碼

globals: {
  uni: true;
}

vite.config.js 中 eslintPlugin 配置

import eslintPlugin from 'vite-plugin-eslint'
export default defineConfig({
  plugins: [
  	eslintPlugin({
      cache: true,
      include: ['src/**/*.js', 'src/**/*.vue', 'src/*.js', 'src/*.vue', 'src/*.nvue'],
      failOnError: false // eslint報錯不影響運行
    }),
  ]

Pinia^[2]

安裝

註意：在這個項目中安裝的 vue 版本是：3.2.47，pinia：3.1 及以上版本需要依賴 vue：3.3 及以上版本才能運行成功。

@REM npm 安裝
npm i [email protected]
@REM node 安裝
yarn add [email protected]

安裝依賴時出現如下報錯可嘗試通過參考文章解決：npm 安裝依賴時出現 Peer Dependencies 衝突報錯

While resolving: [email protected]
Found: [email protected]
node_modules/vue
  peer vue@"^3.2.25" from @vitejs/[email protected]
  node_modules/@vitejs/plugin-vue
    ...

Conflicting peer dependency: [email protected]
node_modules/vue
  peer vue@">= 2.5 < 2.7" from @vue/[email protected]
  node_modules/@vue/composition-api
    peerOptional @vue/composition-api@"^1.4.0" from [email protected]
    node_modules/pinia
      pinia@"2.0.34" from the root project

Fix the upstream dependency conflict, or retry
this command with --force or --legacy-peer-deps
to accept an incorrect (and potentially broken) dependency resolution.

Luch-Request^[3]

uniapp 原生的 uni.request 使用比較麻煩，它並非使用 Promise 的形式也不支持請求攔截和相應攔截的配置，而 luch-request 基於 Promise 對象實現更簡單的 request 使用方式，支持請求和響應攔截

• 支持全局掛載
• 支持多個全局配置實例
• 支持自定義驗證器
• 支持文件上傳/下載
• 支持 task 操作
• 支持自定義參數
• 支持多攔截器
• 對參數的處理比 uni.request 更強

安裝

npm install luch-request -S

Sass 支持^[4]

安裝

npm i sass sass-loader -D

unplugin-auto-import^[5]

unplugin-auto-import 是為 Vite、Webpack、Rollup 和 esbuild 按需自動導入 API，同時支持 TypeScript。
使用它在 vue3 項目中使用預設導入的 api 就不需要 import，可以通過預設自動導入模塊，增強開發體驗

安裝

npm i -D unplugin-auto-import

在 Vite.config.js 中加入如下配置

import AutoImport from "unplugin-auto-import/vite";
export default defineConfig({
  plugins: [
    AutoImport({
      // 需要自動引入的文件
      include: [
        /\.[j]sx?$/,
        /\.vue$/,
        /\.vue\?vue/,
        /\.nvue$/,
        /\.nvue\?nvue/,
        /\.md$/,
      ],
      // 全局自動引入api預設
      imports: [
        // 插件預設支持導入的api
        "vue",
        // 'vue-router',
        "pinia",
        "uni-app",
        // 自定義導入的api
      ],
      // eslint配置
      eslintrc: {
        enabled: true, // Default `false`
        filepath: "./.eslintrc-auto-import.json", // Default `./.eslintrc-auto-import.json`
        globalsPropValue: true, // Default `true`, (true | false | 'readonly' | 'readable' | 'writable' | 'writeable')
      },
      dts: "./auto-imports.d.ts",
      // dts:false
    }),
  ],
});

生成 eslint 配置文件並使用

通過執行命令npm run dev:h5 運行項目，運行成功時項目根目錄會生成auto-imports.d.ts和.eslintrc-auto-import.json兩個文件，然後在.eslintrc.js 文件中的 extends 屬性中，引入該文件

extends: [
  'standard',
  'plugin:vue/vue3-essential',
  './.eslintrc-auto-import.json'
]

註意：引入後需重新運行項目才能生效

添加預設和開發環境變數文件

在項目根目錄添加.env 和.env.development 文件，以配置環境變數
詳細配置教程可參照官網：Vite 環境變數和模式

配置 UI 庫 uni-ui^[6]

安裝

npm i @dcloudio/uni-ui

配置

vite.config.js

註意 cli 項目預設是不編譯 node_modules 下的組件的，導致條件編譯等功能失效 ，導致組件異常 需要在 vite.config.js 增加 @dcloudio/uni-ui 包的編譯即可正常

transpileDependencies: ["@dcloudio/uni-ui"];

pages.json

正常來說這樣子引入的話，使用組件時，需要在頁面處 import 才可以使用，然而可以通過 npm+easycom 的形式來全局引入組件。在 pages.json 中加入如下代碼，即可在使用組件而不需在頁面處 import。

"easycom": {
	"autoscan": true,
	"custom": {
		"^uni-(.*)": "@dcloudio/uni-ui/lib/uni-$1/uni-$1.vue"
	}
}

項目到這裡就結束了，這裡提供該項目的 github 地址，方便拉取直接使用

這個項目中 master 分支中使用的 Eslint 風格為 Standard，而 prettier 分支使用的風格為 Prettier

https://github.com/luxigaola/my-uniapp-project