TypeScript React Webpack Combination

Use TS React Webpack together

Posted by ZeFeng on October 9, 2018

前言

这篇文章我们主要讲解如何使用TS与已经使用React以及webpack的项目结合使用。

正文

初始化项目结构

首先我们新建一个名字为myTsProj的文件夹,命令如下:

mkdir myTsProj

cd myTsProj

接下来创建src文件夹,用来放TS文件。然后在src文件夹里面创建components文件夹,用来放我们自己自定义的组件。

mkdir src
cd src
mkdir components
cd ..

Webpack会帮助我们生成dist目录。经webpack处理,会生成bundle.js文件放在dist目录下。
最后看到的文件如下:

proj/
├─dist/
└─ src/   
  └─components/

初始化工程

安装,使用默认值就可以了。也可以在生成的 package.json文件里修改。

npm init

安装依赖

1、要确保我们有安装webpack,如果没有安装,执行下面的命令:

npm install -g webpack

Webpack可以将所有代码和可选择地将依赖捆绑成一个单独的.js文件,如果还不了解Webpack,可以看这里
2、接着添加React和React-DOM以及它们的声明文件到package.json文件里做为依赖,执行下面命令:

npm install --save react react-dom @types/react @types/react-dom

(说明: 这个命令使用@types/前缀表示要额外获取React和React-DOM的声明文件。 通常导入像 “react”这样的路径,它会查看react包; 然而,并不是所有的包都包含了声明文件,所以TS还会查看 @types/react包。 之后将不必在意这些了。)
3、最后,我们要添加开发时依赖awesome-typescript-loader和source-map-loader。

npm install --save-dev typescript awesome-typescript-loader source-map-loader

(说明:awesome-typescript-loader可以让Webpack使用TypeScript的标准配置文件 tsconfig.json编译TypeScript代码。 source-map-loader使用TypeScript输出的sourcemap文件来告诉webpack何时生成 自己的sourcemaps。 这就允许我们在调试最终生成的文件时就好像在调试TypeScript源码一样。)

添加TypeScript配置文件

我们想将我们写的源码和必要的TypeScript文件整合到一起,这就需要创建一个tsconfig.json文件。(包含了输入文件列表以及编译选项)
在myTsProj的根目录下新建 tsconfig.json文件,里面配置如下:

{ 
  "compilerOptions":{        
    "outDir": "./dist/",        
    "sourceMap": true,
    "noImplicitAny": true,
    "module": "commonjs",        
    "target": "es5",
    "jsx": "react"    
  },   
  "include": [
    "./src/**/*"
  ]
}

编写代码

首先在 src/components目录下创建一个Demo.tsx的文件,代码如下:

import * as React from "react";
export interface DemoProps { compiler: string; framework: string;}
export const Demo = (props: DemoProps) => <h1>Hello from {props.compiler} and {props.framework}!</h1>;
 

这个例子使用了无状态的功能组件,我们可以让它更像一点类。

import * as React from "react";
export interface DemoProps { compiler: string; framework: string;}
// 'DemoProps ' describes the shape of props.
// State is never set so we use the '{}' type.
export class Demo extends React.Component<DemoProps , {}> {
  render() {
    <h1>Hello from {props.compiler} and {props.framework}!</h1>;
  }
}

接下来,在src下创建index.tsx文件,代码如下:

import * as React from "react";
import * as ReactDOM from "react-dom";
import { Demo } from "./components/Demo";
ReactDOM.render(
<Demo compiler="TypeScript" framework="React" />,
document.getElementById("app")

注意:
我们仅仅将Demo组件导入index.tsx。 不同于 “react”或”react-dom”,我们使用Demo.tsx的相对路径 - 这很重要。 如果不这样做,TypeScript只会尝试在 node_modules文件夹里查找。
我们还缺一个页面来显示Demo组件。 在myTsProj根目录创建一个名为index.html的文件,代码如下:

<!DOCTYPE html>
<html>
  <head>
    <meta charset="UTF-8" />
    <title>React TS Demo!</title>
  </head>    
  <body>        
    <div id="app"></div>        
    <!-- Dependencies -->
    <script src="./node_modules/react/umd/react.development.js"></script>
    <script src="./node_modules/react-dom/umd/react-dom.development.js"></script>        
    <!-- Main -->        
    <script src="./dist/bundle.js"></script>    
  </body>
</html>

需要注意一点我们是从node_modules引入的文件。 React和React-DOM的npm包里包含了独立的 .js文件,你可以在页面上引入它们,这里我们为了快捷就直接引用了。 可以随意地将它们拷贝到其它目录下,或者从CDN上引用。

创建webpack配置文件

做到这里,我们还差最后一步。
在myTsProj根目录下创建webpack.config.js文件,代码如下:

module.exports = {
    entry: "./src/index.tsx",
    output: {
        filename: "bundle.js",
        path: __dirname + "/dist"
    },

    // Enable sourcemaps for debugging webpack's output.
    devtool: "source-map",

    resolve: {
        // Add '.ts' and '.tsx' as resolvable extensions.
        extensions: [".ts", ".tsx", ".js", ".json"]
    },

    module: {
        rules: [
            // All files with a '.ts' or '.tsx' extension will be handled by 'awesome-typescript-loader'.
            { test: /\.tsx?$/, loader: "awesome-typescript-loader" },

            // All output '.js' files will have any sourcemaps re-processed by 'source-map-loader'.
            { enforce: "pre", test: /\.js$/, loader: "source-map-loader" }
        ]
    },

    // When importing a module whose path matches one of the following, just
    // assume a corresponding global variable exists and use that instead.
    // This is important because it allows us to avoid bundling all of our
    // dependencies, which allows browsers to cache those libraries between builds.
    externals: {
        "react": "React",
        "react-dom": "ReactDOM"
    },
};

之所以添加externals字段,因为我们想要避免把所有的React都放到一个文件里,那样会增加编译时间并且浏览器还能够缓存没有发生改变的库文件。

webpack允许我们使用通过这种方式写的代码库。 通过我们的设置 “react”: “React”,webpack会神奇地将所有对”react”的导入转换成从React全局变量中加载。

运行

最后我们只需要执行一个命令:

webpack

在浏览器里打开index.html,应该已经可以用了! 你可以看到页面上显示着:
“Hello from TypeScript and React!”

相信大家对TS已经有一定了解了,可以到官网深入学习TS了。官网链接


Reward