--- url: https://lit-ui-router.dev/packages/eslint-plugin-lit-ui-router.md description: >- Directive-aware linting with eslint-plugin-lit-ui-router — rules covering hrefless anchors, inert hrefs, aria-current conflicts and misplaced directives --- # eslint-plugin-lit-ui-router [`eslint-plugin-lit-ui-router`](https://npmx.dev/package/eslint-plugin-lit-ui-router) is a small set of ESLint rules that understand lit-ui-router's directives. A lit-ui-router anchor carries no static `href` — the [`uiSref`](/reference/lit-ui-router/directives/uiSref) element part assigns one at runtime — so stock accessibility rules report every correct call site. The usual escape is to disable the rule, which costs its real coverage. This plugin instead ships its own copy of the base rule, taught that the directive counts as the `href` it assigns, and reports everything the base rule would otherwise still catch. That vendored rule is the origin story rather than the whole package. The others cover the mistakes the directives make *possible*, rather than the ones they mask: an `href` written to an element that has none, an `aria-current` the directive silently takes over, an `aria-current` nothing writes at all, and a directive used outside the part type it accepts. ## Installation ```bash npm install --save-dev eslint-plugin-lit-ui-router ``` `eslint` (`^9.0.0 || ^10.0.0`) is the only **peer** dependency. `anchor-is-valid` is vendored from [`eslint-plugin-lit-a11y`](https://www.npmjs.com/package/eslint-plugin-lit-a11y) rather than wrapped around it, so lit-a11y is an **optional sibling** you may also run for the rest of its rules, never a requirement. The package is published as ESM only. Flat config loads ESM natively; a CommonJS config can `require()` it on Node `^20.19.0` or `>=22.12.0`; the call returns the module namespace, so read the plugin from its `.default`. ## Usage Flat config (`eslint.config.js`), with lit-a11y alongside: ```js import litA11y from 'eslint-plugin-lit-a11y'; import litUiRouter from 'eslint-plugin-lit-ui-router'; export default [ litA11y.configs.recommended, ...litUiRouter.configs.recommended, ]; ``` Order matters: `configs.recommended` must come **after** lit-a11y's own config, because it turns `lit-a11y/anchor-is-valid` off in favor of ours. It deliberately does not register the `lit-a11y` plugin key itself — the host's instance owns it. Without lit-a11y installed that `off` line is simply inert, so the ordering rule costs nothing either way. ## The rules | Rule | What it catches | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [`anchor-is-valid`](https://github.com/simshanith/lit-ui-router/blob/main/packages/eslint-plugin-lit-ui-router/docs/rules/anchor-is-valid.md) | an anchor with no `href` — where a `uiSref` element part counts as one | | [`sref-assign-href`](https://github.com/simshanith/lit-ui-router/blob/main/packages/eslint-plugin-lit-ui-router/docs/rules/sref-assign-href.md) | an inert `href` written to a `