Skip to content

build(website): bump Biome to 2.6.4 and markdownlint-cli2 to 0.24 - #112

Merged
KARTIKrocks merged 1 commit into
mainfrom
chore/bump-biome-markdownlint
Nov 4, 2026
Merged

KARTIKrocks merged 1 commit into
mainfrom
chore/bump-biome-markdownlint

Conversation

@KARTIKrocks

@KARTIKrocks KARTIKrocks commented Nov 4, 2026 •

Copy link
Copy Markdown
Owner

User description

Biome 2.6 formats Markdown by default, so turn on its frontmatter parser and format the docs. The parser is off by default, which makes Biome read frontmatter as Markdown: it rewrites a one-key block to a heading, which breaks the docs build, and adds a blank line inside the rest.

Biome handles layout and markdownlint-cli2 handles structure. Biome reports none of the skipped headings, bare URLs or missing alt text markdownlint does.

Summary

What does this PR change, and why?

Closes #

Type of change

  • Bug fix
  • New detection rule
  • New integration / parser
  • Feature / enhancement
  • Docs only
  • Refactor / chore

Checklist

  • make ci passes (fmt-check, vet, lint, vuln, test-race, lint-docs) across all modules
  • Added/updated tests (and, where practical, a failure-mode check)
  • Updated docs under website/docs/ with a version marker for anything new (_0.3+_, _Added in 0.3._, // 0.3+) — never website/versioned_docs/
  • Updated AGENTS.md / .sqlguard.example.yml if a convention or config key changed
  • Added an entry under ## [Unreleased] in CHANGELOG.md
  • No new third-party deps in analyzer / middleware / reporter
  • Findings stay redaction-safe (no raw literals leak into a Result)

Notes for reviewers

Anything reviewers should focus on — tricky areas, trade-offs, follow-ups.


CodeAnt-AI Description

Keep website docs buildable with updated Markdown formatting tools

What Changed

  • Markdown formatting now preserves page frontmatter instead of changing it into page content, preventing documentation build failures.
  • Website documentation tables and examples are reformatted for the updated tools.
  • Biome and markdownlint are updated.

Impact

✅ Frontmatter survives Markdown formatting
✅ Website documentation builds after formatting
✅ Markdown checks still flag bare URLs and missing image alt text

💡 Usage Guide

Checking Your Pull Request

Every time you make a pull request, our system automatically looks through it. We check for security issues, mistakes in how you're setting up your infrastructure, and common code problems. We do this to make sure your changes are solid and won't cause any trouble later.

Talking to CodeAnt AI

Got a question or need a hand with something in your pull request? You can easily get in touch with CodeAnt AI right here. Just type the following in a comment on your pull request, and replace "Your question here" with whatever you want to ask:

@codeant-ai ask: Your question here

This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code.

Example

@codeant-ai ask: Can you suggest a safer alternative to storing this secret?

Preserve Org Learnings with CodeAnt

You can record team preferences so CodeAnt AI applies them in future reviews. Reply directly to the specific CodeAnt AI suggestion (in the same thread) and replace "Your feedback here" with your input:

@codeant-ai: Your feedback here

This helps CodeAnt AI learn and adapt to your team's coding style and standards.

Example

@codeant-ai: Do not flag unused imports.

Retrigger review

Ask CodeAnt AI to review the PR again, by typing:

@codeant-ai: review

Check Your Repository Health

To analyze the health of your code repository, visit our dashboard at https://app.codeant.ai. This tool helps you identify potential issues and areas for improvement in your codebase, ensuring your repository maintains high standards of code health.

Biome 2.6 formats Markdown by default, so turn on its frontmatter parser and
format the docs. The parser is off by default, which makes Biome read
frontmatter as Markdown: it rewrites a one-key block to a heading, which
breaks the docs build, and adds a blank line inside the rest.

Biome handles layout and markdownlint-cli2 handles structure. Biome reports
none of the skipped headings, bare URLs or missing alt text markdownlint does.
@codeant-ai

codeant-ai Bot commented Nov 4, 2026 •

Copy link
Copy Markdown

CodeAnt  CodeAnt Review Status

✅  Review completed

Status Commit Started (UTC) Finished (UTC)
✅  #45640 Reviewed your PR 5290ccd Nov 04, 2026 · 11:09 11:13

@codeant-ai

codeant-ai Bot commented Nov 4, 2026

Copy link
Copy Markdown

Thanks for using CodeAnt! 🎉

We're free for open-source projects. if you're enjoying it, help us grow by sharing.

Share on X ·
Reddit ·
LinkedIn

@coderabbitai

coderabbitai Bot commented Nov 4, 2026

Copy link
Copy Markdown
Contributor

Important

  • Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

Run configuration
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

@codeant-ai

codeant-ai Bot commented Nov 4, 2026

Copy link
Copy Markdown

View results CodeAnt  CodeAnt Quality Gate Results

Commit 5290ccd5 · Scanned Nov 04, 2026 at 11:09 UTC

✅  Overall Status: PASSED

Quality Gate Status Details
New code coverage ⚪  Not applicable Not applicable — no applicable code changes
Secrets ✅  Passed 0 secrets found
SAST ✅  Passed No security issues
SCA (Dependencies) ✅  Passed Rating S · No vulnerabilities

@codeant-ai

codeant-ai Bot commented Nov 4, 2026

Copy link
Copy Markdown

View results CodeAnt  CodeAnt Coverage Report

Commit 5290ccd5 · Scanned Nov 04, 2026 at 11:09 UTC

⚪  Overall Status: Not applicable

Coverage Status Details
New Code Coverage ⚪  Not applicable Not applicable — no applicable code changes

New-code coverage threshold not configured; coverage is reported but not enforced.

@codeant-ai codeant-ai Bot added the size:L This PR changes 100-499 lines, ignoring generated files label Nov 4, 2026
@codeant-ai

codeant-ai Bot commented Nov 4, 2026 •

Copy link
Copy Markdown

CodeAnt  CodeAnt Nitpicks

3 code suggestions

1. The new command entry says Biome checks formatting, but the paragraph below still claims Biome has no Markdown support, misrepresenting what npm run lint processes.

Docstring mismatch · website/README.md:31


2. BeginTx is optional and is not part of dialect.Driver; this wording misstates the interface and may lead users to rely on an unsupported method.

Api mismatch · website/docs/ent.md:44


3. ResetN1 clears the shared tracker, not just this request; concurrent requests lose their counts when any one reaches this boundary, causing missed N+1 findings.

Comment mismatch · website/docs/middleware.md:160


18 custom suggestions

1. Append the version marker for the release that introduced this API to an API table cell.

Custom_rule · website/docs/bun.md:39


2. Append the version marker for the release that introduced this API to an API table cell.

Custom_rule · website/docs/bun.md:40


3. Append the version marker for the release that introduced these hook methods to an API table cell.

Custom_rule · website/docs/bun.md:41


4. Add the appropriate introduction-version marker to each listed function’s API-table cell.

Custom_rule · website/docs/configuration.md:140-142


5. Add the appropriate introduction-version marker to each listed method’s API-table cell.

Custom_rule · website/docs/configuration.md:148-153


6. Add the appropriate release marker (for example, X.Y+) to this API table cell.

Custom_rule · website/docs/ent.md:43


7. Add the API’s introduction version, _0.3+_, to this table cell.

Custom_rule · website/docs/gorm.md:41


8. Add the API’s introduction version, _0.3+_, to this table cell.

Custom_rule · website/docs/gorm.md:42


9. Add the API’s introduction version, _0.3+_, to this table cell.

Custom_rule · website/docs/gorm.md:43


10. Add the API’s introduction version, _0.3+_, to this table cell.

Custom_rule · website/docs/gorm.md:44


11. Mark the configuration option’s introduction version using an allowed version-marker form.

Custom_rule · website/docs/n-plus-one.md:39


12. Append the appropriate _X.Y+_ version marker to this API table cell.

Custom_rule · website/docs/pgx.md:49


13. Append the appropriate _X.Y+_ version marker to this API table cell.

Custom_rule · website/docs/pgx.md:50


14. Append the appropriate _X.Y+_ version marker to this API table cell.

Custom_rule · website/docs/pgx.md:51


15. Append the appropriate _X.Y+_ version marker to this API table cell.

Custom_rule · website/docs/pgx.md:52


16. Append the release marker 0.5+ to each API table entry so readers can identify when these documented APIs became available.

Custom_rule · website/docs/sqlx.md:54-60


17. Append the appropriate _X.Y+_ release marker to this API table cell.

Custom_rule · website/docs/xorm.md:36


18. Append the appropriate _X.Y+_ release marker to this API table cell.

Custom_rule · website/docs/xorm.md:37

@KARTIKrocks
KARTIKrocks merged commit bbedb02 into main Nov 4, 2026
34 checks passed
@KARTIKrocks
KARTIKrocks deleted the chore/bump-biome-markdownlint branch November 4, 2026 11:12
Comment thread website/package.json
"@types/react": "^19.3.0",
"cross-env": "^10.1.0",
"markdownlint-cli2": "^0.23.2",
"markdownlint-cli2": "^0.24.0",

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Suggestion: This adds a Node 22-only CLI while the website still declares Node 20 support, so Node 20 users cannot run make lint-docs reliably.

Assessment: 🟠 Major · 🔁 Occurrence: Sometimes · 🏷️ Api mismatch

Use CodeAnt Skill Fix in Cursor Fix in VSCode Claude

Prompt for AI Agent 🤖
This is a comment left during a code review.

**Path:** website/package.json
**Line:** 40:40
**Comment:**
	*Api Mismatch: This adds a Node 22-only CLI while the website still declares Node 20 support, so Node 20 users cannot run `make lint-docs` reliably.

Validate the correctness of the flagged issue. If correct, How can I resolve this? If you propose a fix, implement it and please make it concise.
Once fix is implemented, also check other comments on the same PR, and ask user if the user wants to fix the rest of the comments as well. if said yes, then fetch all the comments validate the correctness and implement a minimal fix
👍 | 👎

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:L This PR changes 100-499 lines, ignoring generated files

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant