eslint-config-allthings

ESlint shareable config for Allthings style

Setup

yarn add -DE @allthings/eslint-config

Usage

Create an eslint.config.js at your project root.

React projects

import allthingsConfig from '@allthings/eslint-config'

export default [
  ...allthingsConfig,
  {
    languageOptions: {
      parserOptions: {
        project: './tsconfig.json',
        tsconfigRootDir: import.meta.dirname,
      },
    },
  },
]

Node.js projects

import allthingsNodeConfig from '@allthings/eslint-config/node'

export default [
  ...allthingsNodeConfig,
  {
    languageOptions: {
      parserOptions: {
        project: './tsconfig.json',
        tsconfigRootDir: import.meta.dirname,
      },
    },
  },
]

Development

Run yarn link in the project folder

Run yarn link @allthings/eslint-config in the project that you want to test it against

After you finish run in your project yarn unlink @allthings/eslint-config and then yarn install --force to restore the initial state of dependencies

Or you could release a dev npm version with yarn deploy:dev. Remember to update the version in package.json

Production release

!! DO NOT npm version !!

The project uses semantic-release which automates the whole package release workflow including:

• determining the next version number
• generating the release notes and publishing the package

This repository is also configured to squash-merge (see here).
When you squash merge, GitHub takes the title of the PR for the squash-merge's commit subject.

By choosing a proper PR title e.g. feat: my new feature your merged PR will trigger a new release.
See semantic-releases docs for available prefixes.

Development release

1. Create or check out the target branch from the commit you want to release.

2. Push the branch to trigger the CI pipeline:

   git push --force origin HEAD:beta   # or alpha / next

   The pipeline will automatically run semantic-release, which detects the branch name, bumps the version with the appropriate pre-release tag, and publishes it to npm under the matching dist-tag. Check Actions page for the release logs.

3. Install the pre-release in another project:

   yarn add -E @allthings/eslint-config@beta   # or @alpha / @next

   or use exact release (check versions on npm):

   yarn add -E @allthings/[email protected]

4. Promote to stable – once the pre-release is validated, create a PR from your target branch and proceed with Production release section.