https://github.com/bradzacher/eslint-config-brad

my standardised eslint config
https://github.com/bradzacher/eslint-config-brad

Last synced: 3 months ago
JSON representation

my standardised eslint config

• Host: GitHub
• URL: https://github.com/bradzacher/eslint-config-brad
• Owner: bradzacher
• License: mit
• Created: 2019-01-09T01:10:16.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-10-18T01:36:23.000Z (about 1 year ago)
• Last Synced: 2024-09-20T01:47:57.403Z (4 months ago)
• Language: TypeScript
• Size: 876 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        
# eslint-config-brad

ESLint configuration files for my style

## Usage

```text

yarn add -D eslint-config-brad @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint eslint-plugin-eslint-comments eslint-plugin-import eslint-plugin-jest eslint-plugin-node eslint-plugin-simple-import-sort eslint-restricted-glob

```

If you're working on a non-react project:

```JSON

{

    "extends": [

        "brad",

    ],

}

```

If you're working on a react project:

```text

yarn add -D eslint-plugin-react eslint-plugin-react-hooks

```

```JSON

{

    "extends": [

        "brad/react",

    ],

}

```

### Prettier

Standardised prettier config can be used by creating the following `.prettierrc.json` in your project root:

```json

"eslint-config-brad/prettier"

```

## Developing

Clone the repo, and then install the dependencies `yarn install`

Available Commands:

- `make build` - run a typescript build on each package

- `make lint` - lint the entire codebase

- `make format` - run prettier on the codebase

- `make show-unused` - scan the packages and their plugins to find any rules that haven't been defined

- `make regenerate-types` - generate the typescript definition files for all of the valid, non-deprecated rules