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

My shared ESLint config
https://github.com/skarab42/eslint-config

config eslint eslint-config hardcore typescript

Last synced: 10 days ago
JSON representation

My shared ESLint config

• Host: GitHub
• URL: https://github.com/skarab42/eslint-config
• Owner: skarab42
• License: mit
• Created: 2022-07-27T06:36:16.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-21T09:40:54.000Z (5 months ago)
• Last Synced: 2024-09-23T04:38:18.306Z (about 2 months ago)
• Topics: config, eslint, eslint-config, hardcore, typescript
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/@skarab/eslint-config
• Size: 296 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# My shared ESLint config

## Installation

```bash

pnpm add -D typescript eslint @skarab/eslint-config

```

## Basic usage

Add `@skarab/eslint-config/recommended` or `@skarab/eslint-config/recommended-commonjs` to the extends section of your ESLint configuration file.

```json

{

  "extends": ["some-other-config-you-use", "@skarab/eslint-config/recommended"]

}

```

## Advenced usages

This ESLint configuration is designed to be highly customizable, allowing for flexible setup options that cater to different environments and scenarios, including automatic detection of TypeScript.

### Importing and Configuring

To start, in your `.eslintrc.js`, import the `config` function:

```ts

const { config } = require('@skarab/eslint-config');

```

### Configuring options

The `config` function accepts an object of type `ConfigOptions`, enabling you to customize the ESLint setup for your project. The configuration supports **automatic TypeScript detection** but also allows you to explicitly enable or disable TypeScript support based on your requirements.

Here's an example of configuring the ESLint setup:

```ts

// .eslintrc.js

// ...

module.exports = config({

  ts: true,

  jsx: true,

  node: true,

  browser: false,

  type: 'module',

  ecmaVersion: 2020,

  environments: ['jest'],

  reportUnusedDisableDirectives: true,

  ignores: ['**/dist/**', '**/node_modules/**'],

});

```

### Example Usage

#### Basic Configuration for Node.js

For a simple Node.js project using ECMAScript modules:

```ts

const basicConfig = config({

  node: true,

  type: 'module',

});

```

#### TypeScript Project

For a project using TypeScript, where TypeScript is detected automatically:

```ts

const tsConfig = config({

  // TypeScript is automatically detected

  jsx: true,

  ecmaVersion: 2020,

});

```

To explicitly disable TypeScript support:

```ts

const tsConfigExplicit = config({

  ts: false,

  jsx: true,

  ecmaVersion: 2020,

});

```

#### Browser Environment

For a project tailored to run in a browser environment:

```ts

const browserConfig = config({

  browser: true,

  node: false,

});

```

# Related tools

- [@skarab/eslint-staged](https://github.com/skarab42/eslint-staged)

# My other shared configurations

- [@skarab/prettier-config](https://github.com/skarab42/prettier-config)

- [@skarab/typescript-config](https://github.com/skarab42/typescript-config)