fix: [BUG] Blog Table of contents links not working #3540 #3543
Conversation
rohitdhakane6
requested review from
derberg,
akshatnema,
magicmatatjahu,
anshgoyalevil,
Mayaleeeee and
asyncapi-bot-eve
as code owners
WalkthroughThe changes in Changes
Assessment against linked issues
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.
✅ Deploy Preview for asyncapi-website ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-3543--asyncapi-website.netlify.app/ |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
scripts/build-post-list.js (2)
175-177: Minor grammar and formatting fix.The comment says "Matches heading IDs in one formats" which is grammatically incorrect. Also, the ESLint error suggests adjusting the regex formatting.
You might want to fix it like so:
-// Matches heading IDs in one formats: +// Matches heading IDs in one format: -const anchorTagRegex =/<a\s+name="([a-zA-Z0-9\-_]+)"/ +const anchorTagRegex = /<a\s+name="([a-zA-Z0-9\-_]+)"/;🧰 Tools
🪛 eslint
[error] 177-177: Replace
/<a\s+name="([a-zA-Z0-9\-_]+)"/with·/<a\s+name="([a-zA-Z0-9\-_]+)"/;(prettier/prettier)
196-196: Remove unnecessary escape character in the regex.ESLint indicates "
Unnecessary escape character: \-." You can simplify[^\w\-]+to[^\w-]+.- .replace(/[^\w\-]+/g, ''); + .replace(/[^\w-]+/g, '');🧰 Tools
🪛 eslint
[error] 196-196: Unnecessary escape character: -.
(no-useless-escape)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
scripts/build-post-list.js(1 hunks)
🧰 Additional context used
🪛 eslint
scripts/build-post-list.js
[error] 177-177: Replace /<a\s+name="([a-zA-Z0-9\-_]+)"/ with ·/<a\s+name="([a-zA-Z0-9\-_]+)"/;
(prettier/prettier)
[error] 188-188: Assignment to function parameter 'str'.
(no-param-reassign)
[error] 193-193: Delete ·
(prettier/prettier)
[error] 194-194: Delete ·
(prettier/prettier)
[error] 196-196: Unnecessary escape character: -.
(no-useless-escape)
🪛 GitHub Actions: PR testing - if Node project
scripts/build-post-list.js
[error] 185-185: TypeError: Cannot read properties of null (reading 'match') in slugifyToC function
| const match = str.match(anchorTagRegex); | ||
| if (match) { | ||
| // Extract text after the closing anchor tag | ||
| str = str.split('</a>')[1]?.trim() || ''; |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Avoid reassigning function parameter.
ESLint flags this as a "no-param-reassign" issue, which can lead to unexpected side effects. Instead of mutating the incoming parameter str, create a new variable for clarity and maintainability.
- str = str.split('</a>')[1]?.trim() || '';
+ let headingContent = str.split('</a>')[1]?.trim() || '';📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| str = str.split('</a>')[1]?.trim() || ''; | |
| let headingContent = str.split('</a>')[1]?.trim() || ''; |
🧰 Tools
🪛 eslint
[error] 188-188: Assignment to function parameter 'str'.
(no-param-reassign)
|
|
||
| /** | ||
| * Extracts heading IDs from markdown headings | ||
| * @param {string} str - The heading text containing potential ID | ||
| * @returns {string} The extracted ID or empty string if no valid ID found | ||
| */ | ||
| function slugifyToC(str) { | ||
| const match = str.match(anchorTagRegex); |
There was a problem hiding this comment.
Check for null or undefined before calling match().
The pipeline failure indicates that str can be null or undefined. Add a null check to avoid a possible TypeError when str.match(...) is invoked.
+ if (!str) return '';
const match = str.match(anchorTagRegex);
if (match) {
// ...Committable suggestion skipped: line range outside the PR's diff.
🧰 Tools
🪛 GitHub Actions: PR testing - if Node project
[error] 185-185: TypeError: Cannot read properties of null (reading 'match') in slugifyToC function
|
please read CONTRIBUTING before raising any PR... the issue was awaiting triage and is already being worked on |
|
@rohitdhakane6 Kindly read the contributing guidelines. Formally, a PR should be created after the linked issue is validated by a triager or maintainer. I will leave this PR open in case the issue author doesn't create the PR within the specified timeframe as per guidelines. |
Description
Clicking on a link in the Table of Contents it smoothly scroll the page to the corresponding section with the relevant heading.
Screencast from 2025-01-04 14-49-29.webm
Related issue(s)
Fixes #3540Screencast from 2025-01-04 14-49-29.webm
Summary by CodeRabbit
Improvements
Bug Fixes