feat: add development setup related files #4049
Conversation
akshatnema
requested review from
quetzalliwrites,
TRohit20,
asyncapi-bot-eve,
derberg,
anshgoyalevil,
sambhavgupta0705 and
Mayaleeeee
as code owners
|
Warning Rate limit exceeded@akshatnema has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 27 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (2)
WalkthroughThis pull request introduces several documentation files detailing the setup, workflow, and usage of various development scripts, including those for building documentation, meetings, newsroom videos, pages, RSS feeds, and tools. It adds a sample Visual Studio Code launch configuration file ( Changes
Sequence Diagram(s)sequenceDiagram
participant Developer
participant VSCode
participant Script
participant Documentation
Developer->>VSCode: Open project and select launch config
VSCode->>Script: Run/debug selected script with env vars
Script->>Documentation: Refer to setup and usage instructions
Script->>Script: Execute build/data-fetching logic
Script->>Developer: Output results/logs
Assessment against linked issues
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
✨ Finishing Touches
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. 🪧 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
|
|
Hello, @coderabbitai[bot]! 👋🏼 |
✅ Deploy Preview for asyncapi-website ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Tip For best results, initiate chat on the files or code changes. @asyncapi-bot Thank you for sharing these helpful PR commands! I appreciate the information about the available commands like 🧠 Learnings used |
|
@derberg @quetzalliwrites @sambhavgupta0705 @anshgoyalevil @Mayaleeeee @TRohit20 Please take a look at this PR. Thanks! 👋 |
✅ Deploy Preview for asyncapi-website ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (11)
development/scripts/build-docs.md (4)
21-21: Add missing article "a" for grammatical consistency.Line 21 reads:
1. Build hierarchical navigation tree from flat items using `buildNavTree()`For clarity and grammatical correctness, consider:
-1. Build hierarchical navigation tree from flat items using `buildNavTree()` +1. Build a hierarchical navigation tree from flat items using `buildNavTree()`🧰 Tools
🪛 LanguageTool
[uncategorized] ~21-~21: You might be missing the article “a” here.
Context: ...gation sequence. ## Workflow 1. Build hierarchical navigation tree from flat items using `...(AI_EN_LECTOR_MISSING_DETERMINER_A)
89-90: Fix article usage in the usage context list.The list item reads:
2. Create a organized navigation structureSince "organized" begins with a vowel sound, update to:
-2. Create a organized navigation structure +2. Create an organized navigation structure🧰 Tools
🪛 LanguageTool
[misspelling] ~90-~90: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...Parse raw documentation items 2. Create a organized navigation structure 3. Add u...(EN_A_VS_AN)
92-92: Remove or complete the empty list item.The fifth bullet (
5.) is empty in the Usage Context section. Either remove this placeholder or provide the intended description to avoid confusion:- 5. [Description of the fifth point]
74-76: Add a Prerequisites section for clarity.The Command section shows how to run the script but doesn’t list required dependencies. Consider adding a Prerequisites section:
### Prerequisites - Node.js v14 or higher - Install `tsx` globally or as a dev dependency: `npm install --save-dev tsx`development/scripts/build-rss.md (1)
1-115: Documentation for build-rss script is comprehensive
The overview, prerequisites, usage examples, and output format are clearly described. Consider parameterizing the hardcoded base URL (https://www.asyncapi.com)—for example via an environment variable or config file—and documenting how to override it to support deployments on custom domains.development/scripts/build-newsroom-videos.md (1)
82-82: Add missing subject for clarity
The bullet "- Can be imported and used as a module..." is missing a subject; consider rephrasing to "It can be imported and used as a module..." for better readability.🧰 Tools
🪛 LanguageTool
[style] ~82-~82: To form a complete sentence, be sure to include a subject.
Context: ...o../config/newsroom_videos.json. - Can be imported and used as a module with a...(MISSING_IT_THERE)
development/scripts/build-pages.md (1)
52-54: Refine function description for consistency
Consider rephrasing "Used to ensure the target directory exists before processing" to "Ensures that the target directory exists before processing" to maintain present-tense consistency and parallel structure.🧰 Tools
🪛 LanguageTool
[uncategorized] ~54-~54: Did you mean “use”?
Context: ...y exists and creates it if it doesn't - Used to ensure the target directory exists b...(DOESNT_WITH_WRONG_VERB_FORM)
development/scripts/build-tools.md (4)
3-3: Fix heading level for consistencyThe heading at line 3 jumps from H1 to H3, which can break the document outline. Change
### Overviewto## Overviewto follow proper heading hierarchy.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
3-3: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3(MD001, heading-increment)
62-64: Specify code block language for syntax highlightingThe code block showing environment variables lacks a language identifier. Add a language (e.g.,
envorbash) after the opening backticks for proper highlighting:- ``` + ```env GITHUB_TOKEN='{your-github-token}' - ``` + ```🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
62-62: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
15-15: Clarify noun plurality in documentationThe phrase "a standardized tools format" mixes a singular article with a plural noun. Consider using one of the following for clarity:
- "a standardized tool format"
- "standardized tools formats"
🧰 Tools
🪛 LanguageTool
[grammar] ~15-~15: The plural noun “tools” cannot be used with the article “a”. Did you mean “a standardized tool” or “standardized tools”?
Context: ...ion 2. Convert the raw GitHub data into a standardized tools format withconvertTools()3. Save th...(A_NNS)
19-20: Align nested list indentationThe nested list under step 5 is indented by two spaces but markdownlint expects no indentation (or consistent indentation). Adjust these list items to match the parent list style for better readability and lint compliance.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
19-19: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
20-20: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (33)
components/navigation/MobileNavMenu.tsx(3 hunks)development/scripts/build-docs.md(1 hunks)development/scripts/build-meetings.md(1 hunks)development/scripts/build-newsroom-videos.md(1 hunks)development/scripts/build-pages.md(1 hunks)development/scripts/build-rss.md(1 hunks)development/scripts/build-tools.md(1 hunks)development/vscode/launch.sample.json(1 hunks)package.json(0 hunks)scripts/adopters/index.ts(1 hunks)scripts/build-meetings.ts(1 hunks)scripts/build-newsroom-videos.ts(1 hunks)scripts/build-tools.ts(1 hunks)scripts/casestudies/index.ts(1 hunks)scripts/compose.ts(1 hunks)scripts/dashboard/build-dashboard.ts(1 hunks)scripts/finance/index.ts(1 hunks)scripts/helper/readAndWriteJson.ts(1 hunks)scripts/helper/utils.ts(1 hunks)scripts/markdown/check-edit-links.ts(1 hunks)scripts/markdown/check-markdown.ts(1 hunks)scripts/tools/combine-tools.ts(1 hunks)scripts/tools/extract-tools-github.ts(1 hunks)scripts/tools/tools-object.ts(1 hunks)tests/adopters/index.test.js(1 hunks)tests/dashboard/build-dashboard.test.js(1 hunks)tests/markdown/check-edit-links.test.js(1 hunks)tests/markdown/check-markdown.test.js(1 hunks)tests/readAndWriteJson.test.js(1 hunks)tests/tools/combine-tools.test.js(1 hunks)tests/tools/extract-tools-github.test.js(1 hunks)tests/tools/tools-object.test.js(1 hunks)tests/utils.test.js(1 hunks)
💤 Files with no reviewable changes (1)
- package.json
🧰 Additional context used
🧬 Code Graph Analysis (8)
tests/markdown/check-edit-links.test.js (3)
tests/dashboard/build-dashboard.test.js (5)
require(1-1)require(3-3)require(5-13)require(15-21)require(22-22)tests/markdown/check-markdown.test.js (2)
require(4-10)require(11-11)tests/tools/extract-tools-github.test.js (2)
require(2-2)require(3-3)
tests/markdown/check-markdown.test.js (3)
tests/markdown/check-edit-links.test.js (3)
require(4-10)require(11-11)require(12-12)tests/dashboard/build-dashboard.test.js (5)
require(1-1)require(3-3)require(5-13)require(15-21)require(22-22)tests/tools/extract-tools-github.test.js (2)
require(2-2)require(3-3)
tests/dashboard/build-dashboard.test.js (1)
tests/markdown/check-edit-links.test.js (3)
require(4-10)require(11-11)require(12-12)
tests/tools/extract-tools-github.test.js (3)
tests/markdown/check-edit-links.test.js (3)
require(4-10)require(11-11)require(12-12)tests/dashboard/build-dashboard.test.js (5)
require(1-1)require(3-3)require(5-13)require(15-21)require(22-22)tests/markdown/check-markdown.test.js (2)
require(4-10)require(11-11)
tests/utils.test.js (1)
tests/readAndWriteJson.test.js (3)
require(2-2)require(3-3)require(4-4)
tests/tools/tools-object.test.js (3)
tests/markdown/check-edit-links.test.js (3)
require(4-10)require(11-11)require(12-12)tests/dashboard/build-dashboard.test.js (5)
require(1-1)require(3-3)require(5-13)require(15-21)require(22-22)tests/markdown/check-markdown.test.js (2)
require(4-10)require(11-11)
tests/readAndWriteJson.test.js (2)
tests/adopters/index.test.js (3)
require(1-1)require(2-2)require(3-3)tests/utils.test.js (2)
require(1-1)require(2-2)
tests/tools/combine-tools.test.js (3)
tests/markdown/check-edit-links.test.js (3)
require(4-10)require(11-11)require(12-12)tests/dashboard/build-dashboard.test.js (5)
require(1-1)require(3-3)require(5-13)require(15-21)require(22-22)tests/markdown/check-markdown.test.js (2)
require(4-10)require(11-11)
🪛 LanguageTool
development/scripts/build-pages.md
[uncategorized] ~54-~54: Did you mean “use”?
Context: ...y exists and creates it if it doesn't - Used to ensure the target directory exists b...
(DOESNT_WITH_WRONG_VERB_FORM)
development/scripts/build-meetings.md
[uncategorized] ~25-~25: A determiner appears to be missing. Consider inserting it.
Context: ... API using calendar.events.list. - Time range is set from 100 days before to 30...
(AI_EN_LECTOR_MISSING_DETERMINER)
[uncategorized] ~73-~73: Loose punctuation mark.
Context: ...e account credentials. - CALENDAR_ID: ID of the Google Calendar to fetch even...
(UNLIKELY_OPENING_PUNCTUATION)
development/scripts/build-docs.md
[uncategorized] ~9-~9: Loose punctuation mark.
Context: ...# Key Functions 1. buildNavTree(): Transforms flat navigation items into a...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~15-~15: Loose punctuation mark.
Context: ...ng by weight 2. convertDocPosts(): Recursively flattens the navigation tre...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...ocument posts. 3. addDocButtons(): Adds navigation controls (previous/next...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~21-~21: You might be missing the article “a” here.
Context: ...gation sequence. ## Workflow 1. Build hierarchical navigation tree from flat items using `...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[misspelling] ~90-~90: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...Parse raw documentation items 2. Create a organized navigation structure 3. Add u...
(EN_A_VS_AN)
development/scripts/build-tools.md
[grammar] ~15-~15: The plural noun “tools” cannot be used with the article “a”. Did you mean “a standardized tool” or “standardized tools”?
Context: ...ion 2. Convert the raw GitHub data into a standardized tools format with convertTools() 3. Save th...
(A_NNS)
[uncategorized] ~89-~89: Loose punctuation mark.
Context: ...on, tags, and source. - all-tags.json: An array of unique tags extracted from ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~90-~90: Loose punctuation mark.
Context: ...he tools data. - tools-automated.json: An array of tool objects with details f...
(UNLIKELY_OPENING_PUNCTUATION)
development/scripts/build-newsroom-videos.md
[style] ~82-~82: To form a complete sentence, be sure to include a subject.
Context: ...o ../config/newsroom_videos.json. - Can be imported and used as a module with a...
(MISSING_IT_THERE)
🪛 markdownlint-cli2 (0.17.2)
development/scripts/build-tools.md
3-3: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
19-19: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
20-20: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
56-56: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
57-57: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
58-58: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
61-61: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
62-62: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
65-65: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
88-88: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
89-89: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
90-90: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
development/scripts/build-newsroom-videos.md
21-21: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
22-22: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
25-25: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
26-26: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
27-27: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
30-30: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
31-31: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
32-32: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
35-35: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
36-36: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
37-37: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
38-38: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
41-41: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
42-42: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
43-43: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
48-48: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
49-49: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
50-50: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
53-53: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
54-54: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
55-55: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
58-58: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
59-59: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
62-62: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
69-69: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
70-70: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
🪛 GitHub Actions: PR testing - if Node project
tests/readAndWriteJson.test.js
[error] 11-11: Test suite failed to run: Cannot find module '../scripts/helper/utils.js' from 'tests/readAndWriteJson.test.js'. Jest mock call at line 11 failed due to missing module.
🔇 Additional comments (30)
components/navigation/MobileNavMenu.tsx (3)
88-88: Minor: Reorder Tailwind classes for consistency (Docs link)
Swappingcursor-pointer flex→flex cursor-pointerhas no visual impact but aligns with the pattern of placing layout classes (likeflex) first for readability.
98-98: Minor: Reorder Tailwind classes for consistency (Tools link)
Similarly, changingcursor-pointer flex→flex cursor-pointerkeeps the class order consistent across the menu items.
107-107: Minor: Reorder Tailwind classes for consistency (Community link)
Again, reordering toflex cursor-pointerimproves maintainability by following the established class ordering convention.scripts/build-meetings.ts (1)
6-6: Approve import path update
The import ofloggerfrom./helper/loggeraligns with the broader refactoring of utility modules. The new path is consistent with other scripts and no functionality was altered.scripts/build-newsroom-videos.ts (1)
8-8: Approve import path update
Updating theloggerimport to./helper/loggermatches the project-wide directory restructure. No other logic changes were introduced here.scripts/compose.ts (1)
10-10: Approve import path update
Theloggermodule reference has been correctly updated to./helper/logger, in line with related scripts. All existing logging calls remain valid.tests/utils.test.js (1)
1-1: Approve test import path update
The import ofconvertToJsonhas been updated to../scripts/helper/utils.tsto reflect the new location. Ensure the test runner is configured to resolve.tsmodules correctly.scripts/helper/utils.ts (2)
19-21: Approve direct JSON parsing return
ReturningJSON.parse(contentYAMLorJSON)directly simplifies the function without changing its behavior. This refactor removes unnecessary intermediate variables.
23-25: Approve direct YAML parsing return
Directly returningyaml.parse(contentYAMLorJSON)in the catch block keeps the logic clear and concise. Error aggregation remains intact.scripts/casestudies/index.ts (1)
4-4: Import path updated correctly
The import forconvertToJsonhas been updated to the newhelperdirectory, aligning with the project’s refactoring of utility modules.scripts/build-tools.ts (1)
8-8: Import updated to helper/logger
Theloggerimport path now points to./helper/logger, matching the repository’s new directory structure for utilities. Ensure that this module export remains compatible and that logging behaves as expected in both CLI and test contexts.scripts/tools/combine-tools.ts (1)
14-14: Updated logger import path
The path to theloggerutility has been adjusted to../helper/loggerin line with the wider refactoring. Confirm that all test mocks and references have been updated accordingly and that the logger API remains unchanged.scripts/markdown/check-markdown.ts (1)
6-6: Logger import path adjusted
Theloggerimport now references../helper/logger, keeping consistency with other scripts. Please verify that this helper module is correctly located and exports the required methods (warn,error).scripts/adopters/index.ts (1)
4-4: Consistent import path update
ThewriteJSONimport has been correctly updated to the newhelperdirectory, aligning with the refactoring of utility modules.scripts/finance/index.ts (1)
4-4: Consistent import path update
ThewriteJSONimport has been correctly updated to thehelperdirectory, matching the broader utility refactor.scripts/dashboard/build-dashboard.ts (1)
17-18: Consistent import path updates for logger and pause
Theloggerandpauseimports now correctly reference thehelperdirectory, ensuring consistency with the new helper module structure.scripts/tools/extract-tools-github.ts (1)
7-8: Consistent import path updates for pause and logger
Thepauseandloggerimports have been updated to use thehelperdirectory, aligning these scripts with the new helper module organization.scripts/markdown/check-edit-links.ts (1)
7-8: Consistent import path updates for logger and pause
Theloggerandpauseutilities are now imported from thehelperdirectory, matching the standardized helper refactoring across scripts.scripts/tools/tools-object.ts (1)
8-9: Consistent import paths for helper utilities
The imports forconvertToJsonandloggerhave been correctly updated to point to the newhelperdirectory (../helper/utilsand../helper/logger). This aligns with the broader refactor and maintains consistency across scripts.scripts/helper/readAndWriteJson.ts (1)
3-3: Update import to local utils module
The path forconvertToJsonhas been corrected to./utils, matching the newhelperstructure. No functional changes here and the module resolution should work as expected.tests/adopters/index.test.js (1)
2-2: Standardize path for writeJSON import and mock
ThewriteJSONimport and its correspondingjest.mockhave been updated from../../scripts/utilsto../../scripts/helper/readAndWriteJson.ts. This keeps the test in sync with the new helper directory layout.Also applies to: 5-5
tests/tools/extract-tools-github.test.js (1)
3-3: Import path update looks good!The change updates the logger import path from
utilstohelperdirectory, which aligns with the standardization of module locations across the codebase as part of this PR.Also applies to: 5-5
tests/markdown/check-markdown.test.js (1)
11-11: Correct logger import path update!The logger module path has been properly updated from
utilstohelperdirectory, consistent with similar changes in other test files.Also applies to: 13-13
tests/dashboard/build-dashboard.test.js (1)
22-22: Import path correctly updated!The logger import and mock paths have been correctly updated to use the new
helperdirectory structure, maintaining consistency with other test files.Also applies to: 24-24
tests/tools/combine-tools.test.js (1)
23-23: Logger import path properly updated!The import path and mock for the logger module have been consistently updated to use the new
helperdirectory structure, aligning with the standardization across the codebase.Also applies to: 25-25
tests/readAndWriteJson.test.js (1)
2-3: Import paths updated to reflect helper directory
The updatedrequirecalls now correctly reference../scripts/helper/utils.tsand../scripts/helper/readAndWriteJson.ts, aligning with the new module organization.development/scripts/build-meetings.md (1)
1-93: Documentation for build-meetings script is comprehensive and clear
The markdown file provides detailed setup instructions, authentication guidelines, error handling, and output examples, making it easy for contributors to run and debug the meetings build script.🧰 Tools
🪛 LanguageTool
[uncategorized] ~25-~25: A determiner appears to be missing. Consider inserting it.
Context: ... API usingcalendar.events.list. - Time range is set from 100 days before to 30...(AI_EN_LECTOR_MISSING_DETERMINER)
[uncategorized] ~73-~73: Loose punctuation mark.
Context: ...e account credentials. -CALENDAR_ID: ID of the Google Calendar to fetch even...(UNLIKELY_OPENING_PUNCTUATION)
development/scripts/build-newsroom-videos.md (1)
1-113: Documentation for build-newsroom-videos script is clear and thorough
Well-structured instructions and descriptions facilitate easy setup, API key configuration, and usage for fetching and writing newsroom video data.🧰 Tools
🪛 LanguageTool
[style] ~82-~82: To form a complete sentence, be sure to include a subject.
Context: ...o../config/newsroom_videos.json. - Can be imported and used as a module with a...(MISSING_IT_THERE)
🪛 markdownlint-cli2 (0.17.2)
21-21: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
22-22: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
25-25: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
26-26: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
27-27: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
30-30: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
31-31: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
32-32: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
35-35: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
36-36: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
37-37: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
38-38: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
41-41: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
42-42: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
43-43: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
48-48: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
49-49: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
50-50: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
53-53: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
54-54: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
55-55: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
58-58: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
59-59: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
62-62: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
69-69: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
70-70: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
development/scripts/build-pages.md (1)
1-80: Documentation for build-pages script is complete and user-friendly
The README covers prerequisites, transformations, setup, and usage steps in a clear, logical order.🧰 Tools
🪛 LanguageTool
[uncategorized] ~54-~54: Did you mean “use”?
Context: ...y exists and creates it if it doesn't - Used to ensure the target directory exists b...(DOESNT_WITH_WRONG_VERB_FORM)
development/vscode/launch.sample.json (1)
1-211: VS Code launch configuration is comprehensive
The providedlaunch.sample.jsonincludes a broad set of launch configurations and input prompts for all necessary environment variables, greatly improving the development and debugging workflow.
asyncapi-bot
requested review from
devilkiller-ag,
vishvamsinh28,
Aahil13 and
VaishnaviNandakumar
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #4049 +/- ##
===========================================
- Coverage 100.00% 99.86% -0.14%
===========================================
Files 22 22
Lines 742 733 -9
Branches 123 122 -1
===========================================
- Hits 742 732 -10
- Partials 0 1 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
@asyncapi/bounty_team |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (15)
development/scripts/build-tools.md (4)
1-2: Use a top-level heading for consistency
The document title is marked as an H2 (##), but standalone documentation files typically start with an H1 (#) to signal the main title.- ## Tools Build Script Documentation + # Build Tools Script Documentation
14-16: Fix article–noun agreement in workflow step
The phrase “a standardized tools format” mixes a singular article with a plural noun. Consider changing it to “a standardized tool format” or “standardized tools formats” for grammatical correctness.- 2. Convert the raw GitHub data into a standardized tools format with `convertTools()` + 2. Convert the raw GitHub data into a standardized tool format with `convertTools()`🧰 Tools
🪛 LanguageTool
[grammar] ~15-~15: The plural noun “tools” cannot be used with the article “a”. Did you mean “a standardized tool” or “standardized tools”?
Context: ...ion 2. Convert the raw GitHub data into a standardized tools format withconvertTools()3. Save th...(A_NNS)
61-64: Specify language for the .env code block
The snippet showing the contents of the.envfile uses a fenced block without a language identifier. Adding one (e.g.,bashordotenv) improves syntax highlighting.- ``` - GITHUB_TOKEN='{your-github-token}' - ``` + ```bash + GITHUB_TOKEN='{your-github-token}' + ```
86-90: Enrich example output with a JSON snippet
Listing file names is helpful, but users will benefit from a concrete example of the combined JSON structure. Consider adding a truncated JSON sample fortools.jsonorall-tags.json.```json // config/tools.json (excerpt) [ { "name": "AsyncAPI Generator", "description": "Generates asyncapi documents...", "tags": ["generator","asyncapi"], "source": "automated" }, ... ]<details> <summary>🧰 Tools</summary> <details> <summary>🪛 LanguageTool</summary> [uncategorized] ~89-~89: Loose punctuation mark. Context: ...on, tags, and source. - `all-tags.json`: An array of unique tags extracted from ... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~90-~90: Loose punctuation mark. Context: ...he tools data. - `tools-automated.json`: An array of tool objects with details f... (UNLIKELY_OPENING_PUNCTUATION) </details> </details> </blockquote></details> <details> <summary>development/scripts/build-meetings.md (6)</summary><blockquote> `1-5`: **Enhance readability of the Summary section** The summary is comprehensive but densely packed into a single paragraph. Splitting into shorter sentences or converting key responsibilities (authentication, fetching, processing, error handling) into a bullet list will improve scanability. --- `9-16`: **Clarify dependency listings** Consider listing each dependency on its own line and indicating whether it’s a built-in Node.js module or an external package. For example: - `fs` (built-in) - `googleapis` (npm) - `path`, `url` (built-in) --- `19-27`: **Standardize numbering in “Key Components”** There are extra blank lines before items 2 and 3. For consistent Markdown formatting, ensure exactly one blank line between each numbered block or remove the blank line altogether. --- `49-55`: **Refine `.env` example formatting** Wrapping the service account key in single quotes may confuse users, especially if the key is JSON or contains line breaks. Also align the code block with the main text. Example diff: ```diff - CALENDAR_SERVICE_ACCOUNT='{your-service-account-key}' - CALENDAR_ID=your-calendar-id + CALENDAR_SERVICE_ACCOUNT=your-service-account-key + CALENDAR_ID=your-calendar-id
57-60: Fix code block indentation
The Bash snippet is over-indented, which may break rendering in some Markdown processors. Align the triple backticks and content to the left margin:- ```bash - npm install - ``` +```bash +npm install +```
71-73: Remove extra whitespace before bullet
Line 73 has two spaces before the dash, causing an unintended indent. It should be:- - `CALENDAR_ID`: ID of the Google Calendar to fetch events from. + - `CALENDAR_ID`: ID of the Google Calendar to fetch events from.🧰 Tools
🪛 LanguageTool
[uncategorized] ~73-~73: Loose punctuation mark.
Context: ...e account credentials. -CALENDAR_ID: ID of the Google Calendar to fetch even...(UNLIKELY_OPENING_PUNCTUATION)
development/scripts/build-docs.md (5)
1-1: Optional: Reference the script file path in the titleAdding the file path immediately under the title can help contributors locate the implementation quickly.
# Documentation Navigation Build Script +# File: `development/scripts/build-docs.ts`
21-21: Nitpick: Add missing article “a”The workflow step reads “Build hierarchical…” but should be “Build a hierarchical…”.
-1. Build hierarchical navigation tree from flat items using `buildNavTree()` +1. Build a hierarchical navigation tree from flat items using `buildNavTree()`🧰 Tools
🪛 LanguageTool
[uncategorized] ~21-~21: You might be missing the article “a” here.
Context: ...gation sequence. ## Workflow 1. Build hierarchical navigation tree from flat items using `...(AI_EN_LECTOR_MISSING_DETERMINER_A)
63-63: Nitpick: Wrap the path in code formattingFor consistency and clarity, wrap
/docsin backticks.-- Special handling for the welcome page at /docs +- Special handling for the welcome page at `/docs`
87-87: Nitpick: Strengthen the assertion about the script’s roleInstead of “appears to be part of,” state it definitively.
-This script appears to be part of a documentation website generation pipeline. +This script is part of the documentation website generation pipeline.
90-90: Nitpick: Correct the indefinite articleChange “a organized” to “an organized.”
-2. Create a organized navigation structure +2. Create an organized navigation structure🧰 Tools
🪛 LanguageTool
[misspelling] ~90-~90: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...Parse raw documentation items 2. Create a organized navigation structure 3. Add u...(EN_A_VS_AN)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (19)
development/scripts/build-docs.md(1 hunks)development/scripts/build-meetings.md(1 hunks)development/scripts/build-tools.md(1 hunks)package.json(0 hunks)scripts/adopters/index.ts(1 hunks)scripts/build-meetings.ts(1 hunks)scripts/build-newsroom-videos.ts(1 hunks)scripts/build-tools.ts(1 hunks)scripts/casestudies/index.ts(1 hunks)scripts/compose.ts(1 hunks)scripts/dashboard/build-dashboard.ts(1 hunks)scripts/finance/index.ts(1 hunks)scripts/helper/readAndWriteJson.ts(1 hunks)scripts/helper/utils.ts(1 hunks)scripts/markdown/check-edit-links.ts(1 hunks)scripts/markdown/check-markdown.ts(1 hunks)scripts/tools/combine-tools.ts(1 hunks)scripts/tools/extract-tools-github.ts(1 hunks)scripts/tools/tools-object.ts(1 hunks)
💤 Files with no reviewable changes (1)
- package.json
✅ Files skipped from review due to trivial changes (10)
- scripts/build-meetings.ts
- scripts/tools/combine-tools.ts
- scripts/dashboard/build-dashboard.ts
- scripts/adopters/index.ts
- scripts/tools/extract-tools-github.ts
- scripts/markdown/check-markdown.ts
- scripts/finance/index.ts
- scripts/build-newsroom-videos.ts
- scripts/tools/tools-object.ts
- scripts/markdown/check-edit-links.ts
🚧 Files skipped from review as they are similar to previous changes (5)
- scripts/build-tools.ts
- scripts/casestudies/index.ts
- scripts/helper/readAndWriteJson.ts
- scripts/compose.ts
- scripts/helper/utils.ts
🧰 Additional context used
🪛 LanguageTool
development/scripts/build-docs.md
[uncategorized] ~9-~9: Loose punctuation mark.
Context: ...# Key Functions 1. buildNavTree(): Transforms flat navigation items into a...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~15-~15: Loose punctuation mark.
Context: ...ng by weight 2. convertDocPosts(): Recursively flattens the navigation tre...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...ocument posts. 3. addDocButtons(): Adds navigation controls (previous/next...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~21-~21: You might be missing the article “a” here.
Context: ...gation sequence. ## Workflow 1. Build hierarchical navigation tree from flat items using `...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[misspelling] ~90-~90: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...Parse raw documentation items 2. Create a organized navigation structure 3. Add u...
(EN_A_VS_AN)
development/scripts/build-meetings.md
[uncategorized] ~73-~73: Loose punctuation mark.
Context: ...e account credentials. - CALENDAR_ID: ID of the Google Calendar to fetch even...
(UNLIKELY_OPENING_PUNCTUATION)
development/scripts/build-tools.md
[grammar] ~15-~15: The plural noun “tools” cannot be used with the article “a”. Did you mean “a standardized tool” or “standardized tools”?
Context: ...ion 2. Convert the raw GitHub data into a standardized tools format with convertTools() 3. Save th...
(A_NNS)
[uncategorized] ~89-~89: Loose punctuation mark.
Context: ...on, tags, and source. - all-tags.json: An array of unique tags extracted from ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~90-~90: Loose punctuation mark.
Context: ...he tools data. - tools-automated.json: An array of tool objects with details f...
(UNLIKELY_OPENING_PUNCTUATION)
🔇 Additional comments (1)
development/scripts/build-meetings.md (1)
1-94: Overall: Well-structured documentation
This file provides a clear, end-to-end guide for thebuild-meetings.tsscript and complements the other scripts indevelopment/scripts. Thanks for putting together thorough setup and usage instructions!🧰 Tools
🪛 LanguageTool
[uncategorized] ~73-~73: Loose punctuation mark.
Context: ...e account credentials. -CALENDAR_ID: ID of the Google Calendar to fetch even...(UNLIKELY_OPENING_PUNCTUATION)
There was a problem hiding this comment.
Actionable comments posted: 5
🧹 Nitpick comments (28)
development/scripts/build-pages.md (6)
1-6: Add script path reference in the summary
The summary describes what the script does but doesn’t mention its filename or location. Consider updating to something like:This script (
scripts/build-pages.ts) transforms markdown files into MDX files…
This gives contributors a clear pointer to where the implementation lives.
7-13: Clarify whether input/output paths are configurable
You’ve listed default directories (markdownandpages) but it isn’t clear if these are hard-coded or configurable via CLI args or environment variables. Adding a note about how to change those paths (or confirming they’re fixed) will help maintainers and power users.
30-34: Specify Node.js version requirement
Listingfs,path, andtsxis great; adding a minimum Node.js version (e.g., Node ≥14) will help avoid “unsupported syntax” or runtime errors for new contributors.
35-49: Enhance setup instructions for first-time users
- Indicate that commands should be run from the project root.
- Note that
tsxmay need to be installed (npm install -D tsx) or invoked vianpx tsx.This prevents “command not found” issues.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
37-37: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
38-38: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
39-39: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
66-73: Broaden Usage examples
Right now we only show the basic invocation. Consider adding common flags (if any), sample error output, or troubleshooting tips (e.g., “backup your existingpagesfolder before running”). This will make the doc more actionable.
77-79: Warn about potential overwrites
Since the script writes directly topages, it may overwrite existing files without warning. Add a note advising users to back up or commitpagesfirst to prevent data loss.development/scripts/build-meetings.md (6)
1-6: Include the script filename and path in the title
It will help readers immediately identify which file this doc refers to. For example, change the heading to:## scripts/build-meetings.ts – Build Meetings Script
23-26: Fix missing determiner for grammatical clarity
Insert “The” at the start of the sentence on line 25:- - Time range is set from 100 days before to 30 days after the current date. + - The time range is set from 100 days before to 30 days after the current date.🧰 Tools
🪛 LanguageTool
[uncategorized] ~25-~25: A determiner appears to be missing. Consider inserting it.
Context: ... API usingcalendar.events.list. - Time range is set from 100 days before to 30...(AI_EN_LECTOR_MISSING_DETERMINER)
51-54: Use consistent quoting for JSON environment variables
The example wraps the JSON value in single quotes. Depending on your.envparser, you may need double quotes or no quotes. For clarity, consider:-CALENDAR_SERVICE_ACCOUNT='{your-service-account-key}' +CALENDAR_SERVICE_ACCOUNT="{\"type\":\"service_account\", ... }"
40-43: Specify tested Node.js and TypeScript versions
Listing the minimum or tested versions (e.g., Node.js v16+, TypeScript 4.8+) in the prerequisites will help contributors avoid compatibility issues.
87-89: Add a sample JSON output snippet
Including a short example of themeetings.jsonstructure (with 1–2 entries) will make it easier for readers to understand the expected format.
90-93: Fix list indentation in the Notes section
Remove the extra leading space before the hyphens so that Markdown renders the bullets correctly:- - Ensure that the Google Calendar API is enabled for the project… - - The script is designed to be run in a Node.js environment… + - Ensure that the Google Calendar API is enabled for the project… + - The script is designed to be run in a Node.js environment…development/scripts/build-tools.md (12)
1-3: Use a top-level heading for this document
The title is marked as H2 (##). For a standalone doc, prefer an H1 (#) to improve readability and anchor links.-## Build Tools Script Documentation +# Build Tools Script Documentation
5-10: Clarify the location of manual tools data
The Overview mentions “Manual tools data” but doesn’t specify where that file lives. Point contributors toconfig/tools-manual.json(or the correct path) so they know which file to update.
14-21: Fix workflow list grammar
The second item uses “standardized tools format,” which reads awkwardly. Change it to “standardized tool format.”-2. Convert the raw GitHub data into a standardized tools format with `convertTools()` +2. Convert the raw GitHub data into a standardized tool format with `convertTools()`🧰 Tools
🪛 LanguageTool
[grammar] ~15-~15: The plural noun “tools” cannot be used with the article “a”. Did you mean “a standardized tool” or “standardized tools”?
Context: ...ion 2. Convert the raw GitHub data into a standardized tools format withconvertTools()3. Save th...(A_NNS)
🪛 markdownlint-cli2 (0.17.2)
19-19: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
20-20: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
19-20: Correct list indentation across the document
Multiple top-level list items are indented by two spaces, triggering markdownlint MD007. Remove leading spaces so bullets start at column 1.Also applies to: 26-30, 56-58, 61-65, 88-90
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
19-19: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
20-20: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
31-36: Enhance the Key Functions section
Consider adding the file path or signature for each function (e.g.,scripts/build-tools.ts#getData) and listing return types. It will help readers locate and understand the implementations faster.
37-42: Specify tested dependency versions
Listing deps without version guidance can lead to compatibility issues. Recommend indicating the tested versions or minimum versions for Node.js, TypeScript,axios, etc.
43-49: Add Node.js (and npm) version requirements
Under Prerequisites, specify the minimum Node.js and npm versions tested to avoid “it works on my machine” scenarios.
50-54: Include alternative package managers
Some contributors use Yarn or pnpm. Add examples such asyarn installorpnpm installalongsidenpm install.
67-73: Clarify script invocation path
The commandtsx scripts/build-tools.tsassumes ascriptsfolder at the project root. If the actual path isdevelopment/scripts, note that:tsx development/scripts/build-tools.tsor advise setting the working directory accordingly.
74-76: Merge Environment Variables with Development Setup
GITHUB_TOKENis documented twice. To reduce redundancy, consolidate the environment-variable details under the Development Setup section.
77-85: Avoid duplicate usage instructions
The Usage section repeats details already covered in Development Setup/Running the Script. Consider merging them for conciseness.
92-98: Refine the Notes section for conciseness
Many points reiterate earlier guidance (Node.js env, periodic runs). You could consolidate or remove redundant notes to keep the section focused on truly exceptional caveats.development/scripts/build-docs.md (4)
1-2: Enhance title clarity with script path
Consider including the relative path (scripts/build-docs.ts) in the title so readers immediately know which file the docs refer to.Example diff:
-# Documentation Navigation Build Script +# scripts/build-docs.ts — Documentation Navigation Build Script
9-17: Normalize list indentation under Key Functions
The numbered list under Key Functions has a leading space before each item, which can break Markdown tooling and affects readability. Remove the extra space so items align directly under the heading:- 1. **`buildNavTree()`**: Transforms flat navigation items … - 2. **`convertDocPosts()`**: Recursively flattens the navigation tree … - 3. **`addDocButtons()`**: Adds navigation controls … +1. **`buildNavTree()`**: Transforms flat navigation items … +2. **`convertDocPosts()`**: Recursively flattens the navigation tree … +3. **`addDocButtons()`**: Adds navigation controls …🧰 Tools
🪛 LanguageTool
[uncategorized] ~9-~9: Loose punctuation mark.
Context: ...# Key Functions 1.buildNavTree(): Transforms flat navigation items into a...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~15-~15: Loose punctuation mark.
Context: ...ng by weight 2.convertDocPosts(): Recursively flattens the navigation tre...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...ocument posts. 3.addDocButtons(): Adds navigation controls (previous/next...(UNLIKELY_OPENING_PUNCTUATION)
38-42: Trim trailing whitespace in heading
The heading forNavTreeends with an extra space. Removing it keeps the Markdown clean and prevents silent rendering issues.-### `NavTree` +### `NavTree`
70-78: Fix inconsistent indentation in Development Setup prerequisites
The third bullet (“Access to the project repository”) is indented one space too far compared to the other items. Align all bullets to the same level:- - TypeScript installed globally or as a dev dependency - - Access to the project repository + - TypeScript installed globally or as a dev dependency + - Access to the project repository🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
74-74: Inconsistent indentation for list items at the same level
Expected: 3; Actual: 4(MD005, list-indent)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
development/scripts/build-docs.md(1 hunks)development/scripts/build-meetings.md(1 hunks)development/scripts/build-newsroom-videos.md(1 hunks)development/scripts/build-pages.md(1 hunks)development/scripts/build-tools.md(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- development/scripts/build-newsroom-videos.md
🧰 Additional context used
🪛 LanguageTool
development/scripts/build-docs.md
[uncategorized] ~9-~9: Loose punctuation mark.
Context: ...# Key Functions 1. buildNavTree(): Transforms flat navigation items into a...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~15-~15: Loose punctuation mark.
Context: ...ng by weight 2. convertDocPosts(): Recursively flattens the navigation tre...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...ocument posts. 3. addDocButtons(): Adds navigation controls (previous/next...
(UNLIKELY_OPENING_PUNCTUATION)
development/scripts/build-meetings.md
[uncategorized] ~25-~25: A determiner appears to be missing. Consider inserting it.
Context: ... API using calendar.events.list. - Time range is set from 100 days before to 30...
(AI_EN_LECTOR_MISSING_DETERMINER)
[uncategorized] ~73-~73: Loose punctuation mark.
Context: ...e account credentials. - CALENDAR_ID: ID of the Google Calendar to fetch even...
(UNLIKELY_OPENING_PUNCTUATION)
development/scripts/build-pages.md
[grammar] ~54-~54: After the auxiliary verb ‘do’, use the base form of a verb. Did you mean “ensure”?
Context: ...y exists and creates it if it doesn't - Ensures that the target directory exists before...
(AUXILIARY_DO_WITH_INCORRECT_VERB_FORM)
development/scripts/build-tools.md
[grammar] ~15-~15: The plural noun “tools” cannot be used with the article “a”. Did you mean “a standardized tool” or “standardized tools”?
Context: ...ion 2. Convert the raw GitHub data into a standardized tools format with convertTools() 3. Save th...
(A_NNS)
[uncategorized] ~89-~89: Loose punctuation mark.
Context: ...on, tags, and source. - all-tags.json: An array of unique tags extracted from ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~90-~90: Loose punctuation mark.
Context: ...he tools data. - tools-automated.json: An array of tool objects with details f...
(UNLIKELY_OPENING_PUNCTUATION)
🪛 markdownlint-cli2 (0.17.2)
development/scripts/build-docs.md
74-74: Inconsistent indentation for list items at the same level
Expected: 3; Actual: 4
(MD005, list-indent)
development/scripts/build-pages.md
17-17: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
18-18: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
21-21: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
22-22: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
23-23: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
24-24: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
27-27: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
28-28: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
37-37: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
38-38: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
39-39: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
development/scripts/build-tools.md
19-19: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
20-20: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
56-56: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
57-57: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
58-58: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
61-61: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
65-65: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
88-88: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
89-89: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
90-90: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
🔇 Additional comments (1)
development/scripts/build-pages.md (1)
74-76: Example Output description is clear
The explanation of the resulting MDX files is concise and accurate. It will help contributors verify success by inspecting the transformed output.
| #### `ensureDirectoryExists(directory: PathLike)` | ||
| - Checks if a directory exists and creates it if it doesn't | ||
| - Ensures that the target directory exists before processing | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Remove redundant bullet in ensureDirectoryExists docs
Lines 53–54 both say essentially the same thing. To streamline:
- Checks if a directory exists and creates it if it doesn't
- Ensures that the target directory exists before processing
+ Checks if a directory exists and creates it if it doesn't📝 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.
| #### `ensureDirectoryExists(directory: PathLike)` | |
| - Checks if a directory exists and creates it if it doesn't | |
| - Ensures that the target directory exists before processing | |
| #### `ensureDirectoryExists(directory: PathLike)` | |
| - Checks if a directory exists and creates it if it doesn't |
🧰 Tools
🪛 LanguageTool
[grammar] ~54-~54: After the auxiliary verb ‘do’, use the base form of a verb. Did you mean “ensure”?
Context: ...y exists and creates it if it doesn't - Ensures that the target directory exists before...
(AUXILIARY_DO_WITH_INCORRECT_VERB_FORM)
| ### Key Components | ||
|
|
||
| 1. **Directory Management**: | ||
| - Creates the target directory if it doesn't exist | ||
| - Preserves directory structure from source to target | ||
|
|
||
| 2. **Content Transformations**: | ||
| - Converts HTML comments (`<!-- -->`) to JSX comments (`{/* */}`) | ||
| - Capitalizes specific HTML tags to match JSX component conventions | ||
| - Preserves curly braces for JSX expressions | ||
| - Renames `.md` files to `.mdx` extension | ||
|
|
||
| 3. **HTML Tag Capitalization**: | ||
| - Capitalizes specific HTML tags that need to be components in React | ||
| - Currently configured for table-related tags: 'table', 'tr', 'td', 'th', 'thead', 'tbody' | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Merge overlapping “Transformations” sections
“Content Transformations” and “HTML Tag Capitalization” largely describe the same feature set. To reduce duplication and improve readability, combine them under one heading, for example:
### Key Components
1. **Directory Management**
- …
2. **Content Transformations**
- Converts HTML comments (`<!-- -->`) to JSX comments (`{/* */}`)
- Capitalizes table-related HTML tags (`table`, `tr`, `td`, etc.) to React components
- Preserves curly braces for JSX expressions
- Renames `.md` files to `.mdx` extensionCommittable suggestion skipped: line range outside the PR's diff.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
17-17: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
18-18: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
21-21: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
22-22: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
23-23: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
24-24: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
27-27: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
28-28: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
| ### Development Setup | ||
|
|
||
| 1. **Prerequisites**: | ||
| - Node.js and npm installed | ||
| - TypeScript installed globally or as a dev dependency | ||
| - Access to a Google Calendar API project | ||
|
|
||
| 2. **Create Credentials**: | ||
| - Create a service account in the Google Cloud Console. | ||
| - You can use this blog post for reference: [Integration with Google Calendar API using Service Account](https://medium.com/iceapple-tech-talks/integration-with-google-calendar-api-using-service-account-1471e6e102c8). | ||
|
|
||
| 3. **Environment Configuration**: | ||
| - Create a `.env` file in the project root with the following variables: | ||
| ``` | ||
| CALENDAR_SERVICE_ACCOUNT='{your-service-account-key}' | ||
| CALENDAR_ID=your-calendar-id | ||
| ``` | ||
| - Alternatively, set these variables in your shell environment. | ||
|
|
There was a problem hiding this comment.
Ensure sensitive credentials are not committed
Since the documentation instructs creating a .env file with service account credentials, please verify that .env is listed in your .gitignore (or equivalent) to prevent accidentally committing secrets.
| 4. **Output**: | ||
| - The output will be a JSON file containing the hierarchical navigation structure and an array of document pages with their respective navigation controls. | ||
| - The file will be saved in the specified path (e.g., `../config/posts.json`). | ||
|
|
||
| ## Output | ||
| The output will be a JSON file containing the hierarchical navigation structure and an array of document pages with their respective navigation controls. The file will be saved in the specified path (e.g., `../config/posts.json`). | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Remove duplicate “Output” section
The Output section appears twice (once under Development Setup and again immediately after). To avoid redundancy, remove the second occurrence (lines 89–91) or merge both descriptions into a single section.
| - Ensure the environment variables are set. | ||
| - Execute the script using: | ||
| ```bash | ||
| tsx scripts/build-docs.ts | ||
| ``` |
There was a problem hiding this comment.
Resolve conflicting environment-variable instructions
You instruct users to “Ensure the environment variables are set,” but later state “No environment variables are required.” This is contradictory. Either remove the “Ensure…” line or clarify which variables (if any) must be set.
Example fix:
- - Ensure the environment variables are set.
+ - No environment variables are required for this script.📝 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.
| - Ensure the environment variables are set. | |
| - Execute the script using: | |
| ```bash | |
| tsx scripts/build-docs.ts | |
| ``` | |
| - No environment variables are required for this script. | |
| - Execute the script using: |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
scripts/helpers/check-locales.ts (1)
134-138: Unusual use of reduce pattern for error accumulation.While this works correctly, the reduce function isn't being used in a typical accumulator pattern - it's simply returning
trueregardless of the accumulated value, making it more of a side-effect operation.- hasErrors = langsWithMissingKeys.reduce((hasError, [lang, missing]) => { - logger.error(`❌ Language '${lang}' is missing these keys: ${missing.join(', ')}`); - return true; - }, hasErrors); + langsWithMissingKeys.forEach(([lang, missing]) => { + logger.error(`❌ Language '${lang}' is missing these keys: ${missing.join(', ')}`); + }); + hasErrors = langsWithMissingKeys.length > 0 ? true : hasErrors;
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (26)
scripts/adopters/index.ts(1 hunks)scripts/build-meetings.ts(1 hunks)scripts/build-newsroom-videos.ts(1 hunks)scripts/build-tools.ts(1 hunks)scripts/casestudies/index.ts(1 hunks)scripts/compose.ts(1 hunks)scripts/dashboard/build-dashboard.ts(1 hunks)scripts/finance/index.ts(1 hunks)scripts/helpers/check-locales.ts(6 hunks)scripts/helpers/readAndWriteJson.ts(1 hunks)scripts/helpers/utils.ts(1 hunks)scripts/markdown/check-edit-links.ts(1 hunks)scripts/markdown/check-markdown.ts(1 hunks)scripts/tools/combine-tools.ts(1 hunks)scripts/tools/extract-tools-github.ts(1 hunks)scripts/tools/tools-object.ts(1 hunks)tests/adopters/index.test.js(1 hunks)tests/check-locales.test.js(5 hunks)tests/dashboard/build-dashboard.test.js(1 hunks)tests/markdown/check-edit-links.test.js(1 hunks)tests/markdown/check-markdown.test.js(1 hunks)tests/readAndWriteJson.test.js(1 hunks)tests/tools/combine-tools.test.js(1 hunks)tests/tools/extract-tools-github.test.js(1 hunks)tests/tools/tools-object.test.js(1 hunks)tests/utils.test.js(1 hunks)
✅ Files skipped from review due to trivial changes (12)
- scripts/markdown/check-markdown.ts
- scripts/build-meetings.ts
- scripts/helpers/readAndWriteJson.ts
- scripts/finance/index.ts
- scripts/dashboard/build-dashboard.ts
- scripts/markdown/check-edit-links.ts
- scripts/build-tools.ts
- tests/markdown/check-markdown.test.js
- scripts/helpers/utils.ts
- tests/dashboard/build-dashboard.test.js
- tests/check-locales.test.js
- tests/tools/extract-tools-github.test.js
🚧 Files skipped from review as they are similar to previous changes (13)
- scripts/build-newsroom-videos.ts
- scripts/casestudies/index.ts
- scripts/tools/combine-tools.ts
- tests/adopters/index.test.js
- scripts/adopters/index.ts
- tests/utils.test.js
- scripts/tools/tools-object.ts
- tests/markdown/check-edit-links.test.js
- scripts/tools/extract-tools-github.ts
- scripts/compose.ts
- tests/tools/tools-object.test.js
- tests/readAndWriteJson.test.js
- tests/tools/combine-tools.test.js
🔇 Additional comments (5)
scripts/helpers/check-locales.ts (5)
13-13: Path resolution looks cleaner and more maintainable.The simplified path resolution for
localesDirimproves readability while maintaining the same functionality.
22-22: Nice function style update.Switching to arrow function syntax for
extractNestedKeysaligns with modern TypeScript practices and maintains consistency with the codebase style.
102-102: Good use of concise functional style.The compressed operation using destructuring and mapping is cleaner and more maintainable than the previous implementation.
114-116: ESLint disable comment is properly explained.Good practice to include the disabling comment with justification rather than silently suppressing the rule.
156-156: Organized exports into a single statement.Grouping all exports at the end of the file improves readability and makes it easier to identify what's being exported.
Description
This PR targets to add development files for the website repo & docs related to scripts & their local setup.
Related issue(s)
Resolves #3776
Summary by CodeRabbit
Documentation
Chores
Refactor
Style
Tests