You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 4-6.RSVP
Socket
Book a DemoInstallSign in
Socket

eslint-plugin-orbit-components

Package Overview
Dependencies
Maintainers
17
Versions
37
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

eslint-plugin-orbit-components

Collection of ESLint rules to enforce the best usage practices of @kiwicom/orbit-components

0.2.0-develop
Source
npmnpm
Version published
Weekly downloads
1.1K
2.51%
Maintainers
17
Weekly downloads
 
Created
Source

eslint-plugin-orbit-components

Collection of ESLint rules to enforce the best usage practices of @kiwicom/orbit-components.

Installation

Assuming you already have ESLint installed, run:

# npm
npm install eslint-plugin-orbit-components --save-dev

# yarn
yarn add eslint-plugin-orbit-components --dev

Then add it to your ESLint configuration:

{
  "plugins": [
    // ...
    "orbit-components"
  ],
  "rules": {
    // ...
    "orbit-components/button-has-title": "error",
    "orbit-components/unnecessary-text": "error",
  }
}

Supported Rules

  • button-has-title: Enforces that Button and ButtonLink do have either children or title property.
  • unnecessary-text: Enforces that children of Button or Heading are not wrapped in Text component.

License

MIT

Keywords

eslint

FAQs

Package last updated on 13 Oct 2019

Did you know?

Socket

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.

Install

Related posts