AHA ESLint Rules

This repo serves as a common configuration for ESLint rules, with the intention of making our rules consistent across repositories.

Usage

Extend the rules provided by this repo in a flat eslint config. There are three exports depending on the code type.

• NPM Library: ahaCoreLint
• React: ahaLint
• Jest: ahaJestLint

Example

// @ts-check
import { ahaLint, ahaJestLint } from '@aimhigh/aha-eslint-rules'
import tseslint from 'typescript-eslint'

export default tseslint.config(
  {
    ignores: ['**/dist/*', '**/node_modules/*'],
  },
  {
    extends: [ahaLint],
    languageOptions: {
      parserOptions: {
        projectService: {
          allowDefaultProject: [
            'eslint.config.mjs',
          ],
        },
        tsconfigRootDir: import.meta.dirname,
      },
    },
  },
  {
    files: ['**/*.spec.*'],
    extends: [ahaJestLint],
  }
)

Publishing

1. Login to npm using npm login
2. Enter your npm username and password
3. Install the current package npm i
4. Test the package before publishing npm i aha-eslint-rules
5. Increment the version using npm version patch|minor|major
6. Dry run the publish to verify everything works npm publish --dry-run
7. Publish using npm publish --access public