Registry / testing / eslint-plugin-adonis

eslint-plugin-adonis

library2.1.1jsnpmunverified

ESLint plugin providing rules for AdonisJS applications and addons, maintained by the AdonisJS community. Current stable version is 3.0.3 (released 2023-06-13), release cadence is irregular. Features TypeScript support and is designed for AdonisJS 5+ with ESM modules. v3 major release targets ESM and updated coding style; v2.x supports ESLint 8. Differentiates from generic ESLint configs by providing AdonisJS-specific conventions like Edge template rules, Lucid ORM usage, and Ace commands.

testing web-framework

npm install eslint-plugin-adonis

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · ESLINT-PLUGIN-ADON

eslint-plugin-adonis

testingjavascriptv2.1.1

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

plugin

✓ import plugin from 'eslint-plugin-adonis'

✗ const plugin = require('eslint-plugin-adonis')

ESM-only since v3; v2 supports both CJS and ESM

configs

✓ import { configs } from 'eslint-plugin-adonis'

✗ const configs = require('eslint-plugin-adonis').configs

Named export for configs; available in v2 and v3

rules

✓ import { rules } from 'eslint-plugin-adonis'

Exported if you need to extend rules programmatically

Example ESLint configuration using adonis plugin with common and TypeScript presets, showing rule customization.

// .eslintrc.cjs module.exports = { extends: [ 'plugin:adonis/common', 'plugin:adonis/typescript' // if using TS ], plugins: ['adonis'], parserOptions: { ecmaVersion: 2020, sourceType: 'module' }, rules: { 'adonis/no-unused-vars': 'warn', 'adonis/sort-imports': 'off' } };

Debug

Known issues

breakingv3 drops CommonJS support and requires ESM. Migrate to ES modules or stay on v2.

fix

Switch to ESM by adding 'type': 'module' in package.json and using import syntax in .eslintrc.cjs or .eslintrc.js.

affects: >=3.0.0

gotchaRule 'unicorn/no-array-for-each' removed in v3.0.3; if you depend on it, upgrade or stay on v3.0.2.

fix

Use the base 'unicorn/no-array-for-each' rule directly (requires eslint-plugin-unicorn).

affects: >=3.0.3

deprecatedRule 'prefer-number-properties' was incorrectly referenced in v3.0.0-3.0.1; fixed in v3.0.2.

fix

Update to v3.0.2+ which uses 'unicorn/prefer-number-properties' prefix.

affects: >=3.0.0 <3.0.2

gotchaPlugin expects ESLint 8.x; using with ESLint <8 will fail.

fix

Update ESLint to version 8 or higher.

affects: >=2.0.0

breakingv2.0.0 dropped support for ESLint 7; upgrade from v1 to v2 requires ESLint 8.

fix

Run 'npm install eslint@8' and update config files.

affects: >=2.0.0 <3.0.0

Errors

Common errors & fixes

Error: Failed to load plugin 'adonis' declared in '.eslintrc': Cannot find module 'eslint-plugin-adonis'

Plugin not installed in project or global node_modules not visible.

fix

Run 'npm install --save-dev eslint-plugin-adonis' from project root.

Error: ESLint configuration in .eslintrc is invalid: - Configuration for rule 'adonis/no-unused-vars' is invalid: Value ["error"] is the wrong type.

Rule configuration expects an array but received a string or wrong format.

fix

Use object format: 'adonis/no-unused-vars': ['warn'] or set to 'off'.

Parsing error: The keyword 'import' is reserved

ESM syntax used with old parser; missing ecmaVersion or sourceType.

fix

Set parserOptions.ecmaVersion: 2020 (or higher) and sourceType: 'module'.

TypeError: Cannot set properties of undefined (setting 'adonis')

Plugin not registered in plugins array before extending.

fix

Add 'plugins: ['adonis']' to ESLint config.

Error: Rule 'unicorn/no-array-for-each' was not found.

Using v3.0.3+ where rule removed, or eslint-plugin-unicorn not installed.

fix

Update to v3.0.3+ or install eslint-plugin-unicorn if you need that specific rule.

Upgrade

Version history

2.1.1latest on npm

Audit

Dependencies

eslintrequiredPeer dependency; plugin requires ESLint 8 for v2.x and v3.x

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/AdonisCommunity/eslint-plugin-adonis ↗

packagehttps://www.npmjs.com/package/eslint-plugin-adonis ↗

homepagehttps://adonisjs.com ↗