markuplint-setup

Installs and configures Markuplint with framework detection, presets, and rule adoption.

611|63|Updated Sep 26, 2017
One-click install
npx skills add https://github.com/markuplint/markuplint --skill markuplint-setup
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: markuplint-setup
Source: https://github.com/markuplint/markuplint/tree/main/skills/markuplint-setup
Command: npx skills add https://github.com/markuplint/markuplint --skill markuplint-setup

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Setting up an HTML linter from scratch involves detecting the project's framework, choosing the right parser and spec packages, writing a config file, and deciding what to do with hundreds of existing violations. This Skill automates that entire onboarding workflow for Markuplint.

Core Features & Use Cases

  • Framework Detection: Scans package.json, lockfiles, and file extensions to identify React, Vue, Svelte, Astro, and other frameworks, then selects the correct parser and spec packages.
  • Guided Rule Adoption: Runs an initial lint, summarizes violations by rule, and walks through each rule with options to keep, downgrade, bulk suppress, or disable it.
  • Bulk Suppressions Support: Records existing legacy violations in markuplint-suppressions.json so rules only enforce on new code.
  • Use Case: You inherit a legacy React codebase with no HTML linting. The Skill detects JSX, installs @markuplint/jsx-parser and @markuplint/react-spec, creates .markuplintrc, runs the first lint, and helps you suppress 300 legacy violations while enforcing rules on new code.

Quick Start

Set up Markuplint in this project and lint all files under src.

Frequently Asked Questions about markuplint-setup

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I set up Markuplint in an existing project?

Install markuplint plus the parser and spec packages matching your framework, then create a .markuplintrc file extending a recommended preset. Run npx markuplint with a target glob to see initial violations before deciding which rules to enforce.

How to configure Markuplint for React JSX files?

Install @markuplint/jsx-parser and @markuplint/react-spec, then map .jsx and .tsx file patterns to them in the parser and specs fields of .markuplintrc. Extend the markuplint:recommended-react preset for React-specific rules.

Does Markuplint support Vue, Svelte, and Astro templates?

Yes, Markuplint supports frameworks beyond plain HTML through dedicated parser and spec packages for Vue, Svelte, Astro, Pug, and PHP. The exact package names and file patterns are documented at markuplint.dev/docs/guides/beyond-html.

What are Markuplint bulk suppressions and when should I use them?

Bulk suppressions record current violations in markuplint-suppressions.json so rules only fail on new code. Use them when legacy code has many violations you will not fix soon but the rule remains valuable going forward.

Should I use JSON or JavaScript config for Markuplint?

Use .markuplintrc JSON for simple setups with a single preset. Use markuplint.config.ts or .js when composing multiple shared configs, since spread syntax gives full control over merge order unlike JSON extends.