Registry / testing / eslint-plugin-grommet

eslint-plugin-grommet

JSON →
library0.2.0jsnpmunverified

An ESLint plugin providing lint rules for enforcing Grommet component best practices and accessibility (a11y). Current stable version is 0.2.0, released September 2023. It includes rules like anchor-label, formfield-htmlfor-id, button-icon-a11ytitle, etc. The plugin follows a semver-like cadence with minor feature releases. Key differentiators: it complements Grommet's own a11y guidance and reduces manual review for common misuses. Peer dependency: eslint ^7.31.0.

testing
npm install eslint-plugin-grommet
github ↗package ↗
INSTALL
IMPORT
SIG · ESLINT-PLUGIN-GROM
E
eslint-plugin-grommet
testingjavascriptv0.2.0
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

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

plugin (recommended config)
✓ // .eslintrc { "extends": ["plugin:grommet/recommended"], "plugins": ["grommet"] }
✗ // Missing plugins or extension prefix { "extends": ["grommet/recommended"] }
Use 'plugin:grommet/recommended' to activate recommended rules. Plugins section is optional if using config only, but required for custom rule overrides.
specific rule
✓ // .eslintrc { "rules": { "grommet/anchor-label": "error" } }
✗ { "rules": { "anchor-label": "error" } }
Rule names must be prefixed with 'grommet/'.
require in Node.js (CJS)
✓ const plugin = require('eslint-plugin-grommet');
✗ const plugin = require('@grommet/eslint-plugin-grommet');
Package is 'eslint-plugin-grommet', not scoped.

Shows installation and configuration to enable recommended rules and customize specific rules like 'anchor-label' and 'formfield-htmlfor-id'.

// Install: npm install --save-dev eslint eslint-plugin-grommet // .eslintrc.json { "extends": ["plugin:grommet/recommended"], "plugins": ["grommet"], "rules": { "grommet/anchor-label": "error", "grommet/formfield-htmlfor-id": "warn" } }
Debug
Known issues
gotchaRecommended config overrides may suppress important a11y checks.
fix
Use 'extends: ["plugin:grommet/recommended"]' and only disable rules sparingly after understanding consequences.
affects: >=0.1.1
gotchaESLint peer dependency must be ^7.31.0 or later; older versions may cause unexpected behavior.
fix
Upgrade ESLint to >=7.31.0 (as per peerDependencies).
affects: >=0.1.0
gotchaPlugins array may be omitted if only using recommended config, but then custom rules won't work without it.
fix
If you need to override any rule, include "plugins": ["grommet"] in .eslintrc.
affects: >=0.1.0
Errors
Common errors & fixes
ESLint couldn't find the plugin "eslint-plugin-grommet".
Package not installed or symlinked incorrectly.
fix
Run npm install --save-dev eslint-plugin-grommet
Configuration for rule "grommet/anchor-label" is invalid: Severity should be one of: 0, 1, 2 (off, warn, error).
Using a string like 'error' instead of numeric severity in some old config format.
fix
Use 2 for error, 1 for warn, or 0 for off, or ensure your config format allows severity strings (ESLint supports strings).
Rule 'grommet/formfield-htmlfor-id' is not defined in the config.
Plugin not loaded or rule not available in the version.
fix
Ensure plugin is in plugins array and you're using v0.2.0 or later.
Upgrade
Version history
0.2.0latest on npm
Audit
Dependencies
eslintrequiredpeer dependency required to run the plugin
Agent activity
4 hits · last 30 days
node
4
Resources
githubhttps://github.com/grommet/eslint-plugin-grommet ↗
packagehttps://www.npmjs.com/package/eslint-plugin-grommet ↗
eslint-plugin-grommet — npm install eslint-plugin-grommet · libregistry