Skip to content

fix(docs): preserve semantic source bytes in anchor hashes - #430

Open
DivyamTalwar wants to merge 1 commit into
activeloopai:mainfrom
DivyamTalwar:fix/docs-preserve-literal-anchor-hashes
Open

DivyamTalwar wants to merge 1 commit into
activeloopai:mainfrom
DivyamTalwar:fix/docs-preserve-literal-anchor-hashes

Conversation

@DivyamTalwar

Copy link
Copy Markdown

Summary

Fixes #429.

The source-hash normalizer strips comment-looking byte sequences even inside string literals and removes whitespace that can be semantic in multiline strings. Distinct source bodies can therefore produce the same anchor hash and leave documentation falsely fresh.

Normalize CRLF to LF only, preserving all remaining source bytes before hashing. This avoids pretending a language-agnostic regular expression can safely remove comments or distinguish semantic whitespace.

Version Bump

No release requested. Package versions, dependencies, lockfiles and release workflows are unchanged.

Test plan

  • Repository-native regression tests on unchanged production source: 8 failed, 40 controls passed, zero skipped.
  • Corrected focused suites: 48 passed, zero failed or skipped, with local typechecking passing.
  • Exact submitted commit 8ea8fe40d6a8a2ee1b347e80b44f79174e4451cb: independent Node 22/Linux full suite with coverage, 5,856 passed, zero failed, zero skipped. Typecheck, build, duplication guard, critical-only bundle audit and diff checks pass in the same isolated job.

Exact checkout, commands and validation logs. Results are for this branch alone, not borrowed from a combined patch branch. Tests use synthetic source/transcripts and temporary files, not customer data, real credentials or live model/backend calls.

Compatibility and limits

This deliberately trades extra refreshes for detecting real edits: comment, whitespace and formatting edits can now change hashes. Previously stored anchors may need a one-time refresh. The language argument remains accepted for API compatibility. No language lexer or refresh-cost benchmark is claimed.

Current open-PR file inventories and issue titles were checked before submission. A clean full macOS suite and native Windows execution are not claimed. Upstream CI and maintainer acceptance remain separate from the independent validation.

@coderabbitai

coderabbitai Bot commented Sep 23, 2026

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 30 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used all 4 included reviews currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Repository: activeloopai/hivemind/.coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: fce05a44-cbf8-4e25-bd5c-ba04ff0a3382

📥 Commits

Reviewing files that changed from the base of the PR and between ce30de7 and 8ea8fe4.

📒 Files selected for processing (3)
  • src/docs/anchors.ts
  • tests/shared/docs-generate.test.ts
  • tests/shared/docs-impact.test.ts

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

Comment @coderabbitai help to get the list of available commands.

This branch has not been deployed

No deployments
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.

Regex normalization of document anchors can hide semantic source edits

1 participant