Git Product home page Git Product logo

eslint-plugin-makestyles's Introduction

eslint-plugin-makestyles

There is a feature of Material-UI makeStyles function that adds a name to the generated className. If you use it then you get nice classNames like this MyComponent-root-123 instead of makeStyles-root-123

This rule helps to ensure the developer does not forget to add a name option to Material-UI makeStyles function.

Rule Details

Examples of incorrect code for this rule:

var useStyles = makeStyles({
  root: {
    color: "red"
  }
});

Examples of correct code for this rule:

var useStyles = makeStyles(
  {
    root: {
      color: "red"
    }
  },
  {
    name: "MyComponent"
  }
);

Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install eslint-plugin-makestyles:

$ npm install eslint-plugin-makestyles --save-dev

Note: If you installed ESLint globally (using the -g flag) then you must also install eslint-plugin-makestyles globally.

Usage

Add this to your your .eslintrc configuration file to get our recommended rule setup (only warnings).

"extends": [
    "plugin:makestyles/recommended",
  ]

If you do not want to use the preset you will need to specify individual rules and add extra configuration.

Add makestyles to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
  "plugins": ["makestyles"]
}

Then configure the rules you want to use under the rules section.

{
  "rules": {
    "makestyles/makestyles-with-name": "error"
  }
}

Links

eslint-plugin-makestyles's People

Contributors

dependabot[bot] avatar madflanderz avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.