webpack/4、配置ts与vue3环境

258 阅读2分钟

项目初始化

在根项目创建以下几个文件。

package.json

根目录创建并编辑package.json,内容如下:

{
  "name": "xxxx",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "build": "cross-env publicPath=. webpack --config ./webpack.config.build.js",
    "dev": "cross-env DOMAIN=qa webpack serve --config ./webpack.config.dev.js"
  },
  "author": "",
  "license": "ISC",
  "devDependencies": {
    "@babel/core": "^7.20.5",
    "@babel/preset-env": "^7.20.2",
    "@types/axios": "^0.14.0",
    "@vue/compiler-sfc": "^3.2.47",
    "babel-loader": "^9.1.0",
    "clean-webpack-plugin": "^4.0.0",
    "cross-env": "^7.0.3",
    "css-loader": "^6.7.2",
    "html-webpack-plugin": "^5.5.0",
    "less": "3.9.0",
    "less-loader": "5.0.0",
    "style-loader": "^3.3.1",
    "style-resources-loader": "^1.5.0",
    "ts-loader": "^9.4.2",
    "typescript": "^4.9.4",
    "vue-loader": "^17.0.1",
    "webpack": "^5.75.0",
    "webpack-cli": "^5.0.1",
    "webpack-dev-server": "^4.11.1",
    "webpack-merge": "^5.8.0"
  },
  "dependencies": {
    "axios": "^1.2.1",
    "vue": "^3.2.36"
  }
}

tsconfig.json

根目录创建并编辑tsconfig.json,内容如下:

{
  "compilerOptions": {
    "module": "es6",
    "target": "ES2016",
    "jsx": "react",
    "baseUrl": "./",
    "resolveJsonModule": true,
    "allowSyntheticDefaultImports":true,
    "paths": {
      "@/*": ["src/*"]       
    },
    "moduleResolution":"node",
  },
}

webpack.config.base.js

根目录创建并编辑webpack.config.base.js,内容如下:

const path = require('path');
const { CleanWebpackPlugin } = require('clean-webpack-plugin');
const { DefinePlugin } = require('webpack');
const HtmlWebpackPlugin = require('html-webpack-plugin');
const { VueLoaderPlugin } = require('vue-loader')
module.exports = {
    entry: path.resolve(__dirname, './src/main.ts'),
    output: {
        path: path.resolve(__dirname, 'dist'),
        publicPath: process.env.publicPath,
        filename: '[name].bundle.js',
    },
    module: {
        rules: [
            {
                test: /\.ts$/,
                loader: 'ts-loader',
                exclude: /node_modules/, // 不编译node_modules下的文件
                options: { appendTsSuffixTo: [/\.vue$/] }
            },
            {
                test: /\.js$/,
                exclude: /node_modules/, // 不编译node_modules下的文件
                loader: 'babel-loader'
            },
            {
                test: /\.vue$/,
                exclude: /node_modules/, // 不编译node_modules下的文件
                loader: 'vue-loader'
            },
            {
                test: /\.css$/i,
                use: ['style-loader', 'css-loader'],
            },
            {
                test: /\.less$/,
                use: [
                    'style-loader',
                    'css-loader',
                    'less-loader',
                    {
                        loader: 'style-resources-loader',
                        options: {
                            patterns: path.resolve(__dirname, './src/style/variables.less'),
                            injector: 'append'
                        }
                    }
                ]
            },
            {
                test: /\.(png|svg|jpg|jpeg|gif)$/i,
                type: 'asset/resource',
            },
        ],
    },
    plugins: [
        new CleanWebpackPlugin(),
        // 将node的环境变量注入到浏览器的环境变量中
        new DefinePlugin({
            'process.env.DOMAIN': JSON.stringify(process.env.DOMAIN),
        }),
        new HtmlWebpackPlugin({
            template: path.resolve(__dirname, './index.html'),
        }),
        new VueLoaderPlugin()
    ],
    resolve: {
        alias: {
            '@': path.resolve(__dirname, './src'),
        },
        extensions: ['.ts', '.js'],
    },
    externals: {
    }
}

webpack.config.dev.js

根目录创建并编辑webpack.config.dev.js,内容如下:

const path = require('path');
const { merge } = require('webpack-merge');
const webpackBase = require('./webpack.config.base.js');
module.exports = merge(webpackBase, {
    mode: 'development',
    devtool: 'inline-source-map',
    devServer: {
        static: {
            directory: path.join(__dirname, './dist'),
        },
        compress: true,
        port: 9000,
    },
    plugins: [
    ],
})

webpack.config.build.js

根目录创建并编辑webpack.config.build.js,内容如下:

const { merge } = require('webpack-merge');
const webpackBase = require('./webpack.config.base.js');
module.exports = merge(webpackBase, {
    mode: 'production',
})

index.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Document</title>
</head>
<body>
    <div id="root"></div>
</body>
</html>

src文件夹

在这个文件夹下创建如下文件

main.ts

import { createApp } from 'vue' // Vue 3.x 引入 vue 的形式
import App from './App.vue' // 引入 APP 页面组建

const app = createApp(App) // 通过 createApp 初始化 app
app.mount('#root') // 将页面挂载到 root 节点

App.vue

<script setup lang="ts">
import { reactive } from "vue";

const state = reactive({ count: 0 });

function add() {
  state.count++;
}

</script>
<template>
  <div @click="add">
    计数:{{ state.count }}
  </div>
</template>

shims-vue.d.ts

declare module '*.vue' {
  import type { DefineComponent } from 'vue'
  const component: DefineComponent<{}, {}, any>
  export default component
}

安装与运行

yarn
npm run dev

遇到的问题

ts2307: cannot find module './app.vue'

ts2307: cannot find module './app.vue' or its corresponding type declarations.

创建src/shims-vue.d.ts文件,内容如下:

declare module '*.vue' {
  import type { DefineComponent } from 'vue'
  const component: DefineComponent<{}, {}, any>
  export default component
}