refactor: scripts code for better code quality (#3851)

Co-authored-by: JeelRajodiya <jeelrajodiyajeel@gmail.com>
Co-authored-by: Sambhav Gupta <81870866+sambhavgupta0705@users.noreply.github.com>
Co-authored-by: Akshat Nema <76521428+akshatnema@users.noreply.github.com>

Author: 3 people

jest.config.js

@@ -1,6 +1,6 @@
 const config = {
   transform: {
-    '^.+\\.[t|j]sx?$': ['babel-jest', { configFile: './tests/babel.test.config.cjs' }]
+    '^.+\\.[t|j]sx?$': ['babel-jest', { configFile: './tests/babel.test.config.cts' }]
   },
   verbose: true,
   collectCoverage: true,

package-lock.json

@@ -75,6 +75,7 @@
     "fuse.js": "^7.0.0",
     "googleapis": "^133.0.0",
     "gray-matter": "^4.0.3",
+    "he": "^1.2.0",
     "i18next": "^23.12.2",
     "jgexml": "^0.4.4",
     "js-cookie": "^3.0.5",
@@ -117,7 +118,9 @@
     "tailwindcss": "^3.4.3",
     "tsx": "^4.19.3",
     "winston": "^3.17.0",
-    "yaml": "^2.3.4"
+    "yaml": "^2.3.4",
+    "inquirer": "^9.2.14",
+    "dedent": "^1.5.1"
   },
   "devDependencies": {
     "@babel/preset-typescript": "^7.26.0",
@@ -133,6 +136,7 @@
     "@storybook/react": "^8.2.4",
     "@storybook/test": "^8.2.4",
     "@types/fs-extra": "^11.0.4",
+    "@types/he": "^1.2.3",
     "@types/inquirer": "^9.0.7",
     "@types/jest": "^29.5.14",
     "@types/lodash": "^4.17.0",
@@ -145,7 +149,6 @@
     "@typescript-eslint/eslint-plugin": "^6.21.0",
     "@typescript-eslint/parser": "^6.21.0",
     "babel-plugin-transform-import-meta": "^2.2.1",
-    "dedent": "^1.5.1",
     "eslint": "^8",
     "eslint-config-airbnb-typescript": "^17.1.0",
     "eslint-config-next": "14.1.0",
@@ -159,7 +162,6 @@
     "eslint-plugin-tailwindcss": "^3.14.2",
     "eslint-plugin-unused-imports": "^3.1.0",
     "fast-xml-parser": "^4.5.0",
-    "inquirer": "^9.2.14",
     "jest": "^29.7.0",
     "postcss-import": "^16.0.1",
     "remark-cli": "^12.0.1",

package.json

@@ -133,7 +133,7 @@ function buildNavTree(navItems: Details[]): NavTree {
  * @returns {Details[]} - The sequential array of document posts.
  * @throws {Error} - Throws an error if there is an issue during the conversion process.
  */
-const convertDocPosts = (docObject: NavTree | Details): Details[] => {
+function convertDocPosts(docObject: NavTree | Details | NavTreeItem): Details[] {
   try {
     let docsArray: Details[] = [];
 
@@ -154,10 +154,10 @@ const convertDocPosts = (docObject: NavTree | Details): Details[] => {
     }
 
     return docsArray;
-  } catch (err) {
-    throw new Error('Error in convertDocPosts:', err as Error);
+  } catch (err: unknown) {
+    throw new Error(`Error in convertDocPosts: ${(err as Error).message}`);
   }
-};
+}
 
 /**
  * Enhances document posts by appending next and previous navigation data based on the navigation tree.
@@ -215,18 +215,18 @@ function addDocButtons(docPosts: Details[], treePosts: NavTree): Details[] {
       if (index + 1 < countDocPages) {
         // checks whether the next item inside structuredPosts is a rootElement or a sectionElement
         // if yes, it goes again to a next to next item in structuredPosts to link the nextPage
+        /* istanbul ignore else */
         if (!structuredPosts[index + 1].isRootElement && !structuredPosts[index + 1].isSection) {
           nextPage = {
             title: structuredPosts[index + 1].title,
             href: structuredPosts[index + 1].slug
           };
-        } else {
+        } else if (index + 2 < countDocPages) {
           nextPage = {
             title: `${structuredPosts[index + 1].title} - ${structuredPosts[index + 2].title}`,
             href: structuredPosts[index + 2].slug
           };
         }
-
         docPost = { ...docPost, nextPage };
       }
 
@@ -255,7 +255,7 @@ function addDocButtons(docPosts: Details[], treePosts: NavTree): Details[] {
       return docPost;
     });
   } catch (err) {
-    throw new Error('An error occurred while adding doc buttons:', err as Error);
+    throw new Error(`An error occurred while adding doc buttons: ${(err as Error).message}`);
   }
 
   return structuredPosts;

scripts/build-docs.ts

@@ -21,10 +21,20 @@ async function buildMeetings(writePath: string) {
   let auth;
   let calendar;
 
+  // Check if the CALENDAR_SERVICE_ACCOUNT is present in the environment variables
+  // Check if required environment variables are present
+  if (!process.env.CALENDAR_SERVICE_ACCOUNT) {
+    throw new Error('CALENDAR_SERVICE_ACCOUNT environment variable is not set');
+  }
+
+  if (!process.env.CALENDAR_ID) {
+    throw new Error('CALENDAR_ID environment variable is not set');
+  }
+
   try {
     auth = new google.auth.GoogleAuth({
       scopes: ['https://www.googleapis.com/auth/calendar'],
-      credentials: process.env.CALENDAR_SERVICE_ACCOUNT ? JSON.parse(process.env.CALENDAR_SERVICE_ACCOUNT) : undefined
+      credentials: JSON.parse(process.env.CALENDAR_SERVICE_ACCOUNT)
     });
 
     calendar = google.calendar({ version: 'v3', auth });

scripts/build-meetings.ts

@@ -53,8 +53,6 @@ export function copyAndRenameFiles(srcDir: string, targetDir: string) {
     const srcPath = path.join(srcDir, entry.name);
     const targetPath = path.join(targetDir, entry.name);
 
-    /* istanbul ignore else */
-
     if (entry.isDirectory()) {
       // If entry is a directory, create it in target directory and recurse
       if (!fs.existsSync(targetPath)) {

scripts/build-pages.ts

@@ -71,7 +71,7 @@ function capitalize(text: string) {
  * @param {Details} details - The details of the item to add.
  * @throws {Error} - Throws an error if the details object is invalid.
  */
-export const addItem = (details: Details) => {
+export const addItem = (details: Details, resultObj: Result) => {
   if (!details || typeof details.slug !== 'string') {
     throw new Error('Invalid details object provided to addItem');
   }
@@ -84,10 +84,8 @@ export const addItem = (details: Details) => {
   };
   const section = Object.keys(sectionMap).find((key) => details.slug!.startsWith(key));
 
-  /* istanbul ignore else */
-
   if (section) {
-    finalResult[sectionMap[section]].push(details);
+    resultObj[sectionMap[section]].push(details);
   }
 };
 
@@ -181,7 +179,6 @@ async function walkDirectories(
   try {
     for (const dir of directories) {
       const directory = posix.normalize(dir[0]);
-      /* istanbul ignore next */
       const sectionSlug = dir[1] || '';
       const files = await readdir(directory);
 
@@ -196,7 +193,6 @@ async function walkDirectories(
           if (await pathExists(fileNameWithSection)) {
             // Passing a second argument to frontMatter disables cache. See https://github.com/asyncapi/website/issues/1057
             details = frontMatter(await readFile(fileNameWithSection, 'utf-8'), {}).data as Details;
-            /* istanbul ignore next */
             details.title = details.title || capitalize(basename(fileName));
           } else {
             details = {
@@ -214,7 +210,7 @@ async function walkDirectories(
           }
           details.sectionWeight = sectionWeight;
           details.slug = slug;
-          addItem(details);
+          addItem(details, finalResult);
           const rootId = details.parent || details.rootSectionId;
 
           await walkDirectories(
@@ -235,7 +231,6 @@ async function walkDirectories(
           details.toc = toc(content, { slugify: slugifyToC }).json;
           details.readingTime = Math.ceil(readingTime(content).minutes);
           details.excerpt = details.excerpt || markdownToTxt(content).substr(0, 200);
-          /* istanbul ignore next */
           details.sectionSlug = sectionSlug || slug.replace(/\.mdx$/, '');
           details.sectionWeight = sectionWeight;
           details.sectionTitle = sectionTitle;
@@ -266,7 +261,7 @@ async function walkDirectories(
             releaseNotes.push(version);
           }
 
-          addItem(details);
+          addItem(details, finalResult);
         }
       }
     }