@fern-api/generator-cli 0.0.8 → 0.0.10-41618efd4

package/dist/cli.cjs

@@ -5905,14 +5905,14 @@ async function doesPathExist(filepath) {
 }
 
 // ../../node_modules/.pnpm/@fern-api+fs-utils@0.15.0-rc63/node_modules/@fern-api/fs-utils/lib/resolve.js
-var import_path = __toESM(require("path"));
+var import_path = __toESM(require("path"), 1);
 function resolve(...paths) {
   return import_path.default.resolve(...paths);
 }
 
 // src/cli.ts
 var import_fs5 = __toESM(require("fs"), 1);
-var import_promises4 = require("fs/promises");
+var import_promises5 = require("fs/promises");
 var import_path7 = __toESM(require("path"), 1);
 
 // ../../node_modules/.pnpm/yargs@17.7.2/node_modules/yargs/build/lib/yerror.js
@@ -7512,6 +7512,15 @@ async function loadReadmeConfig({
   return JSON.parse(rawContents);
 }
 
+// src/configuration/loadReferenceConfig.ts
+var import_promises3 = require("fs/promises");
+async function loadReferenceConfig({
+  absolutePathToConfig
+}) {
+  const rawContents = await (0, import_promises3.readFile)(absolutePathToConfig, "utf8");
+  return JSON.parse(rawContents);
+}
+
 // ../../node_modules/.pnpm/simple-git@3.24.0/node_modules/simple-git/dist/esm/index.js
 var import_file_exists = __toESM(require_dist(), 1);
 var import_debug = __toESM(require_src(), 1);
@@ -12019,7 +12028,7 @@ var esm_default2 = gitInstanceFactory;
 var import_tmp_promise = __toESM(require_tmp_promise(), 1);
 
 // ../../packages/commons/github/dist/ClonedRepository.js
-var import_promises3 = require("fs/promises");
+var import_promises4 = require("fs/promises");
 var import_path6 = __toESM(require("path"), 1);
 
 // ../../packages/commons/github/dist/constants.js
@@ -12042,12 +12051,12 @@ var ClonedRepository = class {
     if (!await doesPathExist2(absoluteFilePath)) {
       return void 0;
     }
-    return await (0, import_promises3.readFile)(absoluteFilePath, "utf-8");
+    return await (0, import_promises4.readFile)(absoluteFilePath, "utf-8");
   }
 };
 async function doesPathExist2(filepath) {
   try {
-    await (0, import_promises3.lstat)(filepath);
+    await (0, import_promises4.lstat)(filepath);
     return true;
   } catch {
     return false;
@@ -12934,10 +12943,7 @@ var ReadmeGenerator = class {
       });
     }
     writer.writeLine();
-    writer.writeLine(
-      `The ${this.organizationPascalCase} ${this.languageTitle} library provides convenient access to the ${this.organizationPascalCase} API from ${this.languageTitle}.`
-    );
-    writer.writeLine();
+    this.writeIntroudction({ writer });
   }
   writeBanner({ writer, bannerLink }) {
     writer.writeLine(`![](${bannerLink})`);
@@ -12948,6 +12954,12 @@ var ReadmeGenerator = class {
       "[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern)"
     );
   }
+  writeIntroudction({ writer }) {
+    writer.writeLine(
+      this.readmeConfig.introduction != null ? this.readmeConfig.introduction : `The ${this.organizationPascalCase} ${this.languageTitle} library provides convenient access to the ${this.organizationPascalCase} API from ${this.languageTitle}.`
+    );
+    writer.writeLine();
+  }
   generateDocumentation({ docsLink }) {
     const writer = new StringWriter();
     writer.writeLine("## Documentation");
@@ -13296,6 +13308,84 @@ function sectionNameToID(sectionName) {
   ).toUpperCase();
 }
 
+// src/reference/ReferenceGenerator.ts
+var ReferenceGenerator = class {
+  referenceConfig;
+  constructor({ referenceConfig }) {
+    this.referenceConfig = referenceConfig;
+  }
+  async generate({ output }) {
+    const writer = new StreamWriter(output);
+    for (const section of this.referenceConfig.sections) {
+      this.writeSection({ section, writer });
+    }
+    writer.end();
+  }
+  writeSection({ section, writer }) {
+    writer.writeLine(`## ${section.title}`);
+    writer.writeLine(`${section.description}`);
+    for (const endpoint of section.endpoints) {
+      this.writeEndpoint({ endpoint, writer });
+    }
+  }
+  writeEndpoint({ endpoint, writer }) {
+    const stringWriter = new StringWriter();
+    if (endpoint.description !== void 0) {
+      stringWriter.writeLine(
+        `#### \u{1F4DD} Description
+
+${this.writeIndentedBlock(this.writeIndentedBlock(endpoint.description))}
+`
+      );
+    }
+    stringWriter.writeLine(
+      `#### \u{1F50C} Usage
+
+${this.writeIndentedBlock(
+        this.writeIndentedBlock(
+          "```" + this.referenceConfig.language.toLowerCase() + "\n" + endpoint.snippet + "\n```"
+        )
+      )}
+`
+    );
+    if (endpoint.parameters.length > 0) {
+      stringWriter.writeLine(
+        `#### \u2699\uFE0F Parameters
+
+${this.writeIndentedBlock(
+          endpoint.parameters.map((parameter) => this.writeIndentedBlock(this.writeParameter(parameter))).join("\n\n")
+        )}
+`
+      );
+    }
+    writer.writeLine(
+      `<details><summary><code>${this.wrapInLinksAndJoin(endpoint.title.snippetParts)}</code></summary>`
+    );
+    writer.writeLine(this.writeIndentedBlock(stringWriter.toString()));
+    writer.writeLine("</details>\n");
+  }
+  writeParameter(parameter) {
+    const desc = parameter.description?.match(/[^\r\n]+/g)?.length;
+    const containsLineBreak = desc !== void 0 && desc > 1;
+    return `**${parameter.name}:** \`${this.wrapInLink(parameter.type, parameter.location)}\` ${parameter.description !== void 0 ? (containsLineBreak ? "\n\n" : "\u2014 ") + parameter.description : ""}
+    `;
+  }
+  writeIndentedBlock(content) {
+    return `<dl>
+<dd>
+
+${content}
+</dd>
+</dl>`;
+  }
+  wrapInLinksAndJoin(content) {
+    return content.map(({ text, location }) => this.wrapInLink(text, location)).join("");
+  }
+  wrapInLink(content, link) {
+    return link !== void 0 ? `<a href="${link.path}">${content}</a>` : content;
+  }
+};
+
 // src/cli.ts
 void yargs_default(hideBin(process.argv)).scriptName(process.env.CLI_NAME ?? "generator-cli").strict().command(
   "generate readme",
@@ -13322,20 +13412,47 @@ void yargs_default(hideBin(process.argv)).scriptName(process.env.CLI_NAME ?? "ge
     const generator = new ReadmeGenerator({
       readmeParser: new ReadmeParser(),
       readmeConfig,
-      originalReadme: argv.originalReadme != null ? await (0, import_promises4.readFile)(argv.originalReadme, "utf8") : void 0
+      originalReadme: argv.originalReadme != null ? await (0, import_promises5.readFile)(argv.originalReadme, "utf8") : void 0
     });
     await generator.generateReadme({
       output: await createWriteStream(argv.output)
     });
     process.exit(0);
   }
+).command(
+  "generate-reference",
+  "Generate an SDK reference (`reference.md`) using the provided configuration file.",
+  (argv) => argv.option("config", {
+    string: true,
+    requred: true
+  }).option("output", {
+    string: true,
+    requred: false
+  }),
+  async (argv) => {
+    if (argv.config == null) {
+      process.stderr.write("missing required arguments; please specify the --config flag\n");
+      process.exit(1);
+    }
+    const wd = cwd();
+    const referenceConfig = await loadReferenceConfig({
+      absolutePathToConfig: resolve(wd, argv.config)
+    });
+    const generator = new ReferenceGenerator({
+      referenceConfig
+    });
+    await generator.generate({
+      output: await createWriteStream(argv.output)
+    });
+    process.exit(0);
+  }
 ).demandCommand().showHelpOnFail(true).parse();
 async function createWriteStream(outputPath) {
   return outputPath != null ? await createWriteStreamFromFile(resolve(cwd(), outputPath)) : process.stdout;
 }
 async function createWriteStreamFromFile(filepath) {
   if (!doesPathExist(filepath)) {
-    await (0, import_promises4.mkdir)(import_path7.default.dirname(filepath), { recursive: true });
+    await (0, import_promises5.mkdir)(import_path7.default.dirname(filepath), { recursive: true });
   }
   return import_fs5.default.createWriteStream(filepath);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fern-api/generator-cli",
-  "version": "0.0.8",
+  "version": "0.0.10-41618efd4",
   "files": [
     "dist"
   ],
@@ -37,7 +37,7 @@
     "execa": "^5.1.1",
     "lodash-es": "^4.17.12",
     "organize-imports-cli": "^0.10.0",
-    "prettier": "^3.2.4",
+    "prettier": "^3.3.2",
     "tsup": "^8.0.2",
     "typescript": "4.9.5",
     "vitest": "^1.5.0",