Skip to content

Commit

Permalink
3.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
iliubinskii committed Jul 20, 2024
1 parent 5f08a45 commit 94b914e
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 25 deletions.
20 changes: 9 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,11 @@
- [Custom checks](#custom-checks)
- [Planned rules](#planned-rules)

## <a id="overview"></a>Overview
## Overview

A collection of ESLint rules for:
A collection of ESLint rules for JavaScript and TypeScript files.

- JavaScript / TypeScript files
- Jest test files

## <a id="installation"></a>Installation
## Installation

```sh
npm install --save-dev eslint-plugin-misc
Expand All @@ -32,13 +29,14 @@ module.exports = {
};
```

## <a id="configs"></a>Configs
## Configs

- plugin:misc/all &mdash; All rules.
- plugin:misc/recommended &mdash; Recommended rules.
- plugin:misc/core &mdash; Core rules.
- plugin:misc/typescript &mdash; Rules for typescript files.

## <a id="rules"></a>Rules
## Rules

- [class-match-filename](https://iliubinskii.github.io/eslint-plugin-misc/class-match-filename.html) &mdash; Requires class name to match filename.
- [comment-spacing](https://iliubinskii.github.io/eslint-plugin-misc/comment-spacing.html) &mdash; Requires consistent empty lines around comments.
Expand Down Expand Up @@ -116,7 +114,7 @@ module.exports = {
- [typescript/require-prop-type-annotation](https://iliubinskii.github.io/eslint-plugin-misc/typescript/require-prop-type-annotation.html) &mdash; Requires type annotation for class properties.
- [typescript/require-this-void](https://iliubinskii.github.io/eslint-plugin-misc/typescript/require-this-void.html) &mdash; Requires "this: void" for static methods.

## <a id="synonyms"></a>Synonyms
## Synonyms

You can use the same rule several times by adding synonym:

Expand Down Expand Up @@ -149,7 +147,7 @@ module.exports = {
};
```

## <a id="custom-checks"></a>Custom checks
## 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:
Expand All @@ -161,7 +159,7 @@ Use the rules below to create custom checks or adapt existing third-party rules:

If you want to apply one rule several times (e.g. restrict several syntaxes), use rule synonyms.

## <a id="planned-rules"></a>Planned rules
## Planned rules

- boolean-in-boolean-context &mdash; Require strict boolean type in boolean contexts like `x && y` or `!x`.
- consistent-import-as &mdash; Require that _y_ in `import { x as y }` statement is from allowed list.
Expand Down
20 changes: 9 additions & 11 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,11 @@
- [Custom checks](#custom-checks)
- [Planned rules](#planned-rules)

## <a id="overview"></a>Overview
## Overview

A collection of ESLint rules for:
A collection of ESLint rules for JavaScript and TypeScript files.

- JavaScript / TypeScript files
- Jest test files

## <a id="installation"></a>Installation
## Installation

```sh
npm install --save-dev eslint-plugin-misc
Expand All @@ -32,13 +29,14 @@ module.exports = {
};
```

## <a id="configs"></a>Configs
## Configs

- plugin:misc/all &mdash; All rules.
- plugin:misc/recommended &mdash; Recommended rules.
- plugin:misc/core &mdash; Core rules.
- plugin:misc/typescript &mdash; Rules for typescript files.

## <a id="rules"></a>Rules
## Rules

- [class-match-filename](https://iliubinskii.github.io/eslint-plugin-misc/class-match-filename.html) &mdash; Requires class name to match filename.
- [comment-spacing](https://iliubinskii.github.io/eslint-plugin-misc/comment-spacing.html) &mdash; Requires consistent empty lines around comments.
Expand Down Expand Up @@ -116,7 +114,7 @@ module.exports = {
- [typescript/require-prop-type-annotation](https://iliubinskii.github.io/eslint-plugin-misc/typescript/require-prop-type-annotation.html) &mdash; Requires type annotation for class properties.
- [typescript/require-this-void](https://iliubinskii.github.io/eslint-plugin-misc/typescript/require-this-void.html) &mdash; Requires "this: void" for static methods.

## <a id="synonyms"></a>Synonyms
## Synonyms

You can use the same rule several times by adding synonym:

Expand Down Expand Up @@ -149,7 +147,7 @@ module.exports = {
};
```

## <a id="custom-checks"></a>Custom checks
## 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:
Expand All @@ -161,7 +159,7 @@ Use the rules below to create custom checks or adapt existing third-party rules:

If you want to apply one rule several times (e.g. restrict several syntaxes), use rule synonyms.

## <a id="planned-rules"></a>Planned rules
## Planned rules

- boolean-in-boolean-context &mdash; Require strict boolean type in boolean contexts like `x && y` or `!x`.
- consistent-import-as &mdash; Require that _y_ in `import { x as y }` statement is from allowed list.
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "eslint-plugin-misc",
"version": "3.2.0",
"version": "3.3.0",
"private": false,
"description": "ESLint plugin",
"keywords": [
Expand Down

0 comments on commit 94b914e

Please sign in to comment.