背景
最近对项目中常用的一些工具方法进行封装，并通过npm进行管理。
创建依赖typescript的项目 项目地址
1、初始化
新建文件夹，并执行npm init -y
生成package.json文件
2、安装typescript
执行npm install typescript
3、添加tsconfig.json
代码如下，可以根据需要选择
{
"compilerOptions": {
/* Basic Options */
"target": "es5",
/* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */
"module": "commonjs",
/* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
"lib": [],
/* Specify library files to be included in the compilation. */
"allowJs": true,
/* Allow javascript files to be compiled. */
"checkJs": true,
/* Report errors in .js files. */
"jsx": "preserve",
/* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
"declaration": true,
/* Generates corresponding '.d.ts' file. */
"declarationMap": false,
/* Generates a sourcemap for each corresponding '.d.ts' file. */
"sourceMap": true,
/* Generates corresponding '.map' file. */
"outFile": "./",
/* Concatenate and emit output to single file. */
"outDir": "./dist/",
/* Redirect output structure to the directory. */
"rootDir": "./",
/* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
"composite": true,
/* Enable project compilation */
"removeComments": true,
/* Do not emit comments to output. */
"noEmit": true,
/* Do not emit outputs. */
"importHelpers": true,
/* Import emit helpers from 'tslib'. */
"downlevelIteration": true,
/* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
"isolatedModules": true,
/* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
/* Strict Type-Checking Options */
"strict": true,
/* Enable all strict type-checking options. */
"noImplicitAny": true,
/* Raise error on expressions and declarations with an implied 'any' type. */
"strictNullChecks": true,
/* Enable strict null checks. */
"strictFunctionTypes": true,
/* Enable strict checking of function types. */
"strictBindCallApply": true,
/* Enable strict 'bind', 'call', and 'apply' methods on functions. */
"strictPropertyInitialization": true,
/* Enable strict checking of property initialization in classes. */
"noImplicitThis": true,
/* Raise error on 'this' expressions with an implied 'any' type. */
"alwaysStrict": true,
/* Parse in strict mode and emit "use strict" for each source file. */
/* Additional Checks */
"noUnusedLocals": true,
/* Report errors on unused locals. */
"noUnusedParameters": true,
/* Report errors on unused parameters. */
"noImplicitReturns": true,
/* Report error when not all code paths in function return a value. */
"noFallthroughCasesInSwitch": true,
/* Report errors for fallthrough cases in switch statement. */
/* Module Resolution Options */
"moduleResolution": "node",
/* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
"baseUrl": "./",
/* Base directory to resolve non-absolute module names. */
"paths": {},
/* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
"rootDirs": [],
/* List of root folders whose combined content represents the structure of the project at runtime. */
"typeRoots": [],
/* List of folders to include type definitions from. */
"types": [],
/* Type declaration files to be included in compilation. */
"allowSyntheticDefaultImports": true,
/* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
"esModuleInterop": true,
/* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
"preserveSymlinks": true,
/* Do not resolve the real path of symlinks. */
/* Source Map Options */
"sourceRoot": "",
/* Specify the location where debugger should locate TypeScript files instead of source locations. */
"mapRoot": "",
/* Specify the location where debugger should locate map files instead of generated locations. */
"inlineSourceMap": true,
/* Emit a single file with source maps instead of having a separate file. */
"inlineSources": true,
/* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
/* Experimental Options */
"experimentalDecorators": true,
/* Enables experimental support for ES7 decorators. */
"emitDecoratorMetadata": true,
/* Enables experimental support for emitting type metadata for decorators. */
},
"exclude": [
"node_modules",
"*.d.ts",
"**/*.d.ts"
]
}
4、使用eslint进行代码检查
安装依赖
npm install eslint typescript-eslint-parser eslint-plugin-typescript eslint-config-alloy babel-eslint --save-dev
创建配置文件.eslintrc.js并写入规则
module.exports = {
parser: 'typescript-eslint-parser',
plugins: [
'typescript'
],
rules: {
// @fixable 必须使用 === 或 !==，禁止使用 == 或 !=，与 null 比较时除外
'eqeqeq': [
'error',
'always',
{
null: 'ignore'
}
],
// 类和接口的命名必须遵守帕斯卡命名法，比如 PersianCat
'typescript/class-name-casing': 'error'
}
}
这里我使用是 AlloyTeam ESLint 的 TypeScript 规则
5、添加配置，检查src目录下所有的ts文件
在package.json中增加配置
"scripts": {
"eslint": "eslint src --ext .ts"
}
此时执行 npm run eslint 即会检查 src 目录下的所有 .ts 后缀的文件