refactor: migrate build script to typescript #3423

JeelRajodiya · 2024-11-22T13:07:17Z

Description

The PR migrates the build scripts to Typescript

Related issue(s)
Related to #3187

This reverts commit df75c79.

coderabbitai · 2024-11-22T13:07:28Z

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

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?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

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)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

JeelRajodiya · 2024-11-22T13:10:21Z

scripts/casestudies/index.ts

+    const caseStudiesList = await Promise.all(
+      files.map(async (file) => {
+        const caseStudyFileName = [dirWithCaseStudy, file].join('/');
+        const caseStudyContent = await readFile(caseStudyFileName, 'utf-8');
+
+        return convertToJson(caseStudyContent);
+      })
+    );


This part refactored to avoid using await inside a loop (eslint error)
https://eslint.org/docs/latest/rules/no-await-in-loop

…asyncapi-site into script-migration-2

akshatnema · 2024-11-24T10:46:58Z

.eslintrc

Remove trailing commas from this file.

akshatnema · 2024-11-24T10:48:21Z

package.json

  "scripts": {
    "dev": "npm run build-scripts && next dev",
    "build": "npm run build-scripts && next build",
    "test": "jest --passWithNoTests",
-    "build:pages": "node scripts/build-pages.js && npm run format:mdx",
-    "build:posts": "node scripts/index.js",
+    "build:pages": "node --loader ts-node/esm scripts/build-pages.ts && npm run format:mdx",


We discussed to use tsx as well. Why you again moved to ts-node?

package.json

akshatnema · 2024-11-24T10:50:16Z

pages/_document.tsx

It looks like you have used prettier code formatter here. Kindly remove these changes from the file.

akshatnema · 2024-11-24T10:53:21Z

scripts/build-rss.ts

+import fs from 'fs/promises';
+import json2xml from 'jgexml/json2xml';
+
+import posts from '../config/posts.json' assert { type: 'json' };


Don't import posts directly here. This file is generated at the build time of the website.

akshatnema · 2024-11-26T19:41:08Z

.eslintrc

+      "files": ["scripts/**/*"],
+      "rules": {
+        "import/no-extraneous-dependencies": "off",
+        "no-console": "off"


Can we refactor the code to remove the warning or use minimalistic console messages instead of turning off the rule?

JeelRajodiya added 29 commits November 16, 2024 14:44

format scripts

2935475

format using prettier

2badba7

migrate build-pages

ad8c426

add ts-node configuration

eedff42

setup eslint rule to ignore js-doc in script files

df75c79

Revert "setup eslint rule to ignore js-doc in script files"

7bf568a

This reverts commit df75c79.

move to imports

4c51a80

rename next config file

fbb0e61

add new path config

fd80ef2

update import names

f5b38a7

rename utils file to ts

7b6c3b9

add types

a8c12ea

update import

e2097cc

rename

c01fb85

rename to ts

c7a7247

rename compose to ts

a49c8a2

rename build docs to ts

342432a

rename build meeting to ts

9e8efd8

rename build newsroom

2e94f4c

rename build postlist to ts

6b6c4ea

rename build rss

136bd49

rename build tools to ts

3e1536a

rename readWriteJSON to ts

2528190

add type assertion of json

34b1cef

rename all files to ts

cecc10e

update imports

adb15fe

update file extentions

a05df3f

add ts-node config

8cb082b

fix eslint issues. use promise.all instead of await in a loop

b656d31

asyncapi-bot requested review from BhaswatiRoy, J0SAL, TRohit20 and VaishnaviNandakumar November 22, 2024 13:07

Merge branch 'master' into script-migration-2

40daa1c

JeelRajodiya changed the title ~~Script migration 2~~ refactor: migrate build script to typescript Nov 22, 2024

JeelRajodiya commented Nov 22, 2024

View reviewed changes

JeelRajodiya added 16 commits November 22, 2024 19:27

fix eslint error

717135f

rename

e8e30eb

rename

212e548

Merge branch 'master' into script-migration-2

652dfc8

fix eslint error

d3acd81

add error type

09a2fcc

add new types

f5fac70

add types

2f782e7

refactor and fix eslint errors

1a1f47d

use google apis and add types

75a53d4

remove console log

74d199f

add specific rules for the script folder

0459723

Merge branch 'script-migration-2' of https://github.com/JeelRajodiya/…

3df75cf

…asyncapi-site into script-migration-2

refactor dir variables

24ff781

add types and refactor it

39821b7

refactor: update eslint rules

00ed279

akshatnema requested changes Nov 24, 2024

View reviewed changes

JeelRajodiya added 4 commits November 24, 2024 17:25

reformat document

8bf03da

update include paths

15ffa2b

use dynamic import

02e679a

reformat eslintrc

227995d

akshatnema reviewed Nov 26, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: migrate build script to typescript #3423

refactor: migrate build script to typescript #3423

JeelRajodiya commented Nov 22, 2024

coderabbitai bot commented Nov 22, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

JeelRajodiya Nov 22, 2024

akshatnema Nov 24, 2024

akshatnema Nov 24, 2024

akshatnema Nov 24, 2024

akshatnema Nov 24, 2024

akshatnema Nov 26, 2024

refactor: migrate build script to typescript #3423

Are you sure you want to change the base?

refactor: migrate build script to typescript #3423

Conversation

JeelRajodiya commented Nov 22, 2024

coderabbitai bot commented Nov 22, 2024 • edited Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

JeelRajodiya Nov 22, 2024

Choose a reason for hiding this comment

akshatnema Nov 24, 2024

Choose a reason for hiding this comment

akshatnema Nov 24, 2024

Choose a reason for hiding this comment

akshatnema Nov 24, 2024

Choose a reason for hiding this comment

akshatnema Nov 24, 2024

Choose a reason for hiding this comment

akshatnema Nov 26, 2024

Choose a reason for hiding this comment

coderabbitai bot commented Nov 22, 2024 •

edited

Loading