koa TS ESLint搭建服务器重构版过程详解

目录初始化项目目录安装项目运行所需要的软件包修改package.json从.env中加载环境变量配置路径别名用法目录规范编码风格规范Eslint初始化项目目录yarninit-y安装项目运行所需要...

目录

初始化项目目录

yarn init -y

安装项目运行所需要的软件包

yarn add koa koa-router cross-env module-alias dotenv

koa：搭建 Koa 服务的核心软件包。

koa-router：Koa 路由软件包。

koa-bodyparser：解析 POST 请求参数的软件包。

cross-env：为项目添加不同的运行环境。

module-alias：可以像在 vue 和 React 中一样使用路径别名。

dotenv：加载项目根目录下的.env中的配置。

koa-cors：跨域资源处理。

copyfiles：拷贝一些无法打包的资源。因为tsc只能编译打包TypeScript代码，其余文件无法一同构建到dist文件夹。

ts-node-dev：和 nodemon功能类似，只不过该软件包支持运行ts文件。想要监听文件变化需要加上--respawn参数。

typescript：TypeScript 环境支持。

npm-run-all：支持同时运行多个npm指令。

@types/node：node编码辅助。

执行npx tsc --init生成tsconfig.json：我使用的配置如下，大家可以根据自己的需求配置。

{
 "compilerOptions": {
    "target": "esnext", // 目标语言版本
    "module": "commonjs", // 指定生成代码的模板标准
    "sourceMap": true,
    "outDir": "./dist", // 指定输出目录, 默认是dist文件夹
    "rootDir": "./src",  
    "strict": true,
    "esModuleInterop": true,
    "allowSyntheticDefaultImports": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
 },
 // 需要编译的的文件和目录
 "include": ["src"],
 "exclude": ["node_modules", "dist", "public"]
}

import "module-alias/register";

yarn add eslint -D
# 初始化Eslint的配置文件，会在项目根目录下生成Eslint的配置文件
npx eslint --init

"script": {
//......
"lint:fix": "eslint --fix --ext .js,.ts,.tsx ."
}

dist
node_modules
.idea
.DS_Store