https://github.com/mrcointreau/eslint-config-typescript

A custom ESLint configuration for TypeScript projects
https://github.com/mrcointreau/eslint-config-typescript

Last synced: about 1 month ago
JSON representation

A custom ESLint configuration for TypeScript projects

• Host: GitHub
• URL: https://github.com/mrcointreau/eslint-config-typescript
• Owner: mrcointreau
• Created: 2024-02-21T22:40:14.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-05-18T00:10:29.000Z (8 months ago)
• Last Synced: 2024-05-18T01:23:14.138Z (8 months ago)
• Language: JavaScript
• Homepage:
• Size: 163 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# TypeScript ESLint Configuration

This package provides an ESLint configuration tailored for TypeScript projects. It extends several recommended ESLint configurations and plugins to enforce a consistent code style and catch common mistakes in TypeScript code.

## Installation

Using npm

```bash

npm install --save-dev @mrcointreau/eslint-config-typescript eslint

```

Using Yarn

```bash

yarn add --dev @mrcointreau/eslint-config-typescript eslint

```

Using pnpm

```bash

pnpm add --save-dev @mrcointreau/eslint-config-typescript eslint

```

## Configuration

Create an `.eslintrc.cjs` file in the root of your project with the following contents:

```js

module.exports = {

  root: true,

  extends: ["@mrcointreau/eslint-config-typescript"],

};

```

To make it easy to run ESLint, add a script entry in your project's `package.json`:

```json

"scripts": {

  "lint": "eslint ."

}

```