eslint-config-habitrpg

6.2.3 verified Sat Apr 25 auth: no javascript maintenance

Shared ESLint configuration for HabitRPG (Habitica) projects. Version 6.2.3 extends Airbnb's JavaScript style guide and provides profiles for Node.js, Vue.js, and Mocha test files. Requires ESLint ^6.5.1. Differs from raw Airbnb config by adding specific rule overrides for Habitica codebase, such as disabling no-extraneous-dependencies for monorepo compatibility and explicitly defining no-cycle settings. Release cadence is sparse, with last update in 2020.

Common errors

error Oops! Something went wrong! :( ESLint: 6.5.1. ESLint couldn't find the config "habitrpg". ↓

cause The eslint-config-habitrpg package is not installed or extends string is incorrect.

fix

Run 'npm install --save-dev eslint-config-habitrpg' and check your .eslintrc extends value.

error ESLint couldn't find the plugin "eslint-plugin-mocha". ↓

cause The mocha config requires eslint-plugin-mocha but it is not installed.

fix

Run 'npm install --save-dev eslint-plugin-mocha'.

Warnings

breaking Version 6 changed config structure: removed browser, server, esnext configs; added node, vue, mocha. ↓

fix Update your .eslintrc 'extends' to use 'habitrpg/node' instead of 'habitrpg/server'.

deprecated Version 6.2.3 is the last release; package is in maintenance mode with no recent updates. ↓

fix Consider migrating to a more actively maintained ESLint config like eslint-config-airbnb or @shopify/eslint-plugin.

gotcha ESLint peer dependency is ^6.5.1; not compatible with ESLint 7+. ↓

fix Use ESLint 6.x or pin eslint-config-habitrpg@5.0.0 if you need ESLint 7 compatibility.

gotcha The vue config requires eslint-plugin-vue to be installed separately. ↓

fix Run 'npm install --save-dev eslint-plugin-vue' and ensure it's listed in your dependencies.

Install

npm install eslint-config-habitrpg

yarn add eslint-config-habitrpg

pnpm add eslint-config-habitrpg

Imports

habitrpg/index
wrong
```
extends: 'eslint-config-habitrpg'
```
correct
```
extends: 'habitrpg'
```
In .eslintrc, use 'habitrpg' not the full package name.
habitrpg/node
```
extends: 'habitrpg/node'
```
For Node.js projects.

habitrpg/vue

wrong

extends: 'habitrpg/vue' without installing eslint-plugin-vue

correct

extends: 'habitrpg/vue'

Requires eslint-plugin-vue as a peer dependency.

Quickstart

Install ESLint and the config package, then set the extends field in your ESLint configuration to 'habitrpg' or one of its sub-configs.

npm install --save-dev eslint@^6.5.1 eslint-config-habitrpg
# .eslintrc.json
{
  "extends": "habitrpg"
}