https://github.com/tracktor/eslint-config-react-tracktor

Tracktor set ESLint rules for javascript projects
https://github.com/tracktor/eslint-config-react-tracktor

eslint eslint-config react

Last synced: about 1 month ago
JSON representation

Tracktor set ESLint rules for javascript projects

• Host: GitHub
• URL: https://github.com/tracktor/eslint-config-react-tracktor
• Owner: Tracktor
• License: isc
• Created: 2022-07-20T11:57:39.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-03-18T14:09:05.000Z (10 months ago)
• Last Synced: 2024-11-17T03:16:05.776Z (2 months ago)
• Topics: eslint, eslint-config, react
• Language: JavaScript
• Homepage:
• Size: 479 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# eslint-config-react-tracktor

[![npm version](https://badge.fury.io/js/eslint-config-react-tracktor.svg)](https://badge.fury.io/js/eslint-config-react-tracktor)

A set of opinionated [ESLint](http://eslint.org) rules for react projects

- [Installation](#Installation)

- [Usage](#Usage)

- [Specific rules](#Specific-rules)

- [Read more](#Read-more)

## Installation

```console

yarn add eslint-config-react-tracktor -D

```

## Usage

Create a file named `.eslintrc` in your root project and extends config :

```json

{

  "extends": "eslint-config-react-tracktor",

  "rules": {

    "...": "..."

  },

  "overrides": "..."

}

```

## Specific rules

For better compatibility with generated api files, 

some rules are disabled inside `src/api` folder.

```json

{

  "files": "./src/api/**/*.ts",

  "rules": {

    "indent": "off",

    "no-duplicate-imports": "off",

    "sort-keys": "off",

    "no-redeclare": "off",

  }

}

```

## Read more

Read more about eslint rules here: http://eslint.org/docs/rules

## Convention

- [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript)

- [Versioning](https://semver.org/)

- [Conventional Commits](https://www.conventionalcommits.org)