polymer-linter

library3.0.1jsnpmunverified

Polymer Linter (v3.0.1) is a library for finding suspicious patterns and errors in web projects using Polymer custom elements. It is built on the Polymer Analyzer and provides AST-based linting with high-level feature queries. The linter is typically run via Polymer CLI or integrated into editors like VS Code. It offers rule collections (e.g., polymer-2-hybrid) and individual rules. Release cadence is low, as the project is in maintenance mode. Key differentiators: Polymer-specific linting rules (e.g., attribute checks, behaviors spelling) and tight integration with Polymer toolchain.

testing web-framework

npm install polymer-linter

github ↗package ↗

INSTALL

IMPORT

SIG · POLYMER-LINTER

polymer-linter

testingjavascriptv3.0.1

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.

Linter

✓ import { Linter } from 'polymer-linter'

✗ const Linter = require('polymer-linter').Linter

ESM only; named export.

Warning

✓ import { Warning } from 'polymer-linter'

✗ const Warning = require('polymer-linter').Warning

Named export for warning types.

registry

✓ import { registry } from 'polymer-linter'

✗ import registry from 'polymer-linter'

Named export for rule registry.

Shows how to programmatically use Polymer Linter: create an Analyzer, instantiate Linter, and lint a document with a rule collection.

import { Linter } from 'polymer-linter'; import { Analyzer } from 'polymer-analyzer'; const analyzer = new Analyzer({ urlLoader: { canLoad: () => false, load: () => '', request: () => '' } }); const linter = new Linter(analyzer); // See available rules console.log(linter.registry.rules); // Create a lint result const doc = await analyzer.analyze('file.html'); const warnings = await linter.lint(doc, { rules: ['polymer-2-hybrid'] }); for (const warning of warnings) { console.log(warning.message); }

polymer-lint --version

Debug

Known issues

deprecatedPolymer Linter is deprecated and no longer maintained. Polymer 3+ does not use this linter.

fix

Migrate to lit-analyzer or eslint-plugin-lit for Polymer 3 and LitElement projects.

affects: >=3.0.0

breakingThe API changed significantly from v2 to v3. Linter constructor now requires an Analyzer instance.

fix

Instantiate polymer-analyzer and pass it to Linter.

affects: >=3.0.0

breakingRule collections are now specified as strings in an array (e.g., ['polymer-2-hybrid']), not as separate arguments.

fix

Pass rules as array in options object.

affects: >=3.0.0

gotchaThe linter depends on polymer-analyzer which loads files via URL loader. No built-in file system loader.

fix

Provide a custom urlLoader or use polymer-cli to run it.

affects: >=3.0.0

Errors

Common errors & fixes

Error: Cannot find module 'polymer-analyzer'

Missing dependency polymer-analyzer when using polymer-linter programmatically.

fix

npm install polymer-analyzer

TypeError: linter.lint is not a function

Using old v2 API where lint was called differently; v3 lint method expects (document, options).

fix

Update code to: linter.lint(document, { rules: ['polymer-2-hybrid'] })

Warning: No rules matched; nothing to lint.

Specified rule collection name is misspelled or not registered.

fix

Check rule names in registry; use correct string like 'polymer-2-hybrid'.

Upgrade

Version history

3.0.1latest on npm

Audit

Dependencies

polymer-analyzerrequiredProvides Document and AST for lint rules

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/Polymer/tools ↗

packagehttps://www.npmjs.com/package/polymer-linter ↗