Skip to content

docs(lint): a guide for running comark-lint next to ESLint or oxlint, and as part of Vite Doctor - #68

Merged
vitehub-bot[bot] merged 15 commits into
mainfrom
docs/lint-eslint-oxlint
Oct 21, 2026
Merged

vitehub-bot[bot] merged 15 commits into
mainfrom
docs/lint-eslint-oxlint

Conversation

@onmax

@onmax onmax commented Oct 21, 2026 •

Copy link
Copy Markdown
Owner

Stacked on #55. This adds lint/guides, a short page that sits between Getting started and Vite Doctor in the lint section.

  • ESLint and oxlint. Neither one reads :: blocks, so comark-lint goes into the same lint script. A code group shows the line for each linter.
  • Staged files. A lint-staged entry for *.{md,mdc}. comark-lint takes file paths as well as globs.
  • CI. One pnpm lint step covers both.
  • Vite Doctor. This is the recommendation the page ends on. One run checks the framework rules plus every comark-lint rule, with COMARK000x codes, an agent report, and SARIF output. It links to the existing Vite Doctor page for the options.

I checked the commands against a scratch project:

  • comark-lint with relative and absolute paths exits 1 on problems.
  • extends: ["auto", "comark/recommended"] loads both.
  • Vite Doctor exits 0 when it finds only comark-lint warnings. So the guide's script uses --max-warnings 0, and the page says why.
  • --format sarif writes SARIF 2.1.0.

pnpm run lint:docs reports 0 problems, and node docs/build.ts writes /lint/guides/ with the code group rendered as tabs.

This PR changes no code. If check fails here, the cause is in #55: packages/icon/test/icon.test.ts:136 has an unescaped ' inside a single-quoted string, so vp fmt --check fails on that branch too.

🤖 Generated with Claude Code

@vitehub-bot

vitehub-bot Bot commented Oct 21, 2026 •

Copy link
Copy Markdown
Contributor
Session Status Started Duration
Pending Completed Not started —
View session Waiting 2026-10-21T13:27:46.420Z 4m 49s

Latest result

Pull request merged.

Final answers

Session

Pull request merged.

Session

Updated the branch with main because main changed AGENTS.md, README.md, docs/build.ts and 15 more after its checks ran; waiting for checks on the new head.

Session

Waiting for open parent PR #55 to merge; this child has nothing left to repair.

View session

Verified the expected HEAD, guide diff, repository instructions, current checks, and review feedback. All current required checks and exact-base checks pass; Pullfrog reported no new issues and there are no actionable threads. No repair commit is needed. Local lint invocation was blocked by pnpm’s non-TTY module purge, but hosted validation is green.

Session

Waiting for feat/comark-linter to pass: its tip fails the same checks as this PR (check / check).

Session

Waiting for feat/comark-linter to pass: its tip fails the same checks as this PR (check / check).

Session

Waiting for feat/comark-linter to pass: its tip fails the same checks as this PR (check / check).

Session

Waiting for feat/comark-linter to pass: its tip fails the same checks as this PR (check / check).

Session

Waiting for feat/comark-linter to pass: its tip fails the same checks as this PR (check / check).

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Oct 21, 2026 •

Copy link
Copy Markdown

🚀 Deploying Preview to Cloudflare 🚀

Preview Deployments by commit

Status Deployment URL Commit Updated (UTC) See this deployment's details
  • Build: Success ✅

View logs ↗
No Preview URL. Enable ↗ 97b691f 2026-10-21T13:19:13.181Z Visit the dashboard ↗
  • Build: Success ✅

View logs ↗
No Preview URL. Enable ↗ b95f14a 2026-10-21T12:01:49.690Z Visit the dashboard ↗

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ No new issues found.

Reviewed changes

The guide added in docs/pages/lint/guides.md was reviewed against the current comark-linter CLI, Vite Doctor extension, and docs navigation.

  • Lint integrations — Documents valid ESLint and oxlint scripts, quoted CLI globs, lint-staged file paths, and CI usage.
  • Vite Doctor integration — Uses the published comark-linter/doctor entry point, supported include option, recommended preset, and the necessary --max-warnings 0 behavior.
  • Docs integration — The new guides page is picked up by the existing lint section ordering and links to the existing Vite Doctor documentation.

Pullfrog  | View workflow run | Using gpt-5.6-sol | 𝕏

@pkg-pr-new

pkg-pr-new Bot commented Oct 21, 2026 •

Copy link
Copy Markdown

Open in StackBlitz

comark-annotate

pnpm add https://pkg.pr.new/comark-annotate@68

comark-carousel

pnpm add https://pkg.pr.new/comark-carousel@68

comark-charts

pnpm add https://pkg.pr.new/comark-charts@68

comark-code

pnpm add https://pkg.pr.new/comark-code@68

comark-embed

pnpm add https://pkg.pr.new/comark-embed@68

comark-github-callouts

pnpm add https://pkg.pr.new/comark-github-callouts@68

comark-icon

pnpm add https://pkg.pr.new/comark-icon@68

comark-include

pnpm add https://pkg.pr.new/comark-include@68

comark-linter

pnpm add https://pkg.pr.new/comark-linter@68

comark-tabs

pnpm add https://pkg.pr.new/comark-tabs@68

comark-zoom

pnpm add https://pkg.pr.new/comark-zoom@68

commit: 727ff8b

@vitehub-bot
vitehub-bot Bot changed the base branch from feat/comark-linter to main October 21, 2026 13:40

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ No new issues found.

Reviewed changes

The post-review synchronization merge was checked against the prior Pullfrog review; it introduces no net changes to the guide or new behavioral surface.

  • Synchronized the branch — Merged the current main history into the PR branch without changing docs/pages/lint/guides.md relative to the previously reviewed commit.

Pullfrog  | View workflow run | Using gpt-5.6-sol | 𝕏

@vitehub-bot
vitehub-bot Bot merged commit 7f3fcf9 into main Oct 21, 2026
8 checks passed
This was referenced Oct 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant