eslint-config-meedsio

1.0.5 verified Sat Apr 25 auth: no javascript

ESLint shareable config for Meeds.io based applications. Current stable version is 1.0.5, released with irregular cadence. Combines rules from plugin:vue/strongly-recommended, eslint:recommended, and plugin:vuejs-accessibility/recommended with additional custom rules. Suitable for Vue.js projects within the Meeds ecosystem. Differentiators include accessibility-focused linting via eslint-vue-a11y plugin and a curated set of overrides.

Common errors

error Error: Failed to load config 'eslint-config-meedsio' to extend from. ↓

cause Missing or incorrect installation of the package or its peer dependency eslint.

fix

Run 'npm install eslint eslint-config-meedsio --save-dev' or ensure both are in node_modules.

error Error: Cannot find module 'eslint-plugin-vue' ↓

cause Missing peer dependency plugin required by eslint-config-meedsio.

fix

Run 'npm install eslint-plugin-vue --save-dev' to install the missing plugin.

error Error: Failed to load plugin 'vuejs-accessibility' declared in 'eslint-config-meedsio'. ↓

cause Missing optional plugin 'eslint-plugin-vuejs-accessibility'.

fix

Run 'npm install eslint-plugin-vuejs-accessibility --save-dev'.

Warnings

breaking Version 1.0.5 added eslint-vue-a11y plugin which may introduce new lint errors for existing codebases. ↓

fix Review and fix accessibility violations; temporarily disable the plugin if needed.

deprecated The package name 'eslint-config-meedsio' uses the 'eslint-config' prefix, but npm shorthand resolution may fail if not referenced correctly. ↓

fix Always use the full package name 'eslint-config-meedsio' in extends.

gotcha This config is designed for Vue.js projects; applying it to non-Vue projects may cause unnecessary rule errors. ↓

fix Use only in Vue.js projects or override Vue-specific rules.

gotcha The config extends 'plugin:vue/strongly-recommended' which enforces Vue-specific rules that may conflict with other style guides. ↓

fix Review Vue rules and override as needed.

Install

npm install eslint-config-meedsio

yarn add eslint-config-meedsio

pnpm add eslint-config-meedsio

Imports

default config
wrong
```
module.exports = { extends: ['meedsio'] }
```
correct
```
module.exports = { extends: ['eslint-config-meedsio'] }
```
The full npm package name 'eslint-config-meedsio' is required in the extends array.
default config (ESM)
wrong
```
export default { extends: ['meedsio'] }
```
correct
```
export default { extends: ['eslint-config-meedsio'] }
```
Use the full package name; no ESM-specific export from this package.
use in .eslintrc
wrong
```
{
  "extends": "meedsio"
}
```
correct
```
{
  "extends": "eslint-config-meedsio"
}
```
Shorthand like 'meedsio' is not supported; the full scope-less name 'eslint-config-meedsio' must be used.

Quickstart

Installation and usage of eslint-config-meedsio in a JavaScript project with ESLint.

// First, install dependencies
// npm install --save-dev eslint eslint-config-meedsio

// Then create .eslintrc.js
module.exports = {
  extends: [
    'eslint-config-meedsio'
  ],
  // Override rules if needed
  rules: {
    'vue/multi-word-component-names': 'off'
  }
};

// Or use .eslintrc.json (JSON)
{
  "extends": "eslint-config-meedsio"
}