# TypeScript 开发环境搭建

WARNING

  • 使用 npm 初始化项目
  • 全局安装部分依赖
  • 使用 tsc 初始化配置
  • 配置 webpack
  • 添加开发和打包命令

新建 demo 目录使用 npm 初始化项目生成 package.json 文件

npm init --yes
1

使用 npm 全局安装 typescript tslint

npm i typescript tslint -g
1

编译一个ts文件

tsc index.ts
1

生成 tsconfig.json

tsc --init
1

添加 webpack

npm i webpack webpack-cli webpack-dev-server -D
1

安装其他依赖并指定本地开发指令

npm i ts-loader cross-env html-webpack-plugin clean-webpack-plugin -D
1

指定开发命令

"start": "cross-env NODE_ENV=development webpack-dev-server --config ./build/webpack.config.js", 

"build": "cross-env NODE_ENV=production webpack --config ./build/webpack.config.js"
1
2
3

webpack.config.js

const HtmlWebpackPlugin = require('html-webpack-plugin')
const { CleanWebpackPlugin } = require('clean-webpack-plugin')
const webpack = require('webpack')
const path = require('path')
module.exports = {
	entry: './src/index.ts',
	output: {
		publicPath: '/',
		filename: "main.js",
		path: path.resolve(__dirname, "../dist"),
		// clean: true,
	},
	resolve: {
		extensions: ['.tsx','.ts', '.js']
	},
	module: {
		rules: [
			{
				test: /\.tsx?$/,
				use: 'ts-loader',
				exclude: /node_modules/
			}
		]
	},
	devServer: {
		static: {
			directory: path.join(__dirname, '../dist')
		},
		compress: false,
		host: 'localhost',
		port: '3008',
		hot: true
	},
	plugins: [
		new CleanWebpackPlugin(),
		new webpack.ProgressPlugin(),
		new HtmlWebpackPlugin({
			template: path.resolve(__dirname, '../src/template/index.html'),
			filename: 'index.html'
		}),
	],
	// stats: 'errors-only',
	devtool: process.env.NODE_ENV  === 'production' ? false : 'inline-source-map'
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

# tsconfig.json 编译配置项

执行 tsc 的时候,会根据 tsconfig.json 的配置


{
	"include": ["./xxx"], // 指定编译文件,不配置,默认根目录 
	"compilerOptions": {
		/* Visit https://aka.ms/tsconfig.json to read more about this file */
		
		/* Projects */
		// "incremental": true, // 增量编译,只编译新增的内容                             /* Enable incremental compilation */
		// "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
		// "tsBuildInfoFile": "./",                          /* Specify the folder for .tsbuildinfo incremental compilation files. */
		// "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects */
		// "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
		// "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
		
		/* Language and Environment */
		"target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
			// "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
			// "jsx": "preserve",                                /* Specify what JSX code is generated. */
			// "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
			// "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
			// "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
			// "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
			// "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
			// "reactNamespace": "",                             /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
			// "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
			// "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
			
			/* Modules */
			"module": "commonjs",                                /* Specify what module code is generated. */
			"rootDir": "./src",  // 编译目录                                /* Specify the root folder within your source files. */
			// "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
			// "baseUrl": "./",// 指定根路径                                  /* Specify the base directory to resolve non-relative module names. */
			// "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
			// "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
			// "typeRoots": [],                                  /* Specify multiple folders that act like `./node_modules/@types`. */
			// "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
			// "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
			// "resolveJsonModule": true,                        /* Enable importing .json files */
			// "noResolve": true,                                /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */
			
			/* JavaScript Support */
			// "allowJs": true,// 是否对js也编译                                   /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
			// "checkJs": true,// 是否对js语法进行检测                                  /* Enable error reporting in type-checked JavaScript files. */
			// "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */
			
			/* Emit */
			// "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
			// "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
			// "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
			// "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
			// "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
			"outDir": "./dist", // 输出目录                                  /* Specify an output folder for all emitted files. */
            // "removeComments": true,                           /* 编译后去除注释 */
			// "noEmit": true,                                   /* Disable emitting files from a compilation. */
			// "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
			// "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types */
			// "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
			// "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
			// "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
			// "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
			// "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
			// "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
			// "newLine": "crlf",                                /* Set the newline character for emitting files. */
			// "stripInternal": true,                            /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
			// "noEmitHelpers": true,                            /* Disable generating custom helper functions like `__extends` in compiled output. */
			// "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
			// "preserveConstEnums": true,                       /* Disable erasing `const enum` declarations in generated code. */
			// "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
			// "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
			
			/* Interop Constraints */
			// "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
			// "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
			"esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */
			// "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
			"forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
			
			/* Type Checking */
			"strict": true,                                      /* Enable all strict type-checking options. */
			// "noImplicitAny": true,  // 是否明确指定 any 类型                           /* Enable error reporting for expressions and declarations with an implied `any` type.. */
			// "strictNullChecks": true,// 是否强制检查 null 类型                         /* When type checking, take into account `null` and `undefined`. */
			// "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
			// "strictBindCallApply": true,                      /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
			// "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
			// "noImplicitThis": true,                           /* Enable error reporting when `this` is given the type `any`. */
			// "useUnknownInCatchVariables": true,               /* Type catch clause variables as 'unknown' instead of 'any'. */
			// "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
			// "noUnusedLocals": true,// 检测是否有,局部变量没使用                           /* Enable error reporting when a local variables aren't read. */
			// "noUnusedParameters": true,// 检测是否有,函数参数定义了没使用                       /* Raise an error when a function parameter isn't read */
			// "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
			// "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
			// "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
			// "noUncheckedIndexedAccess": true,                 /* Include 'undefined' in index signature results */
			// "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
			// "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type */
			// "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
			// "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
			
			/* Completeness */
			// "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
			"skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
	}
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104