Skip to content

📦 Do not use this plugin unless you know exactly every rule may change.

License

Notifications You must be signed in to change notification settings

ntnyq/eslint-plugin-ntnyq

Repository files navigation

eslint-plugin-ntnyq

CI NPM VERSION NPM DOWNLOADS COVERAGE LICENSE

Do not use this plugin unless you know exactly every rule may change.

⚠️ Caveat

Do check the output to ensure it's doing its job correctly and only run this on code that has been checked into source control.

Install

npm:

npm i eslint-plugin-ntnyq -D

yarn

yarn add eslint-plugin-ntnyq -D

pnpm

pnpm add eslint-plugin-ntnyq -D

Usage

Add ntnyq to the plugins section of your eslint config file (you can omit the eslint-plugin- prefix) and either use the preset recommended or configure the rules you want:

The recommended preset

The plugin:ntnyq/recommended config enables a subset of the rules that should be most useful to most users.

See src/configs/recommended.ts for more details.

// .eslintrc.json
{
  "extends": [
    // Other presets
    "plugin:ntnyq/recommended"
  ]
}

The all preset

The plugin:ntnyq/all config enables all the the rules.

See src/configs/all.ts for more details.

// .eslintrc.json
{
  "extends": [
    // Other presets
    "plugin:ntnyq/all"
  ]
}

Advanced Configuration

Override/add specific rules configurations.

See also: http://eslint.org/docs/user-guide/configuring.

// .eslintrc.json
{
  "plugins": ["ntnyq"],
  "rules": {
    // Override/add rules settings here, such as:
    "ntnyq/rule-name": "error"
  }
}

Rules

💼 Configurations enabled in.
🌐 Set in the plugin:ntnyq/all preset.
✅ Set in the plugin:ntnyq/recommended preset.
🔧 Automatically fixable by the --fix CLI option.
💡 Manually fixable by editor suggestions.

Name Description 💼 🔧 💡
no-member-accessibility disallow usage of typescript member accessibility 🌐 🔧

License

MIT License © 2023-PRESENT ntnyq