ESLint Config

This repo serves as the shared ESLint config for We and Them projects.

Table of contents

• Using this package
• Developing
  • Setup
  • File structure
  • Development flow

Using this package

1. Install this package and its peer dependencies as dev dependencies in your project:

   $ npm i -D eslint prettier @weandthem/eslint-config @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint-config-prettier eslint-plugin-import eslint-plugin-jest eslint-plugin-jest-formatting eslint-plugin-prettier eslint-plugin-react eslint-plugin-simple-import-sort eslint-plugin-spellcheck eslint-plugin-typescript-filenames eslint-plugin-unicorn

2. Extend your .eslintrc.js with this package

   extends: ['@weandthem/eslint-config'],

3. Override rules in your local .eslintrc.js as necessary

Developing

Setup

1. Clone this repo

   $ git clone https://github.com/WeAndThem/eslint-config.git

2. Enter the cloned directory

   $ cd eslint-config

3. Install dependencies

   $ npm install

VS Code is recommended because this repo includes environmental settings that help create a consistent development environment across engineers. Upon opening this repo in VS Code, you'll be prompted to install recommended extensions.

File Structure

• .github/workflows/ GitHub Actions configs
• .vscode/ Shared VS Code config
• scripts/ Shell scripts used with Husky git hooks
• index.js Shared ESLint configuration

Development flow

1. Do not work on master! Create local branches off of master. We have git hooks configured to prevent committing or pushing to master. Forking is disabled for this repo.

2. Keep commits small and commit messages relevant. Prepend the Jira ticket number to at least one of your commits for reporting.

   Example:

   HAR-94: add sorting rule

3. pre-commit and pre-push hooks should help maintain consistent code styles, but can also be run manually as necessary:

   $ npm run prettify

4. Test changes locally against another We and Them project by linking this module globally:

   $ npm link

   Then, in another We and Them project that consumes this config:

   $ npm link @weandthem/eslint-config

   Changes made in this project are immediately reflected in the other project until the link is broken.

5. Bump the project version in package.json

6. Run npm install to update the version in package-lock.json

7. Commit package.json and package-lock.json in an isolated commit with the following convention:

   $ git commit -m 'Release 0.0.6'

   The GitHub action that publishes the package will read this commit and tag the release appropriately.

8. Open pull requests against master and select an assignee to review the changes.

9. The assignee leaves any necessary comments and selects either "approve" or "reject" on GitHub.

10. Once the PR is approved, the author performs the merge.

11. A GitHub Action will publish the package automatically.

12. Projects consuming this config will need to run npm update to receive the changes.