close
Rslint

    id-denylist

    Unreleased

    Configuration

    rslint.config.ts
    import { defineConfig, js } from '@rslint/core';

export default defineConfig([
  js.configs.recommended,
  {
    rules: {
      'id-denylist': 'error',
    },
  },
]);

    Rule Details

    Generic names can lead to hard-to-decipher code. This rule lets you list identifier names that should not be used, and reports every place the code introduces one.

    The rule catches denied identifiers that are:

    • variable declarations
    • function declarations
    • object properties assigned to during object creation
    • class fields
    • class methods

    It leaves alone denied identifiers that are:

    • function calls and their arguments, so you can keep calling functions you do not control
    • property reads, so you can keep reading properties of objects you do not control
    • references to global variables the code does not declare, whose names you do not control

    Examples of incorrect code for this rule:

    { "id-denylist": ["error", "data", "callback"] }
    const data = { ...values };

function callback() {
  // ...
}

element.callback = function () {
  // ...
};

const itemSet = {
  data: [...values],
};

class Foo {
  data = [];
}

class Bar {
  #data = [];
}

class Baz {
  callback() {}
}

class Qux {
  #callback() {}
}

    Examples of correct code for this rule:

    { "id-denylist": ["error", "data", "callback"] }
    const encodingOptions = { ...values };

function processFileResult() {
  // ...
}

element.successHandler = function () {
  // ...
};

const itemSet = {
  entities: [...values],
};

callback();

foo.callback();

foo.data;

class Foo {
  items = [];
}

class Bar {
  #items = [];
}

class Baz {
  method() {}
}

class Qux {
  #method() {}
}

    Options

    The rule takes one or more strings: the names of the denied identifiers.

    { "id-denylist": ["error", "data", "err", "e", "cb", "callback"] }

    Differences from ESLint

    • TypeScript 6 rejects legacy assert import attributes before lint rules run. ESLint can still lint that syntax with parser versions that accept it. Current with import attributes, including import types, are checked normally.
    • Implicit TypeScript type globals use scope-manager's default esnext catalog. An explicitly customized parserOptions.lib does not change that catalog in rslint, so additional host-library types may still be reported.

    Original Documentation