Repository navigation
fix(utils): preserve trailing hash in markdown titles - #12782
Aditya-713 wants to merge 1 commit into
Conversation
|
Hi @Aditya-713! Thank you for your pull request and welcome to our community. Action RequiredIn order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you. ProcessIn order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA. Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks! |
|
No actionable comments were generated in the recent review.
 |
| Layer / File(s) | Summary |
|---|---|
Title cleanup and regression coverage packages/docusaurus-utils/src/markdownUtils.ts, packages/docusaurus-utils/src/__tests__/markdownUtils.test.ts |
Title cleanup removes a custom heading ID before removing trailing ATX closing hashes. Tests verify that Learn C# remains the parsed title in three heading forms. |
Priority:
Estimated code review effort: 2 (Simple) | ~8 minutes
Change: Bug fix · Severity of issue fixed: Low
Merge Risk: 
ba500
-
The change is narrowly scoped and mergeable based on the supplied evidence.
Architecture risk: 
ba500
-
The change affects 1 system.
Changed systems:
packages/docusaurus-utilsArchitecture concerns
No architecture-level concerns identified.Review details
-
Systems and components
- observed — packages/docusaurus-utils (library) was modified; 2 changed files map to changed impact.
Before / after behavior
- observed — Modified behavior in packages/docusaurus-utils/src/tests/markdownUtils.test.ts: Adds a test expecting
Learn C#to be parsed as the H1 title without changing the Markdown content. - observed — Modified behavior in packages/docusaurus-utils/src/tests/markdownUtils.test.ts: Adds a test expecting
Learn C#to remain the parsed title when the heading also has a custom ID. - observed — Modified behavior in packages/docusaurus-utils/src/tests/markdownUtils.test.ts: Adds a test expecting
Learn C#to remain the parsed title when the heading ends with a closing#. - observed — Modified behavior in packages/docusaurus-utils/src/markdownUtils.ts: Title cleanup now removes a trailing custom heading ID, then removes trailing ATX closing hashes; previously, one alternative matched, so a heading containing both could retain the closing hashes.
-
Pre-merge checks: 
-
Check name Status Explanation Description Check Check skipped - CodeRabbit’s high-level summary is enabled. Title check The title clearly and concisely describes the main change: preserving trailing hash characters in Markdown titles. Linked Issues check Issue #12644requires a heading such as# Learn C#to produceLearn C#, and it requires closing ATX hashes to count only after a space or tab.parseMarkdownContentTitlenow removes custom IDs se…Out of Scope Changes check The changes are limited to the title-cleanup logic in markdownUtils.tsand regression tests inmarkdownUtils.test.ts. Both changes directly support issue#12644. No unrelated implementation or tes…Docstring Coverage Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 2 files. Full details: Linked Issues check
-
Explanation
Issue
#12644requires a heading such as# Learn C#to produceLearn C#, and it requires closing ATX hashes to count only after a space or tab.parseMarkdownContentTitlenow removes custom IDs separately and removes closing hashes with[ \t]+#+$. The added tests cover# Learn C#, a custom ID, and a closing hash.
Full details: Out of Scope Changes check
-
Explanation
The changes are limited to the title-cleanup logic in
markdownUtils.tsand regression tests inmarkdownUtils.test.ts. Both changes directly support issue#12644. No unrelated implementation or test changes are shown.
-
Finishing Touches
-
🧪 Generate unit tests (beta)
-
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Comment @coderabbitai help to get the list of available commands.
✅ [V2]Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks! |
Motivation
Fixes #12644.
Markdown headings such as
# Learn C#were incorrectly parsed asLearn Cbecause the title-cleanup regex removed trailing#characters even when they were part of the heading text.Changes
#removal.#characters when they are preceded by whitespace.C#andF#.# Learn C## Learn C# {#learn-csharp}# Learn C# #Validation
markdownUtils.test.ts: 95/95 tests passed@docusaurus/utilsTypeScript build passedgit diff --checkpassedlint:jsstill reports 2 unrelated existing errors involvinguseHistoryandRedirectfromreact-router-dom; no lint errors were reported for the changed implementation.Summary by CodeRabbit
C#retain their trailing#, including when a custom ID or closing hashes are present.