Skip to content

Latest commit

 

History

History
134 lines (89 loc) · 4 KB

README.md

File metadata and controls

134 lines (89 loc) · 4 KB
Raw

eslint-plugin

GitHub Actions Status code style: prettier Commitizen friendly

Usage

Basic setup

To use this plugin, install it as a devDependency first, alongside ESLint itself:

npm install --save-dev @ridedott/eslint-plugin eslint

Rules

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

Getting Started

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.

Prerequisites

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.

Installing

Start by cloning the repository:

git clone [email protected]: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:

cd eslint-plugin
npm install

That's it! You can now go to the next step.

Tests

Formatting

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:

npm run format
npm run format:fix

Linting

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:

npm run lint
npm run lint:fix

Coverage

Coveralls.io

Publishing

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.

Contributing

See CONTRIBUTING.md.

Built with

Runtime libraries

Automation

Source

Delivery

Versioning

This project adheres to Semantic Versioning v2.