集册 TypeScript 中文手册 React与webpack

React与webpack

—— 初始化项目结构

Xebcnor     最近更新时间：2020-08-04 05:37:59

285

让我们新建一个目录。

将会命名为proj，但是你可以改成任何你喜欢的名字。

mkdir proj
cd proj

我们会像下面的结构组织我们的工程：

proj/
   +- src/
   |    +- components/
   |
   +- dist/

TypeScript文件会放在src文件夹里，通过TypeScript编译器编译，然后经webpack处理，最后生成一个bundle.js文件放在dist目录下。

我们自定义的组件将会放在src/components文件夹下。

下面来创建基本结构：

mkdir src
cd src
mkdir components
cd ..
mkdir dist

初始化工程

现在把这个目录变成npm包。

npm init

你会看到一些提示。 你可以使用默认项除了开始脚本。 使用./dist/bundle.js做为开始脚本。 当然，你也可以随时到生成的package.json文件里修改。

安装依赖

首先确保TypeScript，typings和webpack已经全局安装了。

npm install -g typescript typings webpack

Webpack这个工具可以将你的所有代码和可选择地将依赖捆绑成一个单独的.js文件。 Typings是一个包管理器，它是用来获取定义文件的。

现在我们添加React和React-DOM依赖到package.json文件里：

npm install --save react react-dom

接下来，我们要添加开发时依赖ts-loader和source-map-loader。

npm install --save-dev ts-loader source-map-loader
npm link typescript

这些依赖会让TypeScript和webpack在一起良好地工作。 ts-loader可以让webpack使用TypeScript的标准配置文件tsconfig.json编译TypeScript代码。 source-map-loader使用TypeScript输出的sourcemap文件来告诉webpack何时生成自己的sourcemaps。 这就允许你在调试最终生成的文件时就好像在调试TypeScript源码一样。

链接TypeScript，允许ts-loader使用全局安装的TypeScript，而不需要单独的本地拷贝。 如果你想要一个本地的拷贝，执行npm install typescript。

最后，我们使用typings工具来获取React的声明文件：

typings install --global --save "dt~react"
typings install --global --save "dt~react-dom"

--global标记，还有dt~前缀，告诉Typings从DefinitelyTyped获取声明文件，它是一个由社区维护的.d.ts文件仓库。 这个命令会创建一个名为typings.json的文件和一个typings目录在当前目录下。

写一些代码

下面使用React写一段TypeScript代码。 首先，在src/components目录下创建一个名为Hello.tsx的文件，代码如下：

import * as React from "react";
import * as ReactDOM from "react-dom";

export class HelloComponent extends React.Component<any, any> {
    render() {
        return <h1>Hello from {this.props.compiler} and {this.props.framework}!</h1>;
    }
}

注意一点这个例子已经很像类了，我们不再需要使用类。 使用React的其它方式（比如无状态的功能组件）。

接下来，在src下创建index.tsx文件，源码如下：

import * as React from "react";
import * as ReactDOM from "react-dom";

import { HelloComponent } from "./components/Hello";

ReactDOM.render(
    <HelloComponent compiler="TypeScript" framework="React" />,
    document.getElementById("example")
);

我们仅仅将Hello组件导入index.tsx。 注意，不同于"react"或"react-dom"，我们使用index.tsx的相对路径 - 这很重要。

如果不这样做，TypeScript只会尝试在node_modules文件夹里查找。 其它使用React的方法也应该可以。

我们还需要一个页面来显示Hello组件。 在根目录proj创建一个名为index.html的文件，如下：

<!DOCTYPE html>
<html>
    <head>
        <meta charset="UTF-8" />
        <title>Hello React!</title>
    </head>
    <body>
        <div id="example"></div>

        <!-- Dependencies -->
        <script src="./node_modules/react/dist/react.js"></script>
        <script src="./node_modules/react-dom/dist/react-dom.js"></script>

        <!-- Main -->
        <script src="./dist/bundle.js"></script>
    </body>
</html>

需要注意一点我们是从node_modules引入的文件。 React和React-DOM的npm包里包含了独立的.js文件，你可以在页面上引入它们，这里我们为了快捷就直接引用了。 可以随意地将它们拷贝到其它目录下，或者从CDN上引用。 Facebook在CND上提供了一系列可用的React版本，你可以在这里查看更多内容。

添加TypeScript配置文件

现在，可以把所有TypeScript文件放在一起 - 包括我们编写的代码和必要的typings文件。

现在需要创建tsconfig.json文件，它包含输入文件的列表和编译选项。 在根目录下执行下在命令：

tsc --init ./typings/main.d.ts ./src/index.tsx --jsx react --outDir ./dist --sourceMap --noImplicitAny

你可以在这里学习到更多关于tsconfig.json。

创建webpack配置文件

新建一个webpack.config.js文件在工程根目录下。

展开阅读全文