Node.jsプロジェクトをTypeScriptとExpressでセットアップする方法

Node.jsプロジェクトをTypeScriptとExpressでセットアップすることで、アプリケーションに構造、スケーラビリティ、明確さを与えることができます。このガイドでは、Node.jsプロジェクトの初期化、TypeScript、Expressの統合、そして必須の開発ツールの追加について、ステップバイステップで説明します。

ステップ1: Node.jsプロジェクトの初期化

プロジェクトフォルダを作成し、npmを初期化します：

mkdir my-node-project
cd my-node-project
npm init -y

これによりpackage.jsonが生成されます。次に、nodeモジュールとビルドファイルを除外する.gitignoreを作成します：

node_modules
dist

ステップ2: TypeScriptの追加

TypeScriptと関連する依存関係をインストールします：

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

以下のコマンドでTypeScript設定を作成します：

npx tsc --init

tsconfig.jsonを以下のように調整します：

{
  "compilerOptions": {
    "target": "ES2016",
    "module": "commonjs",
    "rootDir": "./src",
    "outDir": "./dist",
    "esModuleInterop": true,
    "strict": true,
    "skipLibCheck": true
  }
}

コード用のsrcフォルダを作成します：

mkdir src

ステップ3: Expressのセットアップ

Expressとその型定義をインストールします：

npm install express
npm install --save-dev @types/express

src/index.tsに基本的なサーバーを作成します：

import express, { Application, Request, Response } from 'express';

const app: Application = express();
const PORT = 3000;

app.get('/', (req: Request, res: Response) => {
  res.send('Hello, TypeScript + Express!');
});

app.listen(PORT, () => {
  console.log(`Server running at http://localhost:${PORT}`);
});

以下のコマンドで実行します：

npx ts-node src/index.ts

ステップ4: ESLintとPretterのセットアップ

ESLint、Prettier、およびプラグインをインストールします：

npm install --save-dev eslint prettier @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-prettier eslint-config-prettier

.eslintrc.jsonでESLintを設定します：

{
  "parser": "@typescript-eslint/parser",
  "plugins": ["@typescript-eslint", "prettier"],
  "extends": [
    "eslint:recommended",
    "plugin:@typescript-eslint/recommended",
    "plugin:prettier/recommended"
  ],
  "env": { "node": true, "es6": true, "jest": true }
}

.prettierrc.jsonを作成します：

{
  "semi": true,
  "singleQuote": true,
  "trailingComma": "all"
}

package.jsonのスクリプトを更新します：

"scripts": {
  "lint": "eslint 'src/**/*.{ts,js}'",
  "format": "prettier --write ."
}

ステップ5: テスト用のJest

JestとTypeScriptサポートを追加します：

npm install --save-dev jest ts-jest @types/jest
npx ts-jest config:init

簡単なテストsrc/__tests__/sum.test.tsを作成します：

import { sum } from '../sum';

test('sum works', () => {
  expect(sum(1, 2)).toBe(3);
});

対応するモジュールも作成します：

export function sum(a: number, b: number): number {
  return a + b;
}

package.jsonを更新します：

"scripts": {
  "test": "jest --watch"
}

ステップ6: 開発用のNodemon

nodemonをインストールして設定します：

npm install --save-dev nodemon

nodemon.jsonを追加します：

{
  "watch": ["src"],
  "ext": "ts,json",
  "ignore": ["src/**/*.test.ts"],
  "exec": "ts-node ./src/index.ts"
}

package.jsonに開発環境用のスクリプトを追加します：

"scripts": {
  "dev": "nodemon"
}

開発中にサーバーを自動リロードするにはnpm run devを実行します。

ベストプラクティス

• 別々のフォルダを使用します（コード用のsrc、ビルド出力用のdist）。
• ソースファイルのみをコミットし、コンパイルされたコード（dist）やnodeモジュールはコミットしないでください。
• npm run lintとnpm run formatを頻繁に実行してください。
• デプロイ前にコードをコンパイル（npm run build）し、npm startで起動してください。

よくある質問