Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
SamuelAlev committed Dec 20, 2023
1 parent 97e5b64 commit 3dedd31
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,16 @@
# Frontify ESLint configuration
# Frontify ESLint configurations

This repository contains all Frontify ESLint configurations for its projects.

## Usage

The configurations are published in 3 different flavors:
- `@frontify/eslint-config-base`: The base configuration including JavaScript and TypeScript rules.
- `@frontify/eslint-config-react`: The base configuration including React rules.
- `@frontify/eslint-config-vue2`: The base configuration plus Vue 2 rules.

Types aware rules are enabled on all 3 configurations, you will need to define the `tsconfig.json` file in your project and set the path to it in the ESLint Config file ([`parserOptions.project`](https://typescript-eslint.io/packages/parser/#project)).

## Publish a new version

This repository uses [Changeset](https://github.com/changesets/changesets) to generate the changelog file.
Expand Down

0 comments on commit 3dedd31

Please sign in to comment.