1.7.0 • Published 10 months ago

@griffel/eslint-plugin v1.7.0

Weekly downloads
-
License
MIT
Repository
github
Last release
10 months ago

ESLint plugin for Griffel

ESLint plugin to follow best practices and anticipate common mistakes when writing styles with Griffel

Install

yarn add --dev @griffel/eslint-plugin
# or
npm install --save-dev @griffel/eslint-plugin

Usage

Add @griffel to the plugins section and plugin:@griffel/recommended to the extends section of your .eslintrc configuration file:

{
  "plugins": ["@griffel"],
  "extends": ["plugin:@griffel/recommended"]
}

Shareable configurations

This plugin exports recommended configuration that enforce good practices, but you can choose to use only the ones that are necessary for your use case:

{
  "plugins": ["@griffel"],
  "rules": {
    "@griffel/hook-naming": "error",
    "@griffel/no-shorthands": "error",
    "@griffel/pseudo-element-naming": "error"
  }
}

You can find more info about enabled rules in the Supported Rules section below.

Supported Rules

Key: 🔧 = fixable

NameDescription🔧
@griffel/hook-namingEnsure that hooks returned by the makeStyles() function start with "use"
@griffel/no-invalid-shorthand-argumentsAll shorthands must not use space separators, and instead pass in multiple arguments
@griffel/no-shorthandsEnforce usage of CSS longhands
@griffel/styles-fileEnsures that all makeStyles() and makeResetStyles() calls are placed in a .styles.js or .styles.ts filelimitations)
@griffel/pseudo-element-namingEnsures that all Pseudo Elements start with two colons
@griffel/top-level-stylesEnsures that all makeStyles(), makeResetStyles() and makeStaticStyles() calls are written in the top level of a file to discourage developer misuse.
1.7.0

10 months ago

1.6.4

1 year ago

1.6.3

1 year ago

1.6.2

1 year ago

1.6.1

1 year ago

1.6.0

2 years ago

1.5.2

2 years ago

1.5.1

2 years ago

1.5.0

2 years ago

1.4.0

2 years ago

1.3.0

2 years ago

1.2.0

2 years ago

1.1.0

3 years ago

1.0.0

3 years ago