Skip to content
This repository has been archived by the owner on Jan 31, 2024. It is now read-only.

SpiffInc/eslint-plugin-spiff

Repository files navigation

eslint-plugin-spiff

Spiff's custom ESLint rules.

Installation

$ yarn add --dev eslint SpiffInc/eslint-plugin-spiff#latest
$ npm install --save-dev eslint SpiffInc/eslint-plugin-spiff#latest

Requirements

  • Node.js v12.12.0 or newer versions.
  • ESLint v5.16.0 or newer versions.

Usage

Write your config file such as .eslintrc.yml.

plugins:
  - spiff
rules:
  spiff/import-align: error

See also Configuring ESLint.

Configs

  • spiff/recommended ... enables the recommended rules.

Rules

Stylistic Issues

Rule ID Description
spiff/import-align Require from keywords to be aligned. ⭐️✒️
spiff/jsx-attribute-align Align the attributes of multi-line JSX elements. ⭐️✒️

Semantic Versioning Policy

This plugin follows Semantic Versioning and ESLint's Semantic Versioning Policy.

Changelog

Contributing

Welcome your contribution!

See also ESLint Contribution Guide.

Development Tools

  • npm test runs tests and measures coverage.
  • npm version <TYPE> updates the package version. And it updates lib/configs/recommended.js, lib/index.js, and README.md's rule table. See also npm version CLI command.
  • npm run add-rule <RULE_ID> creates three files to add a new rule.

About

Spiff's custom ESLint rules.

Resources

License

Stars

Watchers

Forks

Packages

No packages published