eslint-prettier-configs

eslint-prettier-configs

Introduction

Eslint prettier configs package exposes basic eslint and prettier configurations for Nodejs and React projects.

Main features:

• Easy Integration
• Exposes Eslint Configuration for Nodejs and React projects
• Exposes prettier configuration
• No need to worry about the eslint plugins installation. Package will install all the necessary plugins

Install

The package can easily be integrated in any project nodejs or react.

 npm install -D eslint-prettier-configs

Usage

1. Install the package

2. Eslint configuration can easily be included in the package. Based on the project eslint configuration can be extended with a project-specific configuration

3. For NodeJS project, extend the .eslintrc with:

{
  "extends": ["./node_modules/eslint-prettier-configs/eslint-config-node.json"]
}

4. For React project, extend the .eslintrc with:

{
  "extends": ["./node_modules/eslint-prettier-configs/eslint-config-react.json"]
}

5. Extending prettier configuration is kind of special case, instead of ".prettierrc" create a ".prettierrc.js" file and extend the configuration:

module.exports = {
  ...require('./node_modules/eslint-prettier-configs/prettierrc.json')
}

Supported Eslint Plugins

Following eslint plugins are supported in eslint-prettier-configs package

• @typescript-eslint/eslint-plugin
• @typescript-eslint/parser
• eslint
• eslint-config-airbnb
• eslint-config-airbnb-typescript
• eslint-config-prettier
• eslint-config-standard-with-typescript
• eslint-import-resolver-node
• eslint-import-resolver-typescript
• eslint-plugin-import
• eslint-plugin-n
• eslint-plugin-prettier
• eslint-plugin-promise
• eslint-plugin-react
• eslint-plugin-react-hooks

References

• Eslint Documentation
• Prettier Documentation

License

MIT