0.2.9 • Published 3 years ago

@croutonn/eslint-plugin v0.2.9

Weekly downloads
24
License
MIT
Repository
github
Last release
3 years ago

@croutonn/eslint-plugin

npm version Downloads/month Build Status Dependency Status

This is a plugin that puts the ESLint rules I have wanted into one place. It also contains rules for existing plug-ins with additional auto-fixer.

Installation

Use npm or a compatibility tool to install.

$ npm install --save-dev eslint @croutonn/eslint-plugin

Requirements

  • Node.js v8.10.0 or newer versions.
  • ESLint v5.16.0 or newer versions.

Usage

Write your config file such as .eslintrc.yml.

plugins:
  - "@croutonn"
rules:
  "@croutonn/func-style":
    - error
    - arrow
    - topLevelStyle: declaration

See also Configuring ESLint.

Configs

  • @croutonn/recommended ... enables the recommended rules.

Rules

Best Practices

Rule IDDescription
@croutonn/exports-lastThis rule enforces that all exports are declared at the bottom of the file. This rule will report any export declarations that comes before any non-export statements.⭐️✒️
@croutonn/group-exportsReports when named exports are not grouped together in a single export declaration or when multiple assignments to CommonJS module.exports or exports object are present in a single file⭐️✒️
@croutonn/jsx-a11y-anchor-has-contentEnforce that anchors have content and that the content is accessible to screen readers
@croutonn/jsx-a11y-control-has-associated-labelEnforce that a control (an interactive element) has a text label
@croutonn/typescript-react-component-typeenforce FC and FunctionComponent types to one or the other⭐️✒️
@croutonn/typescript-react-require-props-suffixrequire that prop interface names be suffixed with Props⭐️
@croutonn/typescript-react-require-props-typerequire an props type to be provided to a React component⭐️

Stylistic Issues

Rule IDDescription
@croutonn/func-styleenforce consistent use of function declarations or expressions⭐️✒️

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.
0.2.9

3 years ago

0.2.8

4 years ago

0.2.7

4 years ago

0.2.6

4 years ago

0.2.5

4 years ago

0.2.4

4 years ago

0.2.3

4 years ago

0.2.2

4 years ago

0.2.1

4 years ago

0.2.0

4 years ago

0.1.4

4 years ago

0.1.3

4 years ago

0.1.2

4 years ago

0.1.1

4 years ago

0.1.0

4 years ago

0.0.2

4 years ago

0.0.1

4 years ago

1.0.0

4 years ago