ESLint の "no-dupe-args" ルールとは？

例:

function add(x, x) {
  // ...
}

このコードは、x という名前のパラメータを 2 回使用しています。no-dupe-args ルールが有効な場合、このコードは エラー として報告されます。

このルールを有効にする利点:

コードの読みやすさの向上: 同じ名前のパラメータが複数回使用されていないと、コードが読みやすくなり、理解しやすくなります。
バグの防止: 同じ名前のパラメータが複数回使用されると、誤った値が渡されたり、予期せぬ動作が発生したりする可能性があります。no-dupe-args ルールは、このようなバグを防ぐのに役立ちます。

まれに、同じ名前のパラメータを意図的に複数回使用する必要がある場合があります。その場合は、このルールを無効にすることができます。ただし、コードが読みづらくなり、バグが発生する可能性が高くなる ことには注意が必要です。

no-dupe-args ルールの設定方法

このルールは、.eslintrc ファイルで設定できます。以下の例では、このルールを有効にしています。

{
  "rules": {
    "no-dupe-args": "error"
  }
}

オプション

no-dupe-args ルールは、コードをより読みやすく、バグが発生しにくくするために役立つ便利なルールです。ほとんどの場合、このルールを有効にすることをお勧めします。

このルールは、関数式 や クラスメソッド には適用されません。
厳格モードで ESLint を実行している場合、このルールは自動的に有効になります。

エラーが発生するコード

function add(x, x) {
  return x + x;
}

console.log(add(1, 2)); // 3 を出力

このコードは、x という名前のパラメータを 2 回使用しています。そのため、no-dupe-args ルールによってエラーが発生します。

エラーを修正したコード

function add(x, y) {
  return x + y;
}

console.log(add(1, 2)); // 3 を出力

同じ名前のパラメータを意図的に複数回使用する

まれに、同じ名前のパラメータを意図的に複数回使用する必要がある場合があります。その場合は、no-dupe-args ルールを無効にすることができます。

/* eslint no-dupe-args: "off" */
function swap(x, x) {
  var temp = x;
  x = y;
  y = temp;
}

var a = 1;
var b = 2;

swap(a, b);

console.log(a); // 2 を出力
console.log(b); // 1 を出力

このコードでは、swap 関数のパラメータとして同じ名前のパラメータ (x) を 2 回使用しています。これは、2 つの変数の値を入れ替えるという処理を効率的に行うために必要です。

このコードを実行すると、a と b の値が入れ替わります。

注意:

このようなコードは、読みづらく、バグが発生しやすい 可能性があります。
同じ名前のパラメータを複数回使用する必要がある場合は、コメントを追加 して、コードの意図を明確にすることが重要です。

no-dupe-args ルールは、引数リストの末尾にある重複 のみを検出します。
オブジェクトリテラルのパラメータ名については、このルールは適用されません。

function add(x, y) {
  var x = 10; // エラー: 'x' はすでに宣言されています
  return x + y;
}

このコードは、x という名前のパラメータと、関数内の変数が重複しているため、no-shadow ルールによってエラーが発生します。

利点:

関数内の変数名とパラメータ名の重複を防ぎ、コードの読みやすさを向上させることができます。
変数名とパラメータ名が重複していると、意図せぬ動作が発生する可能性があるため、バグを防ぐことができます。

欠点:

no-dupe-args ルールよりも範囲が広いため、誤検知 が発生する可能性があります。

カスタム ESLint ルールを作成する

no-dupe-args ルールの動作に満足できない場合は、カスタム ESLint ルールを作成 することができます。これにより、独自のルール を定義して、特定の要件に合わせてカスタマイズすることができます。

以下の例は、no-dupe-args ルールと同様の動作をするカスタム ESLint ルールの例です。

module.exports = {
  rules: {
    "no-duplicate-function-parameters": {
      create(context) {
        return {
          FunctionDefinition(node) {
            const params = node.params.map(param => param.name.name);
            const duplicates = params.filter((name, i) => params.indexOf(name, i + 1) !== -1);

            if (duplicates.length > 0) {
              context.report({
                node,
                message: `Duplicate function parameter names: ${duplicates.join(", ")}`,
              });
            }
          },
        };
      },
    },
  },
};

このカスタムルールは、no-duplicate-function-parameters という名前で定義されています。このルールは、FunctionDefinition ノードに対して実行され、各パラメータの名前を調べます。重複が見つかった場合、エラーレポートが発行されます。

no-dupe-args ルールよりも柔軟にカスタマイズすることができます。
特定の要件に合致したルールを作成することができます。

ルールを作成するには、JavaScript と ESLint の知識 が必要です。
ルールをメンテナンスする必要があります。

上記以外にも、no-dupe-args ルールの代替方法として、以下の方法が考えられます。

コードレビューを実施する
静的解析ツールを使用する
コーディング規約を定める

どの方法を選択するかは、プロジェクトの要件やチームの状況によって異なります。