关于这篇文章

在使用NodeJS环境进行服务器端应用程序开发时，
以下是向新项目（仓库）引入TypeScript、格式化工具（Prettier）、检查工具（ESLint）和单元测试工具（Jest）的步骤备忘录。
※预计将根据需要进行适当的修改和调整。

操作步骤

生成 package.json

npm init -y

引入TypeScript

安装TypeScript本体和NodeJS内置功能的类型定义包。

npm install --save-dev typescript @types/node

设置 tsconfig.json

使用以下命令将生成带有注释的 tsconfig.json 文件，然后可以更改一些设置。

npx tsc --init

以下是一个配置示例，将源代码放置在 src 目录中，生成物放置在 dist 目录中。

{
    "compilerOptions": {
        "incremental": true,
        "tsBuildInfoFile": "./.tsbuildinfo",

        "target": "ES2021",
        "lib": ["ES2021"],
        "experimentalDecorators": true,
        "emitDecoratorMetadata": true,

        "module": "commonjs",
        "moduleResolution": "node",
        "rootDir": "./src",
        "baseUrl": "./src",
        "paths": {
            "~/*": ["./*"]
        },
        "resolveJsonModule": true,
        "allowJs": true,
        "checkJs": true,
        "outDir": "./dist",

        "isolatedModules": true,
        "esModuleInterop": true,
        "forceConsistentCasingInFileNames": true,

        "strict": true,
        "noUnusedLocals": true,
        "noUnusedParameters": true,
        "exactOptionalPropertyTypes": true,
        "noImplicitReturns": true,
        "noFallthroughCasesInSwitch": true,
        "noUncheckedIndexedAccess": true,
        "noImplicitOverride": true,
        "noPropertyAccessFromIndexSignature": true,
        "allowUnusedLabels": false,
        "allowUnreachableCode": false,

        "skipLibCheck": true
    },
    "include": ["./src"],
    "exclude": ["node_modules", "./dist"]
}

请参考官方文档以获得各项目的更详细说明。

添加一种工具，方便在TypeScript开发中快速执行。

npm install --save-dev ts-node ts-node-dev tsconfig-paths

通常情况下，在TypeScript项目中通常会添加以下内容：

ts-node：可以直接运行TS文件的工具
ts-node-dev：在进行代码修改时自动重新启动（watch）的工具，常用于服务器程序开发等
tsconfig-paths：用于在运行时解析路径别名的工具

通过传递 -r tsconfig-paths/register ，可以解析路径别名并执行。

ts-node -r tsconfig-paths/register src/main.ts
ts-node-dev -r tsconfig-paths/register src/main.ts

# パスエイリアスを使用したTSをコンパイルしたJS実行時に
TS_NODE_BASEURL=dist node -r tsconfig-paths/register dist/main.js

在 package.json 的 scripts 中添加

可以将主要脚本注册到 package.json 的 scripts 中，以使用简短的命令 npm run dev 来启动。

  "scripts": {
      ...
+     "dev": "ts-node-dev -r tsconfig-paths/register src/main.ts",
      ...
  },

在中文中導入”格式化程式（Prettier）”。

将格式化工具Prettier添加到项目中。

npm install --save-dev prettier

设置 .prettierrc.js

根据项目规定来更改设定值。

/** @type {import("prettier").Config} */
module.exports = {
    printWidth: 120,
    tabWidth: 4,
    useTabs: false,
    semi: true,
    singleQuote: false,
    quoteProps: "consistent",
    jsxSingleQuote: false,
    trailingComma: "all",
    bracketSpacing: true,
    bracketSameLine: false,
    arrowParens: "always",
};

添加 package.json 文件中的 scripts 部分

在 package.json 中添加一个只执行检查的 lint 脚本和一个用于进行修正的 fix 脚本。

  "scripts": {
      ...
+     "lint": "prettier -l src",
+     "fix": "prettier -w src",
      ...
  }

引入测试工具（Jest）。

将Jest添加到项目中，并添加ts-jest和类型定义以支持TypeScript。

npm install --save-dev jest @types/jest ts-jest

新增 jest.config.js 設定檔

生成 TypeScript 的配置文件

npx ts-jest config:init

为了让生成的 jest.config.js 支持路径别名，进行如下修改。

const { pathsToModuleNameMapper } = require("ts-jest");
const { loadConfig } = require("tsconfig-paths");

const tsconfig = loadConfig();

/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
module.exports = {
    preset: "ts-jest",
    testEnvironment: "node",

    // paths
    moduleNameMapper: pathsToModuleNameMapper(tsconfig.paths, {
        prefix: tsconfig.absoluteBaseUrl,
    }),
};

添加 package.json 文件中的 scripts

可以在 package.json 中添加，以便可以使用 npm run test 运行
（如果不添加选项，可能没有太大意义，因为它比 npx jest 更长…）

  "scripts": {
      ...
+     "test": "jest",
      ...
  }

引入代码检查工具ESLint

添加ESLint

为了支持TypeScript，我们需要添加typescript-eslint。
为了添加import顺序的规则，我们需要添加eslint-plugin-import。
为了禁用与prettier冲突的eslint规则，我们需要添加eslint-config-prettier。
此外，还需要添加eslint-plugin-jest来添加针对jest的规则。

npm install --save-dev eslint \
  @typescript-eslint/parser @typescript-eslint/eslint-plugin \
  eslint-plugin-import eslint-import-resolver-typescript \
  eslint-config-prettier eslint-plugin-jest

新增 .eslintrc.js 設定檔

将每个插件的建议规则放在extends中，以便将不适用或缺失的规则禁用/添加到rules中，以适配项目开发。

/** @type {import("eslint").Linter.Config} */
module.exports = {
    env: {
        node: true,
        commonjs: true,
        es2021: true,
        jest: true,
    },
    plugins: [
        //
        "@typescript-eslint",
        "import",
        "jest",
    ],
    parser: "@typescript-eslint/parser",
    parserOptions: {
        project: "./tsconfig.json",
    },
    settings: {
        "import/parsers": {
            "@typescript-eslint/parser": [".ts", ".tsx"],
        },
        "import/resolver": {
            typescript: true,
        },
    },
    extends: [
        "eslint:recommended",
        "plugin:@typescript-eslint/recommended",
        "plugin:import/recommended",
        "plugin:import/typescript",
        "plugin:jest/recommended",
        "prettier",
    ],
    rules: {},
};

修改 package.json 文件中的 scripts

使npm run lint命令来执行ESLint的检查
使npm run fix命令来执行ESLint规则违反的修正（仅限自动修复的内容）

  "scripts": {
      ...
-     "lint": "prettier -l src",
+     "lint": "prettier -l src && eslint src",
-     "fix": "prettier -w src",
+     "fix": "prettier -w src && eslint src --fix",
      ...
  }