TypeScript + Webpack 4 开发环境搭建

时间 2019-12-19

标签 typescript webpack 开发环境搭建繁體版

原文原文链接

前段时间接触到 Microsoft 的 Microsoft.AspNetCore.SpaTemplates 模板，生成的项目使用的默认语言是 TypeScript，虽然之前在此以前并无用过TypeScript，但第一看上去有种很熟悉的感受。固然，也有人说 TypeScript 是 JavaScript 版本的C#，无论怎么说，有了学习的兴趣。另外，听说新版的webpack 4相比之前的版本的更快的打包速度，因而就有了把它们结合在一块儿使用的想法。javascript

准备工做

请事先安装好 Node.js
新建项目文件夹，按住 Shift 键不放手，在文件夹空白处单击鼠标右键，选择 在此处打开Powershell窗口html

使用npm 安装相应的模块

webpack 4 须要安装 webpack、webpack-cli 和 typescript 等必要的模块。为了使用 webpack 处理 typescript，还须要 ts-loader。
在上面打开的 Powershell 窗口中输入如下命令java

一、初始化项目：node

npm init

回答一系列的问题（也能够直接回车使用默认值）后，在当前项目文件夹中会出现一个package.json的配置文件。文件内容大概以下所示：webpack

{
  "name": "webpacktypescript",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "dependencies": {
    "ts-loader": "^4.2.0",
    "typescript": "^2.8.1",
    "webpack": "^4.6.0",
    "webpack-cli": "^2.0.14"
  },
  "devDependencies": {},
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "ISC"
}

二、安装须要的各个模块：web

npm install webpack webpack-cli typescript ts-loader --save-dev

回答一系列的问题（也能够直接回车使用默认值）后，在当前项目文件夹中会出现一个package.json的配置文件。文件内容大概以下所示：typescript

{
  "name": "webpacktypescript",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "dependencies": {
    "ts-loader": "^4.2.0",
    "typescript": "^2.8.1",
    "webpack": "^4.6.0",
    "webpack-cli": "^2.0.14"
  },
  "devDependencies": {},
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "ISC"
}

三、添加 TypeScript 的配置文件 tsconfig.jsonshell

启动 WebStorm 并打开项目，在项目名称上单击鼠标右键 -> New -> tsconfig.json, 添加TypeScipt的配置文件，内容以下所示：npm

{
  "compilerOptions": {
    "module": "commonjs",
    "target": "es5",
    "sourceMap": true
  },
  "exclude": [
    "node_modules"
  ]
}

四、添加index.html及默认的 src/index.js文件
在项目文件夹中添加html文件，并命名为：'index.html',并编辑文件内容以下所示：json

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>TypeScript + Webpack 4</title>
</head>
<body>

<script src="dist/main.js"></script>
</body>
</html>

在项目文件夹中添加名字为src的文件夹，并在该文件夹中添加名字为index.js的JavaScript文件,文件内容以下所示：

console.log("Hello TypeScript!");

完成以上操做后项目的结构以下所示：

webpackwithtypescript
  |- src
    |- index.js
  |- index.html
  |- package.json
  |- package-lock.json
  |- tsconfig.json

五、使用webpack-cli打包项目

在控制台窗口(Powershell窗口 或WebStorm的Terminal 均可以) 输入如下命令进行打包：

npx webpack

控制台显示内容以下所示：

D:\SPAProjects\webpacktypescript>npx webpack
npx: installed 1 in 11.482s
The "path" argument must be of type string
D:\SPAProjects\webpacktypescript\node_modules\webpack\bin\webpack.js
Hash: 7dffdd50a425c0f906c2
Version: webpack 4.6.0
Time: 579ms
Built at: 2018-04-18 14:23:26
  Asset       Size  Chunks             Chunk Names
main.js  577 bytes       0  [emitted]  main
Entrypoint main = main.js
[0] ./src/index.js 33 bytes {0} [built]

打包成功，项目文件夹中会多出 dist/main.js - 这也正是 webpack 4 未指定输出文件时默认的位置。此时在浏览器中打开index.html，并在浏览器中按下F12，进入控制台将会看到 consolr.log() 语句的输出结果。

此时的项目文件夹结构：

webpackwithtypescript
    |- dist
       |- main.js
    |- src
       |- index.js
    |- index.html
    |- package.json
    |- package-lock.json
    |- tsconfig.json

webpack 4 没有配置文件时，使用src/index.js做为默认入口，同时使用dist/main.js做为默认出口。
因为TyepScript文件的默认扩展名为.ts，因此并不适合于没有配置文件的默认情况。

六、webpack 配置文件
在项目文件夹中添加名为webpack.config.js的JavaScript文件，并编辑其内容如如下所示：

const path = require('path');

module.exports = {
    mode: 'development',

    entry: './src/index.ts',
    output: {
        filename: 'main.js',
        path: path.resolve(__dirname, 'dist')
    },

    module: {
        rules: [{
            test: /\.ts$/,
            use: "ts-loader"
        }]
    },
    resolve: {
        extensions: [
            '.ts'
        ]
    }
};

同时修改package.json如如下内容所示：

{
  "name": "webpacktypescript",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "dependencies": {
    "ts-loader": "^4.2.0",
    "typescript": "^2.8.1",
    "webpack": "^4.6.0",
    "webpack-cli": "^2.0.14"
  },
  "devDependencies": {},
  "scripts": {
    "build": "webpack",   //添加这一行
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "ISC"
}

完成以上的设置，而后将src/index.js更名为src/index.ts。

webpackwithtypescript
    |- dist
       |- main.js
    |- src
       |- index.ts
    |- index.html
    |- package.json
    |- package-lock.json
    |- tsconfig.json

使用npm run build命令编译、打包src/index.ts文件：

D:\SPAProjects\webpacktypescript>npm run build

> webpacktypescript@1.0.0 build D:\SPAProjects\webpacktypescript
> webpack

Hash: 9bf0b33a5a6b242a917e
Version: webpack 4.6.0
Time: 1683ms
Built at: 2018-04-18 15:03:36
  Asset      Size  Chunks             Chunk Names
main.js  2.84 KiB    main  [emitted]  main
Entrypoint main = main.js
[./src/index.ts] 35 bytes {main} [built]

在控制台窗口能够输入npm run build指令进行打包时，项目中src文件夹中的ts文件index.ts被编译，并输出为 dist/main.js。