https://github.com/comandeer/eslint-config
Shareable ESLint configuration
https://github.com/comandeer/eslint-config
Last synced: 2 months 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 (about 7 years ago)
- Default Branch: main
- Last Pushed: 2025-03-08T00:37:40.000Z (3 months ago)
- Last Synced: 2025-03-15T14:34:33.588Z (2 months ago)
- Language: JavaScript
- Size: 986 KB
- Stars: 1
- Watchers: 2
- 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
 [](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. |
| `allowDefaultExports` | `Array` | `[]` | Glob patterns for files that are allowed to contain default exports. **Default exports are always allowed in config files (`**/*.config.{js,mjs,ts,mts}`)** |
## License
See [LICENSE](./LICENSE) file for details.