Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/absqueued/eslint-plugin-ts-ignore-comments
Enforce a custom description for `// @ts-ignore` comments
https://github.com/absqueued/eslint-plugin-ts-ignore-comments
eslint eslint-plugin eslintplugin javascript plugin ts-ban-comments ts-expect-error ts-ignore tslint typescript vscode
Last synced: about 2 months ago
JSON representation
Enforce a custom description for `// @ts-ignore` comments
- Host: GitHub
- URL: https://github.com/absqueued/eslint-plugin-ts-ignore-comments
- Owner: absqueued
- License: mit
- Created: 2024-07-17T21:58:39.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-07-30T00:01:05.000Z (about 2 months ago)
- Last Synced: 2024-07-30T04:57:53.831Z (about 2 months ago)
- Topics: eslint, eslint-plugin, eslintplugin, javascript, plugin, ts-ban-comments, ts-expect-error, ts-ignore, tslint, typescript, vscode
- Language: JavaScript
- Homepage:
- Size: 177 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome - absqueued/eslint-plugin-ts-ignore-comments - Enforce a custom description for `// @ts-ignore` comments (JavaScript)
README
# @absqueued/eslint-plugin-ts-ignore-comments
[](https://badge.fury.io/js/@absqueued%2Feslint-plugin-ts-ignore-comments)
[](https://github.com/absqueued/eslint-plugin-ts-ignore-comments/actions/workflows/codeql.yml)
This package is a custom ESLint plugin designed to enforce a standardized comment format for the `// @ts-ignore` directive in your codebase. This rule ensures that every instance of `// @ts-ignore` is accompanied by a comment explaining the reason for its usage and a plan to address it in the future. This practice helps maintain high-quality code by preventing lazy use of `// @ts-ignore` and promoting accountability among team members.
## Purpose
In many projects, `// @ts-ignore` is often used to quickly bypass TypeScript errors without a clear explanation or plan to resolve the underlying issue. This can lead to technical debt and obscure the true state of the codebase. This plugin aims to improve code quality by:
- Requiring a specific comment format that includes a TODO and task number (e.g., `TODO: PBI-1234 needs refactoring of types`).
- Enforcing developers to document why `// @ts-ignore` was added and what needs to be done to remove it.
- Encouraging developers to address TypeScript issues rather than ignoring them.
## Installation
You can install `@absqueued/eslint-plugin-ts-ignore-comments` using npm or yarn:
```bash
npm install @absqueued/eslint-plugin-ts-ignore-comments --save-dev
```
or
```bash
yarn add @absqueued/eslint-plugin-ts-ignore-comments --dev
```
## Usage
After installation, add `@absqueued/ts-ignore-comments` to the plugins section of your `.eslintrc` configuration file. Then configure the rules you want to use under the rules section.
This plugin works out of the box with the default ESLint parser.
#### Basic setup
```js
module.exports = {
"plugins": [
...
"@absqueued/ts-ignore-comments"
],
"rules": {
"@absqueued/ts-ignore-comments/comments": "error", // or "warn"
}
}
```
#### Custom message setup
Add a `pattern` property to the options. You can define regex patterns to match your custom message requirement.
```js
module.exports = {
"plugins": [
...
"@absqueued/ts-ignore-comments"
],
"rules": {
"@absqueued/ts-ignore-comments/comments": ["error", {
pattern: '@ts-ignore TODO: DEGR-\\d+ .+'
}],
}
}
```
#### Examples
For more, checkout the [example](./example/) direction
```ts
//
// @ts-ignore TODO: DEGR-1234 this is a valid comment
const validUsage = 42;
// @ts-ignore cant fix - invalid comment
const invalidUsage = 42;
console.log({ validUsage, invalidUsage });
```
## Supported Rules
* **`comments`**: Enforces the use of `// @ts-ignore` comments in TypeScript files. This rule can help in identifying places where `@ts-ignore` is used, potentially highlighting areas of the code that may need closer inspection or refactoring.
## Licensing
The code in this project is licensed under the MIT license. See the LICENSE file for more information.