1.0.0-beta.0 • Published 1 year ago

@hellomonday/eslint-config v1.0.0-beta.0

Weekly downloads
-
License
MIT
Repository
-
Last release
1 year ago

@hellomonday/eslint-config

This is a work in progress. The infrastructure is complete but we need to regroup as a team.

Shareable configs are designed to work with the extends feature of .eslintrc files. Instead of using a file path for the value of extends, use your module name. In this case @hellomonday/eslint-config.

This config currently supports:

  • TypeScript
  • Prettier

Getting Started

This is our preferred configuration for eslint. To use it:

pnpm add @hellomonday/eslint-config

... or using NPM:

npm install @hellomonday/eslint-config

and then change your .eslintrc to have:

{
  "extends":  "@hellomonday"
}

Tip: Remember to install peer dependencies.

NPM Scripts

I recommend you add a lint NPM script to your package.json similar to the example below:

{
  "scripts": {
    "lint": "eslint .",
  }
}

or if used in combination with Prettier:

{
  "scripts": {
    "lint": "prettier --plugin-search-dir . --check . && eslint .",
    "format": "prettier --plugin-search-dir . --write ."
  }
}

Feedback

This is config is a work in progress. Please provide feedback by adding issues and PRs on GitHub.

Learn More

TODO

  • Customize rules to our liking (Team).
  • Support Prettier.
  • Add import rules.

Copyright

Hello Monday