Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iliubinskii/eslint-plugin-misc
ESLint plugin
https://github.com/iliubinskii/eslint-plugin-misc
eslint eslint-config eslint-plugin eslint-rules eslintrc
Last synced: about 24 hours ago
JSON representation
ESLint plugin
- Host: GitHub
- URL: https://github.com/iliubinskii/eslint-plugin-misc
- Owner: iliubinskii
- License: isc
- Created: 2021-11-13T12:28:21.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-04-15T14:39:24.000Z (7 months ago)
- Last Synced: 2024-05-19T05:04:48.741Z (6 months ago)
- Topics: eslint, eslint-config, eslint-plugin, eslint-rules, eslintrc
- Language: TypeScript
- Homepage: https://iliubinskii.github.io/eslint-plugin-misc/
- Size: 3.7 MB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# ESLint plugin
## Table of contents
- [Overview](#overview)
- [Installation](#installation)
- [Configs](#configs)
- [Rules](#rules)
- [Synonyms](#synonyms)
- [Custom checks](#custom-checks)
- [Planned rules](#planned-rules)
## Overview
A collection of ESLint rules for JavaScript and TypeScript files.
## Installation
```sh
npm install --save-dev eslint-plugin-misc
```
```js
// .eslintrc.js
module.exports = {
extends: "plugin:misc/all",
parser: "@typescript-eslint/parser",
plugins: ["misc"]
};
```
## Configs
- plugin:misc/all — All rules.
- plugin:misc/recommended — Recommended rules.
- plugin:misc/core — Core rules.
- plugin:misc/typescript — Rules for typescript files.
## Rules
- [class-match-filename](https://iliubinskii.github.io/eslint-plugin-misc/class-match-filename.html) — Requires class name to match filename.
- [comment-spacing](https://iliubinskii.github.io/eslint-plugin-misc/comment-spacing.html) — Requires consistent empty lines around comments.
- [consistent-empty-lines](https://iliubinskii.github.io/eslint-plugin-misc/consistent-empty-lines.html) — Requires consistent empty lines.
- [consistent-enum-members](https://iliubinskii.github.io/eslint-plugin-misc/consistent-enum-members.html) — Requires consistent key-value pairs inside enums (key should match value).
- [consistent-filename](https://iliubinskii.github.io/eslint-plugin-misc/consistent-filename.html) — Enforces consistent file name format.
- [consistent-import](https://iliubinskii.github.io/eslint-plugin-misc/consistent-import.html) — Requires consistent import.
- [consistent-optional-props](https://iliubinskii.github.io/eslint-plugin-misc/consistent-optional-props.html) — Ensures consistent optional property style.
- [consistent-source-extension](https://iliubinskii.github.io/eslint-plugin-misc/consistent-source-extension.html) — Requires consistent import/export source extension.
- [consistent-symbol-description](https://iliubinskii.github.io/eslint-plugin-misc/consistent-symbol-description.html) — Requires consistent symbol description.
- [disallow-import](https://iliubinskii.github.io/eslint-plugin-misc/disallow-import.html) — Disallows import given sources.
- [export-matching-filename-only](https://iliubinskii.github.io/eslint-plugin-misc/export-matching-filename-only.html) — Requires that export matching filename is the only export.
- [match-filename](https://iliubinskii.github.io/eslint-plugin-misc/match-filename.html) — Requires that AST element matches filename.
- [max-identifier-blocks](https://iliubinskii.github.io/eslint-plugin-misc/max-identifier-blocks.html) — Restricts identifier complexity.
- [no-at-sign-import](https://iliubinskii.github.io/eslint-plugin-misc/no-at-sign-import.html) — Disallows "@" import.
- [no-at-sign-internal-import](https://iliubinskii.github.io/eslint-plugin-misc/no-at-sign-internal-import.html) — Disallows "@/**" import.
- [no-chain-coalescence-mixture](https://iliubinskii.github.io/eslint-plugin-misc/no-chain-coalescence-mixture.html) — Disallows mixing of chain and coalescence operators.
- [no-expression-empty-lines](https://iliubinskii.github.io/eslint-plugin-misc/no-expression-empty-lines.html) — Disallows empty lines inside expressions.
- [no-index-import](https://iliubinskii.github.io/eslint-plugin-misc/no-index-import.html) — Disallows "." import.
- [no-internal-modules](https://iliubinskii.github.io/eslint-plugin-misc/no-internal-modules.html) — Disallows importing of internal modules.
- [no-language-mixing](https://iliubinskii.github.io/eslint-plugin-misc/no-language-mixing.html) — Disallows language mixing.
- [no-negated-conditions](https://iliubinskii.github.io/eslint-plugin-misc/no-negated-conditions.html) — Disallows negated conditions.
- [no-nodejs-modules](https://iliubinskii.github.io/eslint-plugin-misc/no-nodejs-modules.html) — Disallows importing NodeJS modules.
- [no-param-reassign](https://iliubinskii.github.io/eslint-plugin-misc/no-param-reassign.html) — This rule wraps "no-param-reassign" core rule, but allows to edit params at the top of function body.
- [no-relative-parent-import](https://iliubinskii.github.io/eslint-plugin-misc/no-relative-parent-import.html) — Disallows relative parent import.
- [no-restricted-syntax](https://iliubinskii.github.io/eslint-plugin-misc/no-restricted-syntax.html) — Disallows AST syntax (an extended version of ESLint core rule).
- [no-self-import](https://iliubinskii.github.io/eslint-plugin-misc/no-self-import.html) — Disallows self-import.
- [no-shadow](https://iliubinskii.github.io/eslint-plugin-misc/no-shadow.html) — This rule wraps "@typescript-eslint/no-shadow" rule, but skips checking enum.
- [no-sibling-import](https://iliubinskii.github.io/eslint-plugin-misc/no-sibling-import.html) — Restricts importing siblings.
- [no-underscore-export](https://iliubinskii.github.io/eslint-plugin-misc/no-underscore-export.html) — Disallows underscore export.
- [no-unnecessary-as-const](https://iliubinskii.github.io/eslint-plugin-misc/no-unnecessary-as-const.html) — Disallows unnecessary "as const".
- [no-unnecessary-break](https://iliubinskii.github.io/eslint-plugin-misc/no-unnecessary-break.html) — Disallows unnecessary "break".
- [no-unnecessary-initialization](https://iliubinskii.github.io/eslint-plugin-misc/no-unnecessary-initialization.html) — Disallows unnecessary initialization.
- [no-unnecessary-template-literal](https://iliubinskii.github.io/eslint-plugin-misc/no-unnecessary-template-literal.html) — Disallows unnecessary template literals.
- [object-format](https://iliubinskii.github.io/eslint-plugin-misc/object-format.html) — Requires multiline or single-line object format.
- [only-export-name](https://iliubinskii.github.io/eslint-plugin-misc/only-export-name.html) — Requires that only export matches filename.
- [prefer-arrow-function-property](https://iliubinskii.github.io/eslint-plugin-misc/prefer-arrow-function-property.html) — Requires use of arrow functions.
- [prefer-const-require](https://iliubinskii.github.io/eslint-plugin-misc/prefer-const-require.html) — Requires "require()" to be assigned to variable.
- [prefer-only-export](https://iliubinskii.github.io/eslint-plugin-misc/prefer-only-export.html) — Requires only export if given AST element is found.
- [require-jsdoc](https://iliubinskii.github.io/eslint-plugin-misc/require-jsdoc.html) — Requires JSDoc documentation.
- [require-syntax](https://iliubinskii.github.io/eslint-plugin-misc/require-syntax.html) — Requires AST syntax.
- [restrict-identifier-characters](https://iliubinskii.github.io/eslint-plugin-misc/restrict-identifier-characters.html) — Requires that identifier consists only of english characters and dollar sign.
- [sort-array](https://iliubinskii.github.io/eslint-plugin-misc/sort-array.html) — Sorts arrays.
- [sort-call-signature](https://iliubinskii.github.io/eslint-plugin-misc/sort-call-signature.html) — Requires call signature to be first child.
- [sort-class-members](https://iliubinskii.github.io/eslint-plugin-misc/sort-class-members.html) — Sorts class members by type and alphabetically inside each type group.
- [sort-construct-signature](https://iliubinskii.github.io/eslint-plugin-misc/sort-construct-signature.html) — Requires construct signature to be first child.
- [sort-export-specifiers](https://iliubinskii.github.io/eslint-plugin-misc/sort-export-specifiers.html) — Sorts export specifiers.
- [sort-keys](https://iliubinskii.github.io/eslint-plugin-misc/sort-keys.html) — Sorts object keys.
- [sort-top-comments](https://iliubinskii.github.io/eslint-plugin-misc/sort-top-comments.html) — Sorts top comments.
- [switch-case-spacing](https://iliubinskii.github.io/eslint-plugin-misc/switch-case-spacing.html) — Ensures consistent empty lines between switch case statements.
- [template-literal-format](https://iliubinskii.github.io/eslint-plugin-misc/template-literal-format.html) — Requires consistent padding in template literals.
- [wrap](https://iliubinskii.github.io/eslint-plugin-misc/wrap.html) — Wraps and modifies third-party rule.
- [typescript/array-callback-return-type](https://iliubinskii.github.io/eslint-plugin-misc/typescript/array-callback-return-type.html) — Requires boolean return type in array callbacks.
- [typescript/class-methods-use-this](https://iliubinskii.github.io/eslint-plugin-misc/typescript/class-methods-use-this.html) — This rule wraps "class-methods-use-this" core rule, but skips methods with "this: void" argument.
- [typescript/consistent-array-type-name](https://iliubinskii.github.io/eslint-plugin-misc/typescript/consistent-array-type-name.html) — Requires consistent array type name.
- [typescript/define-function-in-one-statement](https://iliubinskii.github.io/eslint-plugin-misc/typescript/define-function-in-one-statement.html) — Requires that function is defined in one statement.
- [typescript/exhaustive-switch](https://iliubinskii.github.io/eslint-plugin-misc/typescript/exhaustive-switch.html) — Checks exhaustiveness of switch statement.
- [typescript/no-boolean-literal-type](https://iliubinskii.github.io/eslint-plugin-misc/typescript/no-boolean-literal-type.html) — Disallows boolean literal type.
- [typescript/no-complex-declarator-type](https://iliubinskii.github.io/eslint-plugin-misc/typescript/no-complex-declarator-type.html) — Requires either 'as const' or type definition complex declarators.
- [typescript/no-complex-return-type](https://iliubinskii.github.io/eslint-plugin-misc/typescript/no-complex-return-type.html) — Disallow complex function return types.
- [typescript/no-empty-interfaces](https://iliubinskii.github.io/eslint-plugin-misc/typescript/no-empty-interfaces.html) — Disallow empty interfaces.
- [typescript/no-inferrable-types](https://iliubinskii.github.io/eslint-plugin-misc/typescript/no-inferrable-types.html) — Reports inferrable types.
- [typescript/no-multi-type-tuples](https://iliubinskii.github.io/eslint-plugin-misc/typescript/no-multi-type-tuples.html) — Disallows multi-type tuples.
- [typescript/no-never](https://iliubinskii.github.io/eslint-plugin-misc/typescript/no-never.html) — Disallow "never" type.
- [typescript/no-restricted-syntax](https://iliubinskii.github.io/eslint-plugin-misc/typescript/no-restricted-syntax.html) — Disallows AST syntax with additional type check.
- [typescript/no-unsafe-object-assign](https://iliubinskii.github.io/eslint-plugin-misc/typescript/no-unsafe-object-assign.html) — Disallows unsafe "Object.assign".
- [typescript/no-unsafe-object-assignment](https://iliubinskii.github.io/eslint-plugin-misc/typescript/no-unsafe-object-assignment.html) — Reports unsafe object assignments.
- [typescript/prefer-array-type-alias](https://iliubinskii.github.io/eslint-plugin-misc/typescript/prefer-array-type-alias.html) — Prefer alias for array type.
- [typescript/prefer-class-method](https://iliubinskii.github.io/eslint-plugin-misc/typescript/prefer-class-method.html) — Requires use of class methods instead of function properties.
- [typescript/prefer-enum](https://iliubinskii.github.io/eslint-plugin-misc/typescript/prefer-enum.html) — Requires using enums instead of string literals.
- [typescript/prefer-readonly-array](https://iliubinskii.github.io/eslint-plugin-misc/typescript/prefer-readonly-array.html) — Disallows writable arrays.
- [typescript/prefer-readonly-map](https://iliubinskii.github.io/eslint-plugin-misc/typescript/prefer-readonly-map.html) — Disallows writable maps.
- [typescript/prefer-readonly-property](https://iliubinskii.github.io/eslint-plugin-misc/typescript/prefer-readonly-property.html) — Disallows writable properties.
- [typescript/prefer-readonly-set](https://iliubinskii.github.io/eslint-plugin-misc/typescript/prefer-readonly-set.html) — Disallows writable sets.
- [typescript/require-prop-type-annotation](https://iliubinskii.github.io/eslint-plugin-misc/typescript/require-prop-type-annotation.html) — Requires type annotation for class properties.
- [typescript/require-this-void](https://iliubinskii.github.io/eslint-plugin-misc/typescript/require-this-void.html) — Requires "this: void" for static methods.
## Synonyms
You can use the same rule several times by adding synonym:
```js
// .eslintrc.synonyms.cjs
module.exports = ["misc/wrap/class-methods-use-this", "misc/wrap/no-shadow"];
// .eslintrc.js
module.exports = {
rules: {
// Same as ESLint core rule, but suppresses warnings for methods that have "this" parameter.
"misc/wrap/class-methods-use-this": [
"error",
{
plugin: "eslint",
rule: "class-methods-use-this",
skip: "FunctionExpression[params.0.name=this]"
}
],
// Same as typescript-eslint rule, but suppresses warnings for enums.
"misc/wrap/no-shadow": [
"error",
{
plugin: "@typescript-eslint/eslint-plugin",
rule: "no-shadow",
skip: "TSEnumDeclaration *"
}
]
}
};
```
## Custom checks
Many custom checks can be created without writing full-fledged ESLint plugin.
Use the rules below to create custom checks or adapt existing third-party rules:
- [no-restricted-syntax](https://iliubinskii.github.io/eslint-plugin-misc/no-restricted-syntax.html) — Disallows AST syntax (an extended version of ESLint core rule).
- [require-syntax](https://iliubinskii.github.io/eslint-plugin-misc/require-syntax.html) — Requires AST syntax.
- [wrap](https://iliubinskii.github.io/eslint-plugin-misc/wrap.html) — Wraps and modifies third-party rule.
- [typescript/no-restricted-syntax](https://iliubinskii.github.io/eslint-plugin-misc/typescript/no-restricted-syntax.html) — Disallows AST syntax with additional type check.
If you want to apply one rule several times (e.g. restrict several syntaxes), use rule synonyms.
## Planned rules
- boolean-in-boolean-context — Require strict boolean type in boolean contexts like `x && y` or `!x`.
- consistent-import-as — Require that _y_ in `import { x as y }` statement is from allowed list.
- consistent-test-file-name — Require that test file name matches some source file name.
- no-re-export-mixing — Require that file contains either only re-export or only export of new items.
- escape-doc-comment-entities — Require that "\<" and "\>" symbols inside doc comments are properly escaped.
- no-array-mutation — Forbid array mutation.
- no-duplicate-import — Forbid combining `import { x } from "source"` and `import { x as y } from "source"` in the same file.
- protected-rules — Do not allow to disable selected ESLint rules.
- sort-eslint-comments — Sort rules in eslint-disable comments.
- sort-switch-cases — Sort switch cases.
- spell-check — Spell check with international language support based on hunspell spell checker.