Skip to content

README.md

Latest commit

 

History

History
317 lines (216 loc) · 9.94 KB

README.md

File metadata and controls

317 lines (216 loc) · 9.94 KB

Markdown Lint Skill for Hermes

Version License: MIT Hermes Skill

A self-contained Hermes Agent skill that automatically lints and fixes Markdown files to enforce GitHub Flavored Markdown (GFM) rules.

Powered by pure Node.js scripts — format-tables.js for single-pass table formatting and markdownlint-cli2 via npx for GFM rule enforcement. No committed node_modules, package install step, or bash runtime required.

Agent Behavioral Standards

This repository follows autonomous agent governance standards — explicit behavioral contracts for LLM agents.

What This Means

  • AGENTS.md defines a formal contract for any Markdown file creation or edit
  • Severity levels (BLOCKING/WARNING/INFO) make validation failures actionable
  • Imperative section headers (Validate Changes, Resolve Failures) for machine readability
  • Safe automation boundaries prevent destructive "helpful AI" behavior
  • Consistency checks prevent drift between config, documentation, and formatter behavior

Why It Matters

As LLM agents increasingly work autonomously in repositories, explicit governance becomes critical:

  • Deterministic validation prevents silent regressions
  • Severity levels enable safe autonomous PRs
  • Behavioral contracts create reproducible contributor expectations
  • Machine-readable sections enable programmatic enforcement
  • CI-backed consistency checks turn governance claims into enforceable guarantees

This is part of a broader shift toward AI-native repository standards — where human and agent workflows are equally well-specified.

Learn more: See AGENTS.md for the full behavioral contract.

Design Philosophy

This skill treats Markdown linting as agent-safe repository governance:

  • Formatting must be deterministic and idempotent
  • Fenced code blocks are safety boundaries and must not be rewritten as prose
  • Table formatting preserves semantic alignment (:---, ---:, :---:)
  • lint.js is the canonical entry point for manual, CI, and agent-driven execution
  • Documentation, config, formatter behavior, and governance claims must stay synchronized

For End Users

Prerequisites

Before installing, ensure your environment meets the following requirements:

  • Hermes CLI — Required to install the skill. The post-write.js hook is an optional safety net.
  • Node.js (v18+) — The linting pipeline relies on native Node.js scripts and npx to dynamically fetch markdownlint-cli2 without requiring global installations.
  • Cross-Platform — The pipeline runs natively on Linux, macOS, and Windows. No WSL or Git Bash required!

Install the Skill

hermes skills install CodeSigils/hermes-markdown-lint-skill/markdown-lint --force

The --force flag is required because the security scanner flags post-write hooks as dangerous (expected for a linting skill).

Post-Install: Hook (Optional Safety Net)

The skill already instructs the AI agent to automatically lint every Markdown file it creates or edits. For guaranteed enforcement even if the agent skips the instruction, you can add a system-level hook:

Edit ~/.hermes/config.yaml:

hooks:
  post_tool_call:
    - matcher: "write_file"
      command: "node ~/.hermes/skills/markdown-lint/scripts/post-write.js"
hooks_auto_accept: true

Restart Hermes for the hook to activate. This is optional — the mandatory lint rule in SKILL.md handles the common case.

Quick Start

# One-liner (recommended — pure Node.js, cross-platform)
node ${HERMES_SKILL_DIR}/lint.js <path>

# Options
node ${HERMES_SKILL_DIR}/lint.js --check <path>     # Read-only check
node ${HERMES_SKILL_DIR}/lint.js --all <dir>        # Fix all .md in directory
node ${HERMES_SKILL_DIR}/lint.js --validate <path>  # Validate table column consistency
node ${HERMES_SKILL_DIR}/lint.js --fences <path>    # Check fenced code blocks

The canonical wrapper runs two stages internally:

  1. format-tables.js formats all tables in a single pass
  2. markdownlint-cli2 fixes or checks everything else through the bundled config

Agents should call lint.js; direct npx markdownlint-cli2 commands are only for debugging the skill internals.

Preventing Broken Tables

The most common table error is column count mismatch between the header, separator, and data rows. This often happens with:

  • Extra | characters in type definitions (e.g., "tab" | "space")
  • Copy-paste errors in separator rows

Validate Before You Push

# Add to CI or pre-commit to catch broken tables
node lint.js --validate .

This validates:

  • Header columns match separator columns
  • All data rows have the correct number of columns
  • Pipes inside cells are properly escaped with &#124;

How to Escape Pipes in Tables

If a table cell contains a pipe character, escape it to prevent column misparsing:

Before (broken) — the raw | breaks the column count:

| Type    | Value |
| :------ | :---- |
| Options | "tab" | "space" |

After (fixed) — escape with &#124;:

| Type    | Value                      |
| :------ | :------------------------- |
| Options | "tab" &#124; "space"       |

What It Does

The pipeline (format-tables.js → markdownlint-cli2) fixes GFM violations automatically:

Table separators — normalizes raw dashes to GFM-compliant aligned separators while preserving semantic alignment:

Before:

| Name  | Age  | Score |
| ---   | ---: | :---: |
| Alice | 25   | A     |

After:

| Name  | Age | Score |
| :---- | --: | :---: |
| Alice |  25 | A     |

Headings — adds required blank lines around headings:

Before:

Some text
## My Heading
More text

After:

Some text

## My Heading

More text

Tabs & blank lines — converts tabs to spaces and collapses multiple blank lines to one.

Configuration

The skill includes a bundled config at references/.markdownlint.json. lint.js uses it automatically — no setup required.

Key policy choices:

  • MD040 is disabled — blank fences are allowed for output examples
  • MD055 is disabled — leading/trailing table pipes are optional
  • MD060 is set to aligned — table column positions are normalized while preserving semantic alignment

Testing

Run against the test fixture:

node lint.js --check test/kitchensink.md

CI / Pre-commit

The project uses GitHub Actions to validate every push and PR. You can run the same checks locally:

# 1. Repository governance/config consistency
node scripts/check-consistency.js

# 2. Unit tests for the table formatter
node test/format-tables.test.js

# 3. Check for unclosed code fences or bad closers
node lint.js --fences .

# 4. Validate table column consistency
node lint.js --validate .

# 5. Final lint check
node lint.js --check .

Pre-commit:

# .pre-commit-config.yaml
- repo: local
  hooks:
    - id: hermes-markdown-lint
      name: Hermes Markdown lint
      entry: node lint.js --check .
      language: system
      pass_filenames: false

Official Hermes Skills Documentation

Learn more about creating and managing Hermes skills:

For Developers

Skill Structure

.
├── AGENTS.md
├── lint.js                      # Developer wrapper
├── README.md
├── scripts/
│   └── check-consistency.js     # Config/docs anti-drift checker
├── skills/
│   └── markdown-lint/           # <-- The actual skill payload
│       ├── SKILL.md
│       ├── lint.js              # Canonical entry point
│       ├── scripts/
│       │   ├── check-fences.js  # Fenced code block checker
│       │   └── post-write.js    # Auto-lint hook (optional)
│       └── references/
│           ├── format-tables.js # Single-pass table formatter
│           └── .markdownlint.json
└── test/
    └── format-tables.test.js

Changelog

v2.9.1

  • Strengthened the agent contract: lint after any Markdown file creation or edit, not only a specific write tool.
  • Added MUST-level agent requirements to the installed SKILL.md.
  • Fixed MD060 aligned table formatting for right- and center-aligned columns.
  • Restored README changelog tracking and corrected stale direct-npx guidance.
  • Strengthened check-consistency.js to compare documented rule tables against .markdownlint.json.
  • Aligned SKILL.md frontmatter with the official Hermes version and author fields.
  • Removed redundant GitHub Actions workflow; ci.yml is now the canonical validation workflow.

v2.9.0

  • Replaced shell wrappers with native Node.js entry points.
  • Merged table separator fixing and cell padding into format-tables.js.
  • Added repository consistency checks to keep config and docs synchronized.

v2.8.0

  • Added --fences mode for fenced code block validation.
  • Disabled MD055 so leading and trailing table pipes remain optional.
  • Disabled MD033 so inline HTML remains valid in Markdown.

v2.7.0

  • Added --validate mode for table column consistency checks.
  • Documented escaped pipe handling for table cells.

v2.6.0

  • Added optional post-write.js hook for automatic linting after Markdown writes.
  • Enabled stricter list and table alignment validation.

License

MIT License. See LICENSE.