https://github.com/comandeer/eslint-config

Shareable ESLint configuration
https://github.com/comandeer/eslint-config

Last synced: 9 days ago
JSON representation

Shareable ESLint configuration

• Host: GitHub
• URL: https://github.com/comandeer/eslint-config
• Owner: Comandeer
• License: mit
• Created: 2018-04-14T12:24:34.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-10-12T23:22:06.000Z (24 days ago)
• Last Synced: 2024-10-13T23:44:31.691Z (23 days ago)
• Language: JavaScript
• Size: 871 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @comandeer/eslint-config

![Build Status](https://github.com/Comandeer/eslint-config/workflows/CI/badge.svg) [![npm (scoped)](https://img.shields.io/npm/v/@comandeer/eslint-config.svg)](https://npmjs.com/package/@comandeer/eslint-config)

Super opinionated [ESLint](https://eslint.org/) configuration.

## Installation

```bash

npm install @comandeer/eslint-config --save-dev

```

## Usage

Put it inside your `eslint.config.js` file:

```javascript

import { eslintConfig } from '@comandeer/eslint-config';

export default eslintConfig();

```

Optionally, you could also include formatting rules:

```javascript

import { eslintConfig } from '@comandeer/eslint-config';

import { formattingConfig } from '@comandeer/eslint-config/formatting';

export default [

	...eslintConfig(),

	...formattingConfig()

];

```

### Options

Both exports accepts the same set of options as an `options` object:

```javascript

eslintConfig( {

    tsProject: [ './packages/*/tsconfig.json' ]

} );

```

#### Available options

| Name        | Value type      | Default value           | Description                                                  |

| ----------- | --------------- | ----------------------- | ------------------------------------------------------------ |

| `tsProject` | `Array` | `[ './tsconfig.json' ]` | Paths to all TS config files in the project that should be used for linting. |

## License

See [LICENSE](./LICENSE) file for details.