@hedgehoglab/eslint-config

This package contains the standard ESlint configuration used on all hedgehog lab projects, both internally and for our clients.

This package is meant to be used with eslint configs using the new ESlint flat config format.

[!NOTE]
This package contains all the configs of the org, including all framework specific configs. Framework specific configs do not need to be pulled in alongside this one.

Usage

Add the config to your project dependencies:

yarn add -D @hedgehoglab/eslint-config

or

pnpm add -D @hedgehoglab/eslint-config

or

npm install -D @hedgehoglab/eslint-config

Add the config to your eslint.config.js:

import hedgehogLab from '@hedgehoglab/eslint-config';

export default hedgehogLab;

If using multiple config objects, or your own local rules:

import hedgehogLab from '@hedgehoglab/eslint-config';

export default [
    // The combined config returns an array of all sub-configs 
    // so needs to be spread into the exported aray of the 
    // ESLint flat file format 
    ...hedgehogLab,
    
    // ...any other config objects
];

Contributing

If you disagree with any rules in this linter, or feel additional rules should be added, please open an issue on this project to initiate an open dialogue with all team members.

Please bear in mind this is a public repository, and all contributions follow the project Code of Conduct.

For instructions on how to contribute code to this project, please see the CONTRIBUTING.md.