https://github.com/anantoghosh/eslint-config-good-code

A strict eslint configuration for typescript projects promoting good and maintainable coding practices.
https://github.com/anantoghosh/eslint-config-good-code

code config eslint good maintainable smell strict typescript

Last synced: 3 months ago
JSON representation

A strict eslint configuration for typescript projects promoting good and maintainable coding practices.

• Host: GitHub
• URL: https://github.com/anantoghosh/eslint-config-good-code
• Owner: anantoghosh
• License: mit
• Created: 2021-02-21T14:54:01.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-09-21T08:07:50.000Z (over 3 years ago)
• Last Synced: 2024-10-11T13:29:55.705Z (3 months ago)
• Topics: code, config, eslint, good, maintainable, smell, strict, typescript
• Language: JavaScript
• Homepage:
• Size: 83 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# eslint-config-good-code ✨ [![npm version](https://img.shields.io/npm/v/eslint-config-good-code?logo=npm)](https://www.npmjs.com/package/eslint-config-good-code) ![GitHub Workflow Status](https://img.shields.io/github/workflow/status/anantoghosh/eslint-config-good-code/Node.js%20CI?label=Tests&logo=github)

> A shared strict eslint configuration for typescript (>=3.8) projects.

This package defines a strict eslint config to prevent code smells and promote maintainable coding practices.  

It combines recommend settings from eslint, typescript-eslint, unicorn, sonarjs and further enables more rules.

## Installation

_Before installation make sure your project has eslint (>=7) and typescript (>=3.8) available._

Step 1: Install the required packages

```sh

npm i -D eslint-config-good-code @typescript-eslint/eslint-plugin eslint-plugin-sonarjs eslint-plugin-unicorn

```

Step 2: Extend the config in your app package.json

```js

  "eslintConfig": {

    "extends": [

      "eslint-config-good-code"

    ]

  }

```

## Principles

- Typescript only (with tsx) - No react, jest, a11y etc. rules. Use in any kind of project.

- No stylistic rules.

- No conflicting or double enforced rules.

- No enforcing of rules which typescript can already prevent.

- _(future) Multiple configurations - Allow a developer to choose what's required._

- _(future) Modular config - Allow customization per project._

## Dealing with difficult rules

#### [Readonly Parameters](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/prefer-readonly-parameter-types.md)

Mutating objects passed as parameters can lead to unintended bugs. It is highly recommended that this rule should be kept enabled.

But typescript does not ship with anything to make an object deeply immutable (aka readonly). Therefore, you can add [type-fest](https://github.com/sindresorhus/type-fest), which includes ReadonlyDeep type to mark any object as readonly.

## Acknowledgment

This project was made possible due to the incredible work done on the following projects:

- [eslint](https://eslint.org/)

- [typescript-eslint](https://github.com/typescript-eslint/typescript-eslint)

- [eslint-plugin-unicorn](https://github.com/sindresorhus/eslint-plugin-unicorn)

- [eslint-plugin-sonarjs](https://github.com/SonarSource/eslint-plugin-sonarjs)

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.