ESLint plugin for custom rules.
To use this plugin, install it as a devDependency first, alongside ESLint
itself:
``bash`
npm install --save-dev @ridedott/eslint-plugin eslint
| Rule | Description | Configurations | Fixable |
| ------------------------------------------- | ---------------------------------------------------------- | ---------------- | -------- |
| [no-single-line-comment-block][] | Single line comments should not be in a block comment. | ![recommended][] | ![fix][] |
| [no-template-literals-without-expression][] | There should not be template literals without expressions. | ![recommended][] | ![fix][] |
These instructions will get you a copy of the project up and running on your
local machine for development and testing purposes. See usage notes on how to
consume this package in your project.
Minimal requirements to set up the project:
- Node.js v14, installation instructions can be found
on the official website, a recommended installation option is to use
Node Version Manager. It can be
installed in a
few commands.
- A package manager npm. All instructions in the
documentation will follow the npm syntax.
- Optionally a Git client.
Start by cloning the repository:
`bash`
git clone git@github.com:ridedott/eslint-plugin.git
In case you don't have a git client, you can get the latest version directly by
using this link
and extracting the downloaded archive.
Go the the right directory and install dependencies:
`bash`
cd eslint-plugin
npm install
That's it! You can now go to the next step.
This project uses Prettier to automate formatting. All
supported files are being reformatted in a pre-commit hook. You can also use one
of the two scripts to validate and optionally fix all of the files:
`bash`
npm run format
npm run format:fix
This project uses ESLint to enable static analysis.
TypeScript files are linted using a custom configuration. You can
use one of the following scripts to validate and optionally fix all of the
files:
`bash`
npm run lint
npm run lint:fix
Publishing is handled in an automated way and must not be performed manually.
Each commit to the master branch is automatically deployed to the NPM registry
with a version specified in package.json`. All other commits are published as
pre-releases.
See CONTRIBUTING.md.
This project adheres to Semantic Versioning v2.
[no-single-line-comment-block]:
documentation/rules/no-single-line-comment-block.md
[no-template-literals-without-expression]:
documentation/rules/no-template-literals-without-expression.md
[recommended]: https://img.shields.io/badge/-recommended-blueviolet.svg
[fix]: https://img.shields.io/badge/-fix-yellow.svg