webpack/3、配置ts与react环境

422 阅读2分钟

初始化

npm init

tsconfig.json

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

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

babel.config.js

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

module.exports = {
    presets: [
      "@babel/preset-env", 
      "@babel/preset-typescript",
      "@babel/preset-react",
    ],
}

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 packageJson = require('./package.json');
module.exports = {
    entry: path.resolve(__dirname, './src/main'),
    output: {
        path: path.resolve(__dirname, 'dist'),
        publicPath: process.env.publicPath,
        filename: '[name].bundle.js',
    },
    module: {
        rules: [
            {
                test: /\.(js|jsx|ts|tsx)$/,
                use: 'babel-loader',
                exclude: /node_modules/ // 不编译node_modules下的文件
            },
            {
                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'),
            title:packageJson.pageInfo.title,
            backgroundColor:packageJson.pageInfo.backgroundColor,
            script1:`<script crossorigin src="https://unpkg.com/react@17/umd/react.development.js"></script>`,
            script2:`<script crossorigin src="https://unpkg.com/react-dom@17/umd/react-dom.development.js"></script>`,
        }),
    ],
    resolve: {
        alias: {
            '@': path.resolve(__dirname, './src'),
        },
        extensions: ['.tsx','.jsx','.ts', '.js'],
    },
    devServer: {
        static: {
            directory: path.join(__dirname, './dist'),
        },
        compress: true,
        port: 9000,
    },
    externals:{
        'react':'React',
    }
}

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><%= htmlWebpackPlugin.options.title %></title>
    <%= htmlWebpackPlugin.options.script1 %> <%=
    htmlWebpackPlugin.options.script2 %>
  </head>

  <body
    style="background-color: <%= htmlWebpackPlugin.options.backgroundColor %>"
  >
    <div id="root"></div>
  </body>
  <script></script>
</html>

package.json

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

{
  "name": "gmu-react",
  "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"
  },
  "pageInfo": {
    "title": "gmu-react",
    "description": "测试",
    "backgroundColor": "#f38c07",
    "imgUrl": "https://boss-images.hitup.cn/boss/23811b6fdf0446c393d7bee8888e5c67.jpg",
    "type": "react-csr"
  },
  "author": "",
  "license": "ISC",
  "devDependencies": {
    "@babel/core": "^7.20.5",
    "@babel/preset-env": "^7.20.2",
    "@babel/preset-react": "^7.18.6",
    "@babel/preset-typescript": "^7.22.11",
    "@types/axios": "^0.14.0",
    "@types/react": "^18.0.26",
    "@types/react-dom": "^18.0.9",
    "axios": "^1.2.1",
    "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",
    "typescript": "^4.9.4",
    "webpack": "^5.75.0",
    "webpack-cli": "^5.0.1",
    "webpack-dev-server": "^4.11.1"
  },
  "dependencies": {
    "lottie-web": "5.7.7",
    "react": "17.0.0",
    "react-dom": "17.0.0",
    "webpack-merge": "^5.8.0"
  }
}

src文件夹

src/main.tsx

import * as React from 'react';
import * as ReactDOM from 'react-dom';
import Main from './App';

ReactDOM.render(
    <Main/>, 
    document.getElementById('root')
);

src/App.tsx

import * as React from 'react'

interface Props {
}
interface State {
}
export default (props:Props) => {
  return <div>hello</div>
}

安装相关模块

yarn

重要模块说明:

  1. babel-loader //使用Babel和webpack来转译JavaScript文件
  2. @babel/core //babel的核心模块
  3. @babel/preset-env //转译ES2015+的语法
  4. @babel/preset-react //转译react的JSX
  5. @babel/preset-typescript //转译ts语法

遇到的问题

1、项目中引用图片,ts提示图片找不到

【React】PNG文件找不到模块或其相应的类型声明

添加文件:src/types/image.d.ts,内容如下

declare module '*.svg'
declare module '*.png'
declare module '*.jpg'
declare module '*.jpeg'
declare module '*.gif'
declare module '*.bmp'
declare module '*.tiff'

2、项目中引用json文件报错

在tscong.json里面添加配置,如下

{
  "compilerOptions": {
    ...
    ...
    "resolveJsonModule": true,
    "allowSyntheticDefaultImports":true,
    ...
    ...
  },
}

参考资料

babel-preset-react

webpack关于ts的配置说明