move: jdks/sdks page generation to separate preprocessing script

Author: SvMak

.gitignore

@@ -19,5 +19,9 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 
+# Hide preprocessing out
+/preprocessing/out
+
 # Hide auto generated doc pages
 /docs/jdks.mdx
+/docs/sdks.mdx

docusaurus.config.ts

@@ -49,11 +49,7 @@ const config: Config = {
     ],
   ],
 
-  plugins: [
-    'docusaurus-plugin-sass',
-    './src/plugins/google-fonts.ts',
-    './src/plugins/jdks.ts',
-  ],
+  plugins: ['docusaurus-plugin-sass', './src/plugins/google-fonts.ts'],
 
   themeConfig: {
     // Replace with your project's social card

package.json

@@ -4,15 +4,17 @@
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",
-    "start": "docusaurus start",
-    "build": "docusaurus build",
+    "start": "npm run preprocessing:start && npm run docusaurus start",
+    "build": "npm run preprocessing:start && npm run docusaurus build",
     "swizzle": "docusaurus swizzle",
     "deploy": "docusaurus deploy",
-    "clear": "docusaurus clear",
+    "clear": "npm run preprocessing:clear && npm run docusaurus clear",
     "serve": "docusaurus serve",
     "write-translations": "docusaurus write-translations",
     "write-heading-ids": "docusaurus write-heading-ids",
-    "typecheck": "tsc"
+    "typecheck": "tsc",
+    "preprocessing:start": "tsc --outDir ./preprocessing/out ./preprocessing/src/*.ts && node ./preprocessing/out/index.js",
+    "preprocessing:clear": "rm -rf ./preprocessing/out ./docs/jdks.mdx ./docs/sdks.mdx"
   },
   "dependencies": {
     "@docusaurus/core": "^3.5.1",

preprocessing/src/index.ts

@@ -0,0 +1,12 @@
+import generateJDKs from './jdks';
+import generateSDKs from './sdks';
+
+async function run() {
+  try {
+    await Promise.all([generateJDKs(), generateSDKs()]);
+  } catch (err) {
+    console.error(err);
+  }
+}
+
+run();

src/plugins/jdks.ts preprocessing/src/jdks/index.ts

@@ -1,25 +1,17 @@
-import fs from 'node:fs/promises';
-import path from 'node:path';
-
-import { vendors } from '../data/jdks';
-
-export default function jdksPlugin() {
-  return {
-    name: 'docusaurus-jdks-plugin',
-    async loadContent() {
-      const jdkList = getJDKsMarkup(vendors);
-      const template = getMarkup(jdkList);
-
-      try {
-        await fs.writeFile(
-          path.resolve(__dirname, '../../docs/jdks.mdx'),
-          template,
-        );
-      } catch (err) {
-        console.error(err);
-      }
-    },
-  };
+import { writeFile } from 'node:fs/promises';
+import { resolve } from 'node:path';
+
+import vendors from './vendors';
+
+export default async function generateJDKs() {
+  const jdkList = getJDKsMarkup(vendors);
+  const template = getMarkup(jdkList);
+
+  try {
+    await writeFile(resolve(process.cwd(), './docs/jdks.mdx'), template);
+  } catch (err) {
+    console.error(err);
+  }
 }
 
 function getMarkup(content: string) {

src/data/jdks.ts preprocessing/src/jdks/vendors.ts

@@ -1,4 +1,4 @@
-export const vendors = [
+const vendors = [
   {
     id: 'amzn',
     vendor: 'Amazon',
@@ -201,3 +201,5 @@ export const vendors = [
       solution-oriented engineering assistance.`,
   },
 ];
+
+export default vendors;

preprocessing/src/sdks/index.ts

@@ -0,0 +1,78 @@
+import { writeFile } from 'node:fs/promises';
+import { resolve } from 'node:path';
+
+export default async function generateSDKs() {
+  const sdksData = await fetchSdks();
+  const sdks = parseSDKs(sdksData);
+  const sdkList = getSDKsMarkup(sdks);
+  const template = getMarkup(sdkList);
+
+  try {
+    await writeFile(resolve(process.cwd(), './docs/sdks.mdx'), template);
+  } catch (err) {
+    console.error(err);
+  }
+}
+
+function getMarkup(content: string) {
+  return `---
+title: SDK Installation Candidates
+---
+
+{/* ATTENTION! Do not edit, the file is generated automatically by the plugin */}
+
+${content}`;
+}
+
+function getSDKsMarkup(sdks: any[]) {
+  return sdks.reduce((acc, val) => {
+    const item = `
+## ${val.title} \\{#${val.id}\\}
+
+[${val.url}](${val.url})
+
+${val.description}
+
+\`\`\`shell
+sdk install ${val.id}
+\`\`\`
+`;
+
+    acc += `${item}`;
+
+    return acc;
+  }, '');
+}
+
+async function fetchSdks() {
+  try {
+    const res = await fetch('https://api.sdkman.io/2/candidates/list');
+
+    return await res.text();
+  } catch (err) {
+    console.error(err);
+  }
+}
+
+function parseSDKs(sdksData: string) {
+  const baseParts = sdksData
+    .split(
+      '--------------------------------------------------------------------------------',
+    )
+    .slice(1, -1);
+
+  return baseParts.map((item) => {
+    const lines = item.slice(1, -1).split('\n');
+    const id = lines.slice(-1)[0].split(' ').slice(-1)[0].trim();
+    const title = lines[0].split('  ')[0].trim();
+    const url = lines[0].split('  ').slice(-1)[0].trim();
+    const description = lines.slice(2, -2).join('\n').trim();
+
+    return {
+      id,
+      title,
+      url,
+      description,
+    };
+  });
+}