npm

Share private packages across your team with npm Orgs, now with simplified billing via the aws marketplace!Learn more »

eslint-plugin-tachyons-jsx

0.1.4 • Public • Published

eslint-plugin-tachyons-jsx

An eslint plugin that enforces the order of tachyons classes in jsx

Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install eslint-plugin-tachyons-jsx:

$ npm install eslint-plugin-tachyons-jsx --save-dev

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

Usage

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

{
  "plugins": ["tachyons-jsx"]
}

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

{
  "rules": {
    "tachyons-jsx/order-jsx-classnames": 2
  }
}

In order to get eslint to work with JSX you need to add the following parser options:

{
  "parserOptions": {
    "ecmaVersion": 2018,
    "sourceType": "module",
    "ecmaFeatures": {
      "jsx": true
    }
  }
}

Complete .eslintrc example:

{
  "plugins": ["tachyons-jsx"],
  "rules": {
    "tachyons-jsx/order-jsx-classnames": 2
  },
  "parserOptions": {
    "ecmaVersion": 2018,
    "sourceType": "module",
    "ecmaFeatures": {
      "jsx": true
    }
  }
}

It's highly recommended to do the following:

Download the eslint extension for vscode (or whichever editor you use)

Navigate to the eslint settings and set eslint.autoFixOnSave to true

Ordering Methodology

Based on concentric CSS

Classes are split into 4 categories in order of precedence:

{
    /* Placement Classes - 0 */
    display: ;
    position: ;
    float: ;
    clear: ;
    visibility: ;
    opacity: ;
    z-index: ;
 
    /* Box Classes - 1 */
    margin: ;
    outline: ;
    border: ;
    background: ;
    padding: ;
    width: ;
    height: ;
    overflow: ;
 
    /* Text Classes - 2 */
    color: ;
    text: ;
    font: ;
 
    /* Non-tachyons Classes - 3 */
    * ;
}

The classes within each category are sorted alphanumerically.

If you want a detailed look at which class belongs to which category click here.

Custom Ordering

If you have custom tachyons-like classes you may configure which category they belong to like so:

{
  "rules": {
    "tachyons-jsx/order-jsx-classnames": [
      2,
      {
        "center-xl": 0,
        "w-58-ns": 2
      }
    ]
  }
}

The number refers to which category they belong to.

  • 0 - Placement Classes
  • 1 - Box Classes
  • 2 - Text Classes
  • 3 - Non-tachyons Classes

install

npm i eslint-plugin-tachyons-jsx

Downloadsweekly downloads

0

version

0.1.4

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability