ツール設定

AdonisJSは、コードの一貫性を持ち、ビルド時にエラーをチェックし、より楽しい開発体験をするためにTypeScript、Prettier、ESLintを大いに活用しています。

公式パッケージと公式スターターキットのすべてで使用される、使用準備ができた設定プリセットの中に、私たちの選択肢を抽象化しています。

TypeScriptで書かれたNode.jsアプリケーションで同じ設定プリセットを使用したい場合は、このガイドを読み続けてください。

TSConfig

@adonisjs/tsconfigパッケージには、TypeScriptプロジェクトの基本設定が含まれています。TypeScriptのモジュールシステムをNodeNextに設定し、Just-in-TimeコンパイルにはTS Node + SWCを使用しています。

ベース設定ファイル、アプリケーション設定ファイル、およびパッケージ開発設定ファイル内のオプションを自由に探索してください。

パッケージをインストールし、次のように使用できます。

npm i -D @adonisjs/tsconfig

# 以下のパッケージもインストールすることを忘れないでください
npm i -D typescript ts-node @swc/core

AdonisJSアプリケーションを作成する際には、tsconfig.app.jsonファイルから拡張します（スターターキットで事前に設定済み）。

{
  "extends": "@adonisjs/tsconfig/tsconfig.app.json",
  "compilerOptions": {
    "rootDir": "./",
    "outDir": "./build"
  }
}

AdonisJSエコシステムのパッケージを作成する際には、tsconfig.package.jsonファイルから拡張します。

{
  "extends": "@adonisjs/tsconfig/tsconfig.package.json",
  "compilerOptions": {
    "rootDir": "./",
    "outDir": "./build"
  }
}

Prettier設定

@adonisjs/prettier-configパッケージには、ソースコードを一貫したスタイルで自動フォーマットするための基本設定が含まれています。index.jsonファイル内の設定オプションを自由に探索してください。

パッケージをインストールし、次のように使用できます。

npm i -D @adonisjs/prettier-config

# prettierもインストールすることを忘れないでください
npm i -D prettier

package.jsonファイル内に次のプロパティを定義します。

{
  "prettier": "@adonisjs/prettier-config"
}

また、特定のファイルやディレクトリを無視するために.prettierignoreファイルを作成します。

build
node_modules

ESLint設定

@adonisjs/eslint-configパッケージには、リンティングルールを適用するための基本設定が含まれています。ベース設定ファイル、アプリケーション設定ファイル、およびパッケージ開発設定ファイル内のオプションを自由に探索してください。

パッケージをインストールし、次のように使用できます。

npm i -D @adonisjs/eslint-config

# eslintもインストールすることを忘れないでください
npm i -D eslint

AdonisJSアプリケーションを作成する際には、eslint-config/appファイルから拡張します（スターターキットで事前に設定済み）。

{
  "eslintConfig": {
    "extends": "@adonisjs/eslint-config/app"
  }
}

AdonisJSエコシステムのパッケージを作成する際には、eslint-config/packageファイルから拡張します。

{
  "eslintConfig": {
    "extends": "@adonisjs/eslint-config/package"
  }
}