WellD's eslint configuration

This repository contains ESLint configuration for WellD's projects.

Getting Started

Install the package through your package manager of choice:

yarn add -D @welld/eslint-config

Install the necessary peer dependencies. You can list and install them manually by running:

npm info "@welld/eslint-config@latest" peerDependencies

Or you can run

npx install-peerdeps --dev @welld/eslint-config

install-peerdeps will take care of installing the peer dependencies for you (and will also detect Yarn if the project is using it).

There are four configurations available:

1. Plain JavaScript projects: extend @welld/eslint-config/js;
2. JavaScript and React projects: extend @welld/eslint-config/js-react;
3. Plain TypeScript projects: extend @welld/eslint-config/ts;
4. TypeScript and React projects: extend @welld/eslint-config/ts-react.

Prerequisites

• node
• yarn

Installing

Dependencies for the project can be installed through yarn install.

Development

Here you can find the documentation on how to create a ESLint shareable config.

You could edit a ESLint configuration and then test it on a test project.

npm link

Then in the test project, type:

npm link eslint-config-welld

Built With

• ESLint - Find and fix problems in your JavaScript code
• ESLint airbnb config

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

Matteo Codogno - Initial work

License

Look here