ホーム 全セッション S05

依存の向きの違反の検出

12 / 14 目安 0.5分

ページ一覧

解決策: 依存の向きの違反を、Linter のルールとテストのどちらが検出するかを比較します。

依存の向きの違反は、ESLint の no-restricted-imports で検出できます。次の誤った変更と正しいコードを切り替えて、Linter のルールとテストの結果を比較してください。どの変更でも型検査は通ります。表の「- 対象外」は、この教材の判定で、その誤った変更の検出に数えない仕組みを表します。演習では、別の3件の誤った変更について、どちらの仕組みで検出するかを選びます。

変更を選ぶ

正しいコードからの変更(domain の appointment.ts) − 削除した行 + 追加した行

正しいコードからの変更(domain の appointment.ts) − 削除した行 + 追加した行

import type { CancellationReason } from "../../../src/domain/appointment/cancellationReason.js";
import type { CancelError } from "../../../src/useCase/cancelAppointment.js";
// 型の定義と cancel は同じ
export type CancelFailure = CancelError;

useCase は domain より外側の層です。向きが逆でも型検査は通り、実行結果も変わらないため、ルールだけが検出します。

import type { CancellationReason } from "../../../src/domain/appointment/cancellationReason.js";
import { isBookedOnWeb, type BookingChannel } from "../../../src/domain/appointment/webBookingChannel.js";
// 型の定義と cancel は同じ
export const isWebBooking = (channel: BookingChannel): boolean =>
  isBookedOnWeb(channel);

webBookingChannel は domain の中のファイルです。パターンをフォルダの単位で記述すれば、名前に web を含むだけのファイルを誤検知(正しいコードを誤った変更として検出すること)しません。

  1. Linter のルール import の文字列がパターンに一致すると報告する
    ✓ 検出 ✓ 誤検知なし
    "no-restricted-imports": ["error",
      { patterns: ["**/<禁止するフォルダ名>/**"] }]
    "no-restricted-imports": ["error",
      { patterns: ["**/<禁止するフォルダ名>/**"] }]
    no-restricted-imports: '…/useCase/cancelAppointment.js' import is restricted from being used by a pattern. エラーなし
  2. テスト テスト用の Store で検証する
    - 対象外 ✓ 誤検知なし
    // import の向きは実行結果に現れません
    // import を追加しても実行結果は変わりません
    このファイルを実行するテストは 0 件 このファイルを実行するテストは 0 件

eslint.config.mjs の rules に追加する設定のひな形(山かっこの部分は自分で決めます)

no-restricted-imports のパターンの **/フォルダ名/** は、どの深さでもそのフォルダを指します。

files(検査する対象のファイル)は、eslint.config.mjs にあらかじめ設定してあります。

"no-restricted-imports": ["error", {
patterns: ["**/<禁止するフォルダ名>/**"],
}],