Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

ESLint shareable config for TypeScript or JavaScript by @jessety
https://github.com/jessety/eslint-config

eslint eslint-config typescript

Last synced: 5 days ago
JSON representation

ESLint shareable config for TypeScript or JavaScript by @jessety

Host: GitHub
URL: https://github.com/jessety/eslint-config
Owner: jessety
License: mit
Created: 2019-01-02T22:26:12.000Z (almost 6 years ago)
Default Branch: main
Last Pushed: 2023-04-23T16:04:01.000Z (over 1 year ago)
Last Synced: 2024-09-23T15:48:12.352Z (about 2 months ago)
Topics: eslint, eslint-config, typescript
Language: JavaScript
Homepage: https://npmjs.com/package/@jessety/eslint-config
Size: 96.7 KB
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# @jessety/eslint-config

Yet another ESLint [Shareable Config](http://eslint.org/docs/developer-guide/shareable-configs.html) for TypeScript or JavaScript projects.

[![ci](https://github.com/jessety/eslint-config/workflows/ci/badge.svg)](https://github.com/jessety/eslint-config/actions/workflows/ci.yml)
[![npm](https://img.shields.io/npm/v/@jessety/eslint-config.svg)](https://www.npmjs.com/package/@jessety/eslint-config)
[![license](https://img.shields.io/github/license/jessety/eslint-config.svg)](https://github.com/jessety/eslint-config/blob/main/LICENSE)

## Install

```shell script
npm install --save-dev eslint @jessety/eslint-config
```

## Usage

Shareable configs work by leveraging the [`extends`](http://eslint.org/docs/user-guide/configuring#extending-configuration-files) feature in your [ESLint configuration](http://eslint.org/docs/user-guide/configuring). Once the package is installed, define `extends` to `@jessety`.

For example, a valid `.eslintrc.json` file could be:

```json
{
"extends": "@jessety"
}
```

_The `eslint-config` suffix may be omitted because it is assumed by ESLint._

### Configurations

This package contains the following sharable configurations:

- `base` - Core rules for TypeScript node projects. Does not require TypeScript build. Fast.
- `strict` - Stricter rules for TypeScript node projects. Requires type checking. Slower than `base`.
- `react` - Rules for a React project
- `javascript` - ESLint rules for JavaScript projects

As of version 2.x.x, `base` is the default export for `.ts` files, and `javascript` is the default for `.js`, `.mjs`, or `.cjs` files. To request one or the other, specify which in the `eslintrc` file. For example, a `.eslintrc.json` file that uses `react` configuration may look like this:

```json
{
"extends": "@jessety/eslint-config/react"
}
```

A project that uses a mix of both TypeScript and JavaScript may look like this:

```json
{
"overrides": [
{
"files": ["**/*.ts"],
"extends": "@jessety"
},
{
"files": ["**/*.{js,cjs,mjs}"],
"extends": "@jessety/eslint-config/javascript"
}
]
}
```

The `base` and `strict` configuration require `typescript` and `eslint` as peer dependencies. The `javascript` configuration only requires `eslint`.

## License