0.0.2 • Published 4 months ago

eslint-plugin-stylefix v0.0.2

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

eslint-plugin-stylefix

NPM Version NPM License

ESlint plugin for style fixing and error detection.

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next install eslint-plugin-stylefix:

npm i --save-dev eslint-plugin-stylefix

Usage

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

{
  "plugins": ["stylefix"]
}

Recommended

As for the recommended rules two rules will be enabled with the sort-properties and validate-values is "warn".

  "extends": [
    "plugin:stylefix/recommended"
  ]

Rules

If you want to set security levels individually set them in the rules.

{
  "rules": {
    "stylefix/sort-properties": "warn",
    "stylefix/validate-values": "warn"
  }
}

※ If you use typescript you will need a suitable parser like typescript-eslint.
And if you are using eslint v8 and lower set "eslint.useESLintClass": true in vscode's setting.json.

Supports ESLint v9 and higher

npm install @eslint/js typescript-eslint --save-dev

If you are using eslint 9 or higher do not use this useESLintClass.

Usage (Flat Config eslint.config.mjs)

The following file is a configuration file that contains recommended settings for TypeScript and eslint.

import eslint from '@eslint/js'
import tseslint from 'typescript-eslint'
import stylefixlint from 'eslint-plugin-stylefix'

const eslintConfig = tseslint.config(
  eslint.configs.recommended
  ...tseslint.configs.strict
  stylefixlint.flatConfigs.recommended
  {
    files: ['**/*.{ts,tsx}']
  }
)

export default eslintConfig

Rule Description

sort-properties

Automatically sorts CSS properties using the predefined recess order for consistent, maintainable styles and standardized grouping that improves readability and collaboration.

validate-values

These are not validated as they have names with unique identifiers.
Validation includes other standard properties.

  • animationName
  • counterIncrement
  • counterReset
  • counterSet
  • font
  • fontFamily
  • gridArea
  • gridColumn
  • gridColumnEn
  • gridColumnStart
  • gridRow
  • gridRowEnd
  • gridRowStart
  • listStyleType
  • listStyle
  • transitionProperty
  • transition
  • viewTransitionName
  • willChange

License

MIT.