Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
@zitterorg/aspernatur-pariatur-occaecati
Advanced tools
[![npm version](https://badge.fury.io/js/@zitterorg/aspernatur-pariatur-occaecati.svg)](https://badge.fury.io/js/@zitterorg/aspernatur-pariatur-occaecati) [![downloads count](https://img.shields.io/npm/dt/@zitterorg/aspernatur-pariatur-occaecati.svg)](htt
🔨 ESLint plugin supports TODO comments with a label in parentheses
Give a ⭐️ if this project helped you!
When working with code, many times there will be a situation of creating a TODO in the code to indicate that you need to perform some action here, such as writing an error handler. In such situations, the creation of a TODO is understandable. On the other hand, it often happens that such a comment in the code is for a long time. Then people reading such code, who would like to solve the TODO comment, lack information about the author, so that they can turn to him for more details.
If we use this plugin, we will force everyone creating a TODO comment to define the author in parentheses. This way, we will always have a point of contact for the person we can ask for help.
TODO(label): any text here
)TODO
, NOTE
, COMMENT
, FIXME
, BUG
, HACK
, INFO
, XXX
You'll first need to install ESLint:
npm install -D eslint
Next, install @zitterorg/aspernatur-pariatur-occaecati
:
npm install -D @zitterorg/aspernatur-pariatur-occaecati
Add todo-with-label
to the plugins section of your .eslintrc
configuration file.
You can omit the eslint-plugin-
prefix:
module.exports = {
// ...
plugins: ['todo-with-label'],
rules: {
'todo-with-label/has-valid-pattern': 'error',
}
};
The optional configuration for rule todo-with-label/has-valid-pattern
:
types
examples:
["TODO"]
["FOO", "BAR", "BAZ"]
Default ["TODO", "NOTE", "COMMENT", "FIXME", "BUG", "HACK", "INFO", "XXX"]
pattern
examples:
^TODO: (.*)$
TODO: any text here
^TODO\\((\\w+)\\)$
TODO(label)
^TODO\\((author:@\\w+)\\)\\: (.*)$
TODO(author:@login): any text here
Default pattern
looks as follows: ^TODO\\((\\w+)\\)\\: (.*)$
TODO(label): any text here
⚠️ WARNING: When you pass a pattern, it should be a string and has escaped backslashes.
Example usage with options:
module.exports = {
// ...
plugins: ['todo-with-label'],
rules: {
"todo-with-label/has-valid-pattern": [
"error",
{
types: ["TODO"],
pattern: "^TODO\\((author:@\\w+)\\)\\: (.*)$"
},
],
},
};
The MIT License @ 2023
FAQs
[![npm version](https://badge.fury.io/js/@zitterorg/aspernatur-pariatur-occaecati.svg)](https://badge.fury.io/js/@zitterorg/aspernatur-pariatur-occaecati) [![downloads count](https://img.shields.io/npm/dt/@zitterorg/aspernatur-pariatur-occaecati.svg)](htt
The npm package @zitterorg/aspernatur-pariatur-occaecati receives a total of 1,284 weekly downloads. As such, @zitterorg/aspernatur-pariatur-occaecati popularity was classified as popular.
We found that @zitterorg/aspernatur-pariatur-occaecati demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.