README.md

@phi.school/eslint-config

A dynamic ESLint configuration for multiple frameworks, available as a single dependency.

Changelog · Report Bug · Request Feature

Table of Contents

• Features
• Supported Frameworks
  • Examples
• Installation
• Usage
• Roadmap
• Contributing
• License

Features

• Dynamic ESLint rules based on your project's dependencies such as React, TypeScript, Svelte, Vue, and more.
• Installs as a single devDependency: No need to install a bunch of internally extended configs
• Optionally overrides ESLint formatting with Prettier

Supported Frameworks

• Astro
• JSON
• Jest
• Node.js
• React (with rules for hooks and a11y)
• Svelte
• TypeScript
• Vue.js

Lint rules for a file are determined by its extension and the project's dependencies.

Examples

1. A file with a .tsx extension inside of a project with dependencies on typescript, react, and prettier will be linted with rules for TypeScript, React, and Prettier; Svelte or Vue rules will not be applied.
2. A file whose name matches the glob **/*.{spec,test}.{js?(x),ts?(x)} inside of a project with a dependency on jest will be linted with Jest rules.

Internally extended configurations

Beyond framework-specific rules, common lint rules are also sourced from the following configs/plugins:

• confusing-browser-globals
• eslint-config-prettier (only if your project depends on prettier)
• eslint-plugin-eslint-comments
• eslint-plugin-import
• eslint-plugin-no-use-extend-native
• eslint-plugin-promise
• eslint-plugin-regexp
• eslint-plugin-unicorn

Installation

pnpm i -D @phi.school/eslint-config

Usage

Extend this package in your local eslint config or package.json:

ESLint Config:

// .eslintrc.json
{
  "extends": ["@phi.school/eslint-config"]
}

package.json:

"eslintConfig": {
  "extends": [
    "@phi.school/eslint-config"
  ]
}

Roadmap

• Adopt ESLint's new Flat Config format.

Contributing

We welcome contributions! For a detailed guide on how to contribute, please refer to the Contributing section in the main README of the repository.

License

Released under the MIT License. © 2023-Present phi school