Merge pull request #2088 from aeternity/fix-docs

docs: fix example generation by doing files match in js

Author: davidyuk

package.json

@@ -32,7 +32,7 @@
     "build:api:middleware": "node tooling/autorest/middleware-prepare.js && autorest tooling/autorest/middleware.yaml && node tooling/autorest/postprocessing.js middleware",
     "build:generate": "tsx tooling/generate-schema.ts",
     "build": "run-p build:api:* build:assets build:generate && run-p build:dist build:es build:types",
-    "docs:examples": "node tooling/docs/examples-to-md.js examples/node/[^_]*.js",
+    "docs:examples": "node tooling/docs/examples-to-md.js examples/node",
     "docs:api": "typedoc",
     "commitlint": "commitlint --from develop",
     "lint": "run-p lint:*",

tooling/autorest/compiler.yaml

@@ -17,7 +17,7 @@ directive:
 
 version: ^3.7.1
 use-extension:
-  '@autorest/typescript': ^6.0.23
+  '@autorest/typescript': ^6.0.39
   '@autorest/modelerfour': ^4.27.0
 # replace with a link to https://github.com/aeternity/aesophia_http/blob/master/config/swagger.yaml
 # at specific version after fixing https://github.com/aeternity/aesophia_http/issues/87

tooling/autorest/middleware.yaml

@@ -186,7 +186,7 @@ directive:
 
 version: ^3.7.1
 use-extension:
-  '@autorest/typescript': ^6.0.23
+  '@autorest/typescript': ^6.0.39
   '@autorest/modelerfour': ^4.27.0
 input-file: middleware-openapi.yaml
 output-folder: ../../src/apis/middleware

tooling/autorest/node.yaml

@@ -150,7 +150,7 @@ directive:
 
 version: ^3.7.1
 use-extension:
-  '@autorest/typescript': ^6.0.23
+  '@autorest/typescript': ^6.0.39
   '@autorest/modelerfour': ^4.27.0
 input-file: https://raw.githubusercontent.com/aeternity/aeternity/v7.3.0-rc5/apps/aehttp/priv/oas3.yaml
 output-folder: ../../src/apis/node

tooling/autorest/postprocessing.js

@@ -81,10 +81,6 @@ await Promise.all(
       throw error;
     }
 
-    // TODO: remove after solving https://github.com/Azure/autorest.typescript/issues/1955
-    content = content.replaceAll(/ from "\.(.*)\/models";/g, ' from ".$1/models/index";');
-    content = content.replaceAll(/ from "\.(.+)";/g, ' from ".$1.js";');
-
     if (name === module) {
       content = content.replace(/ {2}\$host: string;/, '  readonly $host: string;');
 

tooling/docs/examples-to-md.js

@@ -1,5 +1,5 @@
 import path from 'path';
-import fs from 'fs';
+import fs from 'fs/promises';
 
 function splitCodeIntoBlocks(_text) {
   const content = [];
@@ -34,25 +34,32 @@ function splitCodeIntoBlocks(_text) {
   return content;
 }
 
-process.argv.slice(2).forEach((fileName) => {
-  const inputFilePath = path.resolve(process.cwd(), fileName);
-  const text = fs.readFileSync(inputFilePath).toString();
+const directory = process.argv[2];
+const files = (await fs.readdir(directory))
+  .filter((file) => file.endsWith('.js'))
+  .filter((file) => !file.startsWith('_'));
 
-  const textMd = splitCodeIntoBlocks(text)
-    .map(({ type, content }) => ({
-      type,
-      content: type === 'code' ? content.replace(/^\n+|\n+$/g, '') : content.replace(/^ /, ''),
-    }))
-    .filter(({ type, content }) => type !== 'code' || content)
-    .filter(({ content }) => !content.includes('License'))
-    .filter(({ content }) => !content.includes('#!/'))
-    .map(({ type, content }) => (type === 'code' ? `\`\`\`js\n${content}\n\`\`\`` : content))
-    .join('\n');
+await Promise.all(
+  files.map(async (fileName) => {
+    const inputFilePath = path.resolve(process.cwd(), directory, fileName);
+    const text = await fs.readFile(inputFilePath, 'utf8');
 
-  const fileParsedPath = path.parse(path.resolve(process.cwd(), 'docs', fileName));
-  fs.mkdirSync(fileParsedPath.dir, { recursive: true });
+    const textMd = splitCodeIntoBlocks(text)
+      .map(({ type, content }) => ({
+        type,
+        content: type === 'code' ? content.replace(/^\n+|\n+$/g, '') : content.replace(/^ /, ''),
+      }))
+      .filter(({ type, content }) => type !== 'code' || content)
+      .filter(({ content }) => !content.includes('License'))
+      .filter(({ content }) => !content.includes('#!/'))
+      .map(({ type, content }) => (type === 'code' ? `\`\`\`js\n${content}\n\`\`\`` : content))
+      .join('\n');
 
-  const outputFilePath = path.format({ ...fileParsedPath, base: undefined, ext: '.md' });
-  fs.writeFileSync(outputFilePath, Buffer.from(textMd));
-  console.log(`${inputFilePath} -> ${outputFilePath}`);
-});
+    const fileParsedPath = path.parse(path.resolve(process.cwd(), 'docs', fileName));
+    await fs.mkdir(fileParsedPath.dir, { recursive: true });
+
+    const outputFilePath = path.format({ ...fileParsedPath, base: undefined, ext: '.md' });
+    await fs.writeFile(outputFilePath, Buffer.from(textMd));
+    console.log(`${inputFilePath} -> ${outputFilePath}`);
+  }),
+);