README.md

@underline/eslint-config

Underline's shared ESLint config for Javascript, TypeScript, Node.js & Ember.js apps.

• @underline/eslint-config: The base config that all other configs extend from.
• @underline/eslint-config-node: Adds Node.js-specific rules and sets the environment.
• @underline/eslint-config-typescript: Adds support for parsing TypeScript, as well as TypeScript-specific rules.
• @underline/eslint-config-ember: Adds Ember.js-specific rules.
• @underline/eslint-config-ember-typescript: Combines eslint-config-ember and eslint-config-typescript.

❗ Requirements

• ESLint is required to use this plugin.

🚀 Usage

This process is the same for any of the packages included here.

1. Install plugin

pnpm add --save-dev @underline/eslint-config

2. Modify your .eslintrc.js:

Shareable configs are designed to work with the extends feature of .eslintrc files.

extends: [
  '@underline/eslint-config'
]

💅 Prettier

Our ESLint config is setup to be used in conjunction wit Prettier for formatting code in editors (eg. VS Code, Atom, Sublime, Vim). We include the base .prettierrc.js file in the base package. You can require that file and use that in your application.

Create a file in the root of your application named .prettierrc.js with the following content:

module.exports = require('@underline/eslint-config/.prettierrc.js');

License

Copyright (c) 2020 Underline Infrastructure Inc.

Licensed under the MIT license.

Acknowledgement

Thanks to @ClarkSource's eslint-config for the ideas on how to organize this project.