@fern-api/generator-cli 0.4.6 → 0.5.2

package/bin/cli

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require("../dist/cli.js");

package/dist/{api.d.cts → api.d.ts}

@@ -158,6 +158,8 @@ interface GithubRemote {
     repoUrl: string;
     /** The token used to clone the GitHub repository. */
     installationToken: string;
+    /** The branch to clone from. If not specified, the default branch will be used. */
+    branch?: string;
 }
 
 /**
@@ -168,7 +170,7 @@ interface GithubRemote {
  * A single feature supported by a generator (e.g. PAGINATION).
  */
 interface ReadmeFeature extends FeatureSpec {
-    snippets?: string[];
+    snippets?: Snippet[];
     /**
      * If true, the feature block should be rendered even if we don't receive a snippet for it.
      * This is useful for features that are always supported, but might not require a snippet
@@ -177,6 +179,44 @@ interface ReadmeFeature extends FeatureSpec {
     snippetsAreOptional: boolean;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+/**
+ * A snippet that can be either a plain string (treated as code in the generator's language),
+ * markdown content, or a code block with optional language override.
+ * Plain strings are supported for backwards compatibility.
+ */
+type Snippet = string | MarkdownSnippet | CodeSnippet;
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * A markdown snippet that will be rendered as-is without code fences.
+ */
+interface MarkdownSnippet {
+    /** Discriminator field to identify this as a markdown snippet. */
+    type: "markdown";
+    content: string;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * A code snippet that will be wrapped in a code fence with the specified language.
+ * If no language is specified, the generator's language will be used.
+ */
+interface CodeSnippet {
+    /** Discriminator field to identify this as a code snippet. */
+    type: "code";
+    content: string;
+    /** The language for the code fence. If not specified, the generator's language will be used. */
+    language?: string;
+}
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */

package/dist/{api.cjs → api.js}

@@ -6088,6 +6088,11 @@ var ClonedRepository = class _ClonedRepository {
     this.clonePath = clonePath;
     this.git = git;
   }
+  async setUserAndEmail({ name, email }) {
+    await this.git.cwd(this.clonePath);
+    await this.git.addConfig("user.name", name);
+    await this.git.addConfig("user.email", email);
+  }
   static createAtPath(clonePath) {
     return new _ClonedRepository({
       clonePath,
@@ -6156,9 +6161,78 @@ var ClonedRepository = class _ClonedRepository {
     await this.git.cwd(this.clonePath);
     await this.git.pull("origin", branch);
   }
+  async pullWithMerge(branch) {
+    await this.git.cwd(this.clonePath);
+    await this.git.raw(["pull", "origin", branch, "--no-rebase"]);
+  }
   async push() {
     await this.git.cwd(this.clonePath);
-    await this.git.push();
+    const currentBranch = await this.getCurrentBranch();
+    try {
+      await this.git.push();
+    } catch (err) {
+      const msg = String(err);
+      const isNoUpstream = msg.includes("has no upstream branch") || msg.includes("no upstream branch");
+      if (isNoUpstream) {
+        await this.pushUpstream(currentBranch);
+        return;
+      }
+      throw err;
+    }
+  }
+  async pushWithMergingRemote() {
+    await this.git.cwd(this.clonePath);
+    const currentBranch = await this.getCurrentBranch();
+    const isRemoteReject = (msg) => msg.includes("fetch first") || msg.includes("Updates were rejected") || msg.includes("non-fast-forward");
+    const isDivergent = (msg) => msg.includes("divergent branches") || msg.includes("You have divergent branches");
+    try {
+      await this.push();
+    } catch (err) {
+      const errMsg = String(err);
+      if (isRemoteReject(errMsg)) {
+        try {
+          await this.pull(currentBranch);
+          await this.push();
+          return;
+        } catch (pullErr) {
+          const pullMsg = String(pullErr);
+          if (isDivergent(pullMsg)) {
+            try {
+              await this.pullWithMerge(currentBranch);
+              await this.push();
+              return;
+            } catch (mergeErr) {
+              throw err;
+            }
+          } else {
+            throw err;
+          }
+        }
+      } else {
+        throw err;
+      }
+    }
+  }
+  async pushWithRebasingRemote() {
+    await this.git.cwd(this.clonePath);
+    const currentBranch = await this.getCurrentBranch();
+    const isRemoteReject = (msg) => msg.includes("fetch first") || msg.includes("Updates were rejected") || msg.includes("non-fast-forward");
+    try {
+      await this.push();
+    } catch (err) {
+      const errMsg = String(err);
+      if (isRemoteReject(errMsg)) {
+        try {
+          await this.git.raw(["pull", "origin", currentBranch, "--rebase"]);
+          await this.push();
+          return;
+        } catch (pullErr) {
+          throw new Error(`Push failed: ${errMsg}. Attempted to rebase but that also failed: ${String(pullErr)}`);
+        }
+      } else {
+        throw err;
+      }
+    }
   }
   async isRemoteEmpty() {
     await this.git.cwd(this.clonePath);
@@ -6177,6 +6251,18 @@ var ClonedRepository = class _ClonedRepository {
       await this.git.checkoutLocalBranch(branch);
     }
   }
+  async checkoutRemoteBranch(branch) {
+    await this.git.cwd(this.clonePath);
+    try {
+      await this.git.checkout(branch);
+    } catch (_error) {
+      try {
+        await this.git.checkout(["-b", branch, `origin/${branch}`]);
+      } catch (_remoteError) {
+        await this.git.checkoutLocalBranch(branch);
+      }
+    }
+  }
   async pushUpstream(branch) {
     await this.git.cwd(this.clonePath);
     await this.git.push("origin", branch, { "--set-upstream": null });
@@ -6777,11 +6863,12 @@ var Language = {
 };
 
 // src/utils/Writer.ts
-var import_fs = __toESM(require("fs"), 1);
+var import_fs = __toESM(require("fs"));
 var Writer = class {
   async writeCodeBlock(language, content) {
     await this.writeLine(`\`\`\`${language}`);
-    await this.write(content);
+    const normalizedContent = content.endsWith("\n") ? content : content + "\n";
+    await this.write(normalizedContent);
     await this.writeLine("```");
   }
   async writeLine(content) {
@@ -7124,7 +7211,23 @@ var ReadmeGenerator = class {
       if (index > 0) {
         await writer.writeLine();
       }
-      await writer.writeCodeBlock(this.readmeConfig.language.type, snippet);
+      if (typeof snippet === "string") {
+        await writer.writeCodeBlock(this.readmeConfig.language.type, snippet);
+      } else {
+        switch (snippet.type) {
+          case "markdown":
+            await writer.writeLine(snippet.content);
+            break;
+          case "code":
+            await writer.writeCodeBlock(
+              snippet.language ?? this.readmeConfig.language.type,
+              snippet.content
+            );
+            break;
+          default:
+            assertNever(snippet);
+        }
+      }
     }
     if (feature.addendum != null) {
       await writer.writeLine(feature.addendum);
@@ -7160,6 +7263,15 @@ var ReadmeGenerator = class {
         githubRepository: this.readmeConfig.remote.repoUrl,
         installationToken: this.readmeConfig.remote.installationToken
       });
+      if (this.readmeConfig.remote.branch != null) {
+        try {
+          await clonedRepository.checkout(this.readmeConfig.remote.branch);
+        } catch (error) {
+          console.warn(
+            `Failed to checkout branch ${this.readmeConfig.remote.branch}, using default branch instead`
+          );
+        }
+      }
       return await clonedRepository.getReadme();
     }
     return void 0;
@@ -7974,7 +8086,11 @@ ${content}
     return content.map(({ text, location }) => this.wrapInLink(text, location)).join("");
   }
   wrapInLink(content, link) {
-    return link != null ? `<a href="${link.path}">${content}</a>` : content;
+    const encodedContent = this.htmlEncode(content);
+    return link != null ? `<a href="${link.path}">${encodedContent}</a>` : encodedContent;
+  }
+  htmlEncode(content) {
+    return content.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;");
   }
 };
 

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+
+export {  }

package/dist/{cli.cjs → cli.js}

@@ -1,4 +1,3 @@
-#!/usr/bin/env node
 "use strict";
 var __create = Object.create;
 var __defProp = Object.defineProperty;
@@ -6066,9 +6065,9 @@ function resolve(...paths) {
 }
 
 // src/cli.ts
-var import_fs6 = __toESM(require("fs"), 1);
+var import_fs6 = __toESM(require("fs"));
 var import_promises6 = require("fs/promises");
-var import_path7 = __toESM(require("path"), 1);
+var import_path7 = __toESM(require("path"));
 
 // ../../node_modules/.pnpm/yargs@17.7.2/node_modules/yargs/build/lib/yerror.js
 var YError = class _YError extends Error {
@@ -12227,6 +12226,11 @@ var ClonedRepository = class _ClonedRepository {
     this.clonePath = clonePath;
     this.git = git;
   }
+  async setUserAndEmail({ name, email }) {
+    await this.git.cwd(this.clonePath);
+    await this.git.addConfig("user.name", name);
+    await this.git.addConfig("user.email", email);
+  }
   static createAtPath(clonePath) {
     return new _ClonedRepository({
       clonePath,
@@ -12295,9 +12299,78 @@ var ClonedRepository = class _ClonedRepository {
     await this.git.cwd(this.clonePath);
     await this.git.pull("origin", branch);
   }
+  async pullWithMerge(branch) {
+    await this.git.cwd(this.clonePath);
+    await this.git.raw(["pull", "origin", branch, "--no-rebase"]);
+  }
   async push() {
     await this.git.cwd(this.clonePath);
-    await this.git.push();
+    const currentBranch = await this.getCurrentBranch();
+    try {
+      await this.git.push();
+    } catch (err) {
+      const msg = String(err);
+      const isNoUpstream = msg.includes("has no upstream branch") || msg.includes("no upstream branch");
+      if (isNoUpstream) {
+        await this.pushUpstream(currentBranch);
+        return;
+      }
+      throw err;
+    }
+  }
+  async pushWithMergingRemote() {
+    await this.git.cwd(this.clonePath);
+    const currentBranch = await this.getCurrentBranch();
+    const isRemoteReject = (msg) => msg.includes("fetch first") || msg.includes("Updates were rejected") || msg.includes("non-fast-forward");
+    const isDivergent = (msg) => msg.includes("divergent branches") || msg.includes("You have divergent branches");
+    try {
+      await this.push();
+    } catch (err) {
+      const errMsg = String(err);
+      if (isRemoteReject(errMsg)) {
+        try {
+          await this.pull(currentBranch);
+          await this.push();
+          return;
+        } catch (pullErr) {
+          const pullMsg = String(pullErr);
+          if (isDivergent(pullMsg)) {
+            try {
+              await this.pullWithMerge(currentBranch);
+              await this.push();
+              return;
+            } catch (mergeErr) {
+              throw err;
+            }
+          } else {
+            throw err;
+          }
+        }
+      } else {
+        throw err;
+      }
+    }
+  }
+  async pushWithRebasingRemote() {
+    await this.git.cwd(this.clonePath);
+    const currentBranch = await this.getCurrentBranch();
+    const isRemoteReject = (msg) => msg.includes("fetch first") || msg.includes("Updates were rejected") || msg.includes("non-fast-forward");
+    try {
+      await this.push();
+    } catch (err) {
+      const errMsg = String(err);
+      if (isRemoteReject(errMsg)) {
+        try {
+          await this.git.raw(["pull", "origin", currentBranch, "--rebase"]);
+          await this.push();
+          return;
+        } catch (pullErr) {
+          throw new Error(`Push failed: ${errMsg}. Attempted to rebase but that also failed: ${String(pullErr)}`);
+        }
+      } else {
+        throw err;
+      }
+    }
   }
   async isRemoteEmpty() {
     await this.git.cwd(this.clonePath);
@@ -12316,6 +12389,18 @@ var ClonedRepository = class _ClonedRepository {
       await this.git.checkoutLocalBranch(branch);
     }
   }
+  async checkoutRemoteBranch(branch) {
+    await this.git.cwd(this.clonePath);
+    try {
+      await this.git.checkout(branch);
+    } catch (_error) {
+      try {
+        await this.git.checkout(["-b", branch, `origin/${branch}`]);
+      } catch (_remoteError) {
+        await this.git.checkoutLocalBranch(branch);
+      }
+    }
+  }
   async pushUpstream(branch) {
     await this.git.cwd(this.clonePath);
     await this.git.push("origin", branch, { "--set-upstream": null });
@@ -12916,11 +13001,12 @@ var Language = {
 };
 
 // src/utils/Writer.ts
-var import_fs5 = __toESM(require("fs"), 1);
+var import_fs5 = __toESM(require("fs"));
 var Writer = class {
   async writeCodeBlock(language, content) {
     await this.writeLine(`\`\`\`${language}`);
-    await this.write(content);
+    const normalizedContent = content.endsWith("\n") ? content : content + "\n";
+    await this.write(normalizedContent);
     await this.writeLine("```");
   }
   async writeLine(content) {
@@ -13263,7 +13349,23 @@ var ReadmeGenerator = class {
       if (index > 0) {
         await writer.writeLine();
       }
-      await writer.writeCodeBlock(this.readmeConfig.language.type, snippet);
+      if (typeof snippet === "string") {
+        await writer.writeCodeBlock(this.readmeConfig.language.type, snippet);
+      } else {
+        switch (snippet.type) {
+          case "markdown":
+            await writer.writeLine(snippet.content);
+            break;
+          case "code":
+            await writer.writeCodeBlock(
+              snippet.language ?? this.readmeConfig.language.type,
+              snippet.content
+            );
+            break;
+          default:
+            assertNever(snippet);
+        }
+      }
     }
     if (feature.addendum != null) {
       await writer.writeLine(feature.addendum);
@@ -13299,6 +13401,15 @@ var ReadmeGenerator = class {
         githubRepository: this.readmeConfig.remote.repoUrl,
         installationToken: this.readmeConfig.remote.installationToken
       });
+      if (this.readmeConfig.remote.branch != null) {
+        try {
+          await clonedRepository.checkout(this.readmeConfig.remote.branch);
+        } catch (error) {
+          console.warn(
+            `Failed to checkout branch ${this.readmeConfig.remote.branch}, using default branch instead`
+          );
+        }
+      }
       return await clonedRepository.getReadme();
     }
     return void 0;
@@ -14093,7 +14204,11 @@ ${content}
     return content.map(({ text, location }) => this.wrapInLink(text, location)).join("");
   }
   wrapInLink(content, link) {
-    return link != null ? `<a href="${link.path}">${content}</a>` : content;
+    const encodedContent = this.htmlEncode(content);
+    return link != null ? `<a href="${link.path}">${encodedContent}</a>` : encodedContent;
+  }
+  htmlEncode(content) {
+    return content.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;");
   }
 };
 

package/package.json

@@ -1,23 +1,23 @@
 {
   "name": "@fern-api/generator-cli",
-  "version": "0.4.6",
+  "version": "0.5.2",
   "repository": {
     "type": "git",
-    "url": "https://github.com/fern-api/fern"
+    "url": "git+https://github.com/fern-api/fern.git",
+    "directory": "packages/generator-cli"
   },
-  "type": "module",
-  "main": "dist/api.cjs",
+  "type": "commonjs",
+  "main": "dist/api.js",
   "source": "src/index.ts",
-  "types": "dist/api.d.cts",
+  "types": "dist/api.d.ts",
   "bin": {
-    "generator-cli": "dist/cli.cjs"
+    "generator-cli": "bin/cli"
   },
-  "files": ["dist"],
+  "files": ["bin", "dist"],
   "scripts": {
-    "clean": "rm -rf ./dist && tsc --build --clean",
-    "compile": "tsup && pnpm compile:api:dts && echo '#!/usr/bin/env node' | cat - dist/cli.cjs > dist/tmp && mv dist/tmp dist/cli.cjs",
-    "compile:api:dts": "tsup ./src/api.ts --format cjs --dts --dts-only",
+    "clean": "rm -rf ./lib && rm -rf ./dist && tsc --build --clean",
     "depcheck": "depcheck",
+    "dist:cli": "node build.mjs",
     "test": "vitest --run --passWithNoTests --globals --disable-console-intercept",
     "test:update": "vitest -u --run --passWithNoTests --globals --disable-console-intercept"
   },