Registry / testing / eslint-plugin-gamut

eslint-plugin-gamut

library2.4.3jsnpmunverified

ESLint plugin for Codecademy's Gamut design system, version 2.4.3 (stable, maintained). Provides rules and configurations tailored for Gamut applications, enforcing best practices for gamut-styles, gamut-icons, and other Codecademy libraries. Ships with TypeScript definitions. Part of the larger Gamut monorepo with regular releases. Differentiators: built-in presets for Gamut-specific patterns, seamless integration with Codecademy's design system.

testing

npm install eslint-plugin-gamut

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · ESLINT-PLUGIN-GAMU

eslint-plugin-gamut

testingjavascriptv2.4.3

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-gamut'

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

ESM default export since v2. For CJS, use `const plugin = require('eslint-plugin-gamut').default`.

configs

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

✗ import configs from 'eslint-plugin-gamut/configs'

Named export for preset configurations. Works in ESM and CJS.

rules

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

✗ import rules from 'eslint-plugin-gamut/rules'

Named export for individual rule objects. Use this for custom rule configuration.

configs.recommended

✓ import { configs } from 'eslint-plugin-gamut'; // use configs.recommended

✗ import configs from 'eslint-plugin-gamut/recommended'

Access recommended config via configs.recommended.

Shows how to enable eslint-plugin-gamut in an ESLint config using recommended preset and a specific rule.

// .eslintrc.js module.exports = { plugins: ['gamut'], extends: ['plugin:gamut/recommended'], rules: { 'gamut/no-deprecated-gamut-components': 'error', }, };

Debug

Known issues

breakingIn v2, the plugin switched from CommonJS to ESM-only exports. Requires ESLint 8+ with ESM support or bundler.

fix

Update ESLint to 8+ and set `type: 'module'` in package.json, or use a bundler that handles ESM. For CJS projects, use dynamic import.

affects: >=2.0.0

breakingRemoved support for deprecated gamut-styles v16 rules. Existing configurations referencing v16-specific rules will break.

fix

Update to gamut-styles v17 and adjust rules accordingly. Remove or replace any rules targeting gamut-styles v16.

affects: >=2.0.0

deprecatedRule `gamut/no-deprecated-gamut-illustrations` is deprecated in favor of a more general rule covering all deprecated Gamut assets.

fix

Replace with `gamut/no-deprecated-assets` and update the configuration.

affects: >=1.5.0

Errors

Common errors & fixes

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

Plugin not installed or ESLint cannot resolve it.

fix

Run `npm install eslint-plugin-gamut --save-dev` and ensure node_modules is present.

TypeError: plugin.rules is not an iterable

Using CJS `require` on an ESM-only package without default interop.

fix

Use `const plugin = require('eslint-plugin-gamut').default;` or switch to ESM imports.

ESLint: 'plugin:gamut/recommended' configuration is deprecated. Use 'extends: ['eslint-plugin-gamut/configs/recommended']'.

Old string-based extends syntax no longer supported since v2.3.0.

fix

Use the config object: `extends: [require('eslint-plugin-gamut').configs.recommended]` or the new plugin prefix syntax: `'plugin:gamut/recommended'` if supported.

Upgrade

Version history

2.4.3latest on npm

Audit

Dependencies

eslintrequiredPeer dependency, required to use ESLint plugins.

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/Codecademy/gamut ↗

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

homepagehttps://gamut.codecademy.com ↗