@styx-ui/eslint-config v0.2.0

@styx-ui/eslint-config

This project maintains the base ESLint configuration for Styx UI. This package provides the convenience of not having to copy and paste the same configuration for every new project.

Installation

yarn add @styx-ui/eslint-config --dev
# or
npm install @styx-ui/eslint-config --save-dev
# or
pnpm add -D @styx-ui/eslint-config

Usage

In your .eslintrc.json (or alternative config entry) extend the configuration.

{
  "root": true,
  "extends": ["@styx-ui/eslint-config"]
}

While it is possible to pass options to Prettier via your ESLint configuration file, it is not recommended because editor extensions such as prettier-atom and prettier-vscode will read .prettierrc, but won't read settings from ESLint, which can lead to an inconsistent experience.

To fix prettier errors by editor extensions, create a new .prettierrc.json (or alternative config entry) file at the root of your project and paste the prettier options used in config.

{
  "printWidth": 100,
  "semi": false,
  "singleQuote": true,
  "trailingComma": "all",
  "endOfLine": "auto"
}

License

This project is licensed under the MIT License.