Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (eslint-config-heck) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

eslint-config-heck

eslint-config-heck contains an ESLint configuration for ES2015+, TypeScript, and React.

Installation

npm install --save-dev eslint eslint-config-heck

Usage

To use one of the included configurations, create a .eslintrc.json file and use the extends keyword.

For a Node.js project use:

{
    "extends": "heck/node"
}

If you are in the browser, use:

{
    "extends": "heck/browser"
}

Extensions

Complexity

Optionally you can enable some complexity rules by using the complexity configuration in addition to the node or browser rules:

{
    "extends": ["heck/node", "heck/complexity"]
}

Group imports

Optionally you can switch to another import sorting rule, which groups the imports by type and supports auto fixing. You can enable this rule by adding the groupImports configuration in addition to the node or browser rules:

{
    "extends": ["heck/node", "heck/groupImports"]
}

React Native

If you are using react-native, you can enable react-native specific rules:

{
    "extends": ["heck/node", "heck/reactNative"]
}

No formatting

To disable some of the formatting rules (when using a formatter like prettier or Rome) you can use this configuration:

{
    "extends": ["heck/node", "heck/noFormatting"]
}

Rules with usage of Biome

If you are using Biome you can use "nodeWithBiome" or "browserWithBiome":

{
    "extends": ["heck/nodeWithBiome"]
}

If you are using Biome you can also extend your Biome config with the "biomeLinting.json":

{
    "$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
    "extends": ["./node_modules/eslint-config-heck/biomeLinting.json"]
}

Exclude rules included in Rome

To disable some the rules that are already included in Rome you can use this configuration:

{
    "extends": ["heck/node", "heck/excludeRome"]
}

Attention: Since Rome is no longer maintained, this will not be the case with this ruleset. Use the Biome rulesets instead.