chore(cli): Add browser compatible base generator (#5288)

generators/commons/package.json → generators/base/package.json

@@ -1,10 +1,10 @@
 {
-  "name": "@fern-api/generator-commons",
+  "name": "@fern-api/base-generator",
   "version": "0.0.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/fern-api/fern.git",
-    "directory": "generators/commons"
+    "directory": "generators/base"
   },
   "private": true,
   "files": [
@@ -28,12 +28,12 @@
     "depcheck": "depcheck"
   },
   "dependencies": {
+    "@fern-api/browser-compatible-base-generator": "workspace:*",
     "@fern-api/core-utils": "workspace:*",
     "@fern-api/fs-utils": "workspace:*",
     "@fern-api/logger": "workspace:*",
     "@fern-api/logging-execa": "workspace:*",
     "@fern-fern/generator-cli-sdk": "0.0.17",
-    "@fern-fern/generator-exec-sdk": "^0.0.898",
     "js-yaml": "^4.1.0",
     "lodash-es": "^4.17.21",
     "tmp-promise": "^3.0.3"

generators/commons/src/AbstractGeneratorAgent.ts → generators/base/src/AbstractGeneratorAgent.ts

@@ -1,12 +1,11 @@
 import { Logger } from "@fern-api/logger";
-import { AbstractGeneratorContext } from "./AbstractGeneratorContext";
+import { AbstractGeneratorContext, FernGeneratorExec } from "@fern-api/browser-compatible-base-generator";
 import { GeneratorAgentClient } from "./GeneratorAgentClient";
 import { FernGeneratorCli } from "@fern-fern/generator-cli-sdk";
 import { readFile } from "fs/promises";
 import yaml from "js-yaml";
 import path from "path";
 import { ReferenceConfigBuilder } from "./reference";
-import { FernGeneratorExec } from "@fern-fern/generator-exec-sdk";
 
 const DOCKER_FEATURES_CONFIG_PATH = "/assets/features.yml";
 

generators/commons/src/AbstractGeneratorCli.ts → generators/base/src/AbstractGeneratorCli.ts

@@ -1,9 +1,12 @@
 /* eslint-disable no-console */
 import { assertNever } from "@fern-api/core-utils";
-import * as GeneratorExecParsing from "@fern-fern/generator-exec-sdk/serialization";
 import { readFile } from "fs/promises";
-import { AbstractGeneratorContext } from "./AbstractGeneratorContext";
-import { FernGeneratorExec, GeneratorNotificationService } from "./GeneratorNotificationService";
+import {
+    AbstractGeneratorContext,
+    FernGeneratorExec,
+    GeneratorExecParsing,
+    GeneratorNotificationService
+} from "@fern-api/browser-compatible-base-generator";
 
 export abstract class AbstractGeneratorCli<
     CustomConfig,

generators/commons/src/SourceFetcher.ts → generators/base/src/SourceFetcher.ts

@@ -4,7 +4,7 @@ import { createWriteStream } from "fs";
 import { mkdir, readdir } from "fs/promises";
 import { pipeline } from "stream";
 import { promisify } from "util";
-import { AbstractGeneratorContext } from "./AbstractGeneratorContext";
+import { AbstractGeneratorContext } from "@fern-api/browser-compatible-base-generator";
 
 const LOCAL_FILE_SCHEME = "file:///";
 const PROTOBUF_ZIP_FILENAME = "proto.zip";

generators/commons/src/__test__/SourceFetcher.test.ts → generators/base/src/__test__/SourceFetcher.test.ts

@@ -1,6 +1,6 @@
 import { AbsoluteFilePath, getDirectoryContents, getDirectoryContentsForSnapshot } from "@fern-api/fs-utils";
 import path from "path";
-import { AbstractGeneratorContext } from "../AbstractGeneratorContext";
+import { AbstractGeneratorContext } from "@fern-api/browser-compatible-base-generator";
 import { SourceFetcher } from "../SourceFetcher";
 
 const AWS_BUCKET_NAME = "fdr-api-definition-source-test";

generators/base/src/browserCompatibleExports.ts

@@ -0,0 +1,6 @@
+// Export everything from @fern-api/browser-compatible-base-generator
+// so that generators can simply consume @fern-api/base-generator.
+//
+// Packages that require browser compatibility should import directly
+// from @fern-api/browser-compatible-base-generator.
+export * from "@fern-api/browser-compatible-base-generator";

generators/commons/src/index.ts → generators/base/src/index.ts

@@ -1,11 +1,8 @@
 export * from "./AbstractGeneratorAgent";
 export * from "./AbstractGeneratorCli";
-export * from "./AbstractGeneratorContext";
-export * from "./GeneratorNotificationService";
+export * from "./browserCompatibleExports";
 export * from "./SourceFetcher";
-export * from "./ast";
 export * from "./project";
 export * from "./readme";
 export * from "./reference";
 export * from "./utils";
-export * from "./dynamic-snippets";

generators/commons/src/project/AbstractProject.ts → generators/base/src/project/AbstractProject.ts

@@ -1,4 +1,4 @@
-import { AbstractGeneratorContext } from "../AbstractGeneratorContext";
+import { AbstractGeneratorContext } from "@fern-api/browser-compatible-base-generator";
 import { AbsoluteFilePath } from "@fern-api/fs-utils";
 import { File } from "./File";
 

generators/commons/src/readme/AbstractReadmeSnippetBuilder.ts → generators/base/src/readme/AbstractReadmeSnippetBuilder.ts

@@ -1,4 +1,4 @@
-import { FernGeneratorExec } from "../GeneratorNotificationService";
+import { FernGeneratorExec } from "@fern-api/browser-compatible-base-generator";
 import { camelCase } from "lodash-es";
 
 export abstract class AbstractReadmeSnippetBuilder {

generators/base/src/utils/index.ts

@@ -0,0 +1,2 @@
+export { parseGeneratorConfig } from "./parseGeneratorConfig";
+export { parseIR } from "./parseIR";

generators/commons/src/utils/parseGeneratorConfig.ts → generators/base/src/utils/parseGeneratorConfig.ts

@@ -1,5 +1,4 @@
-import { FernGeneratorExec } from "@fern-fern/generator-exec-sdk";
-import * as GeneratorExecParsing from "@fern-fern/generator-exec-sdk/serialization";
+import { FernGeneratorExec, GeneratorExecParsing } from "@fern-api/browser-compatible-base-generator";
 import { readFile } from "fs/promises";
 
 export async function parseGeneratorConfig(pathToConfig: string): Promise<FernGeneratorExec.GeneratorConfig> {

generators/base/tsconfig.json

@@ -0,0 +1,28 @@
+{
+  "extends": "../../shared/tsconfig.shared.json",
+  "compilerOptions": {
+    "composite": true,
+    "outDir": "lib",
+    "rootDir": "src"
+  },
+  "include": [
+    "./src/**/*"
+  ],
+  "references": [
+    {
+      "path": "../browser-compatible-base"
+    },
+    {
+      "path": "../../packages/cli/logger"
+    },
+    {
+      "path": "../../packages/commons/core-utils"
+    },
+    {
+      "path": "../../packages/commons/fs-utils"
+    },
+    {
+      "path": "../../packages/commons/logging-execa"
+    }
+  ]
+}

generators/browser-compatible-base/.depcheckrc.json

@@ -0,0 +1,10 @@
+{
+    "ignores": [
+        "@types/jest",
+        "globals",
+        "@types/node"
+    ],
+    "ignore-patterns": [
+        "lib"
+    ]
+}

generators/browser-compatible-base/.prettierrc.cjs

@@ -0,0 +1 @@
+module.exports = require("../../.prettierrc.json");

generators/browser-compatible-base/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@fern-api/browser-compatible-base-generator",
+  "version": "0.0.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/fern-api/fern.git",
+    "directory": "generators/browser-compatible-base"
+  },
+  "private": true,
+  "files": [
+    "lib"
+  ],
+  "type": "module",
+  "source": "src/index.ts",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "sideEffects": false,
+  "scripts": {
+    "clean": "rm -rf ./lib && tsc --build --clean",
+    "compile": "tsc --build",
+    "test": "vitest --passWithNoTests --run",
+    "test:update": "vitest --passWithNoTests --run -u",
+    "lint:eslint": "eslint --max-warnings 0 . --ignore-path=../../.eslintignore",
+    "lint:eslint:fix": "yarn lint:eslint --fix",
+    "format": "prettier --write --ignore-unknown --ignore-path ../../shared/.prettierignore \"**\"",
+    "format:check": "prettier --check --ignore-unknown --ignore-path ../../shared/.prettierignore \"**\"",
+    "organize-imports": "organize-imports-cli tsconfig.json",
+    "depcheck": "depcheck"
+  },
+  "dependencies": {
+    "@fern-api/logger": "workspace:*",
+    "@fern-fern/generator-exec-sdk": "^0.0.898"
+  },
+  "devDependencies": {
+    "depcheck": "^1.4.6",
+    "eslint": "^8.56.0",
+    "vitest": "^2.1.4",
+    "organize-imports-cli": "^0.10.0",
+    "prettier": "^2.7.1",
+    "typescript": "4.6.4"
+  }
+}

generators/browser-compatible-base/src/index.ts

@@ -0,0 +1,5 @@
+export * from "./AbstractGeneratorContext";
+export * from "./GeneratorNotificationService";
+export * from "./ast";
+export * from "./utils";
+export * from "./dynamic-snippets";

generators/commons/src/utils/index.ts → generators/browser-compatible-base/src/utils/index.ts

@@ -1,5 +1,3 @@
 export { getBasename } from "./getBasename";
 export { getPackageName } from "./getPackageName";
 export { getSdkVersion } from "./getSdkVersion";
-export { parseGeneratorConfig } from "./parseGeneratorConfig";
-export { parseIR } from "./parseIR";

generators/browser-compatible-base/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "extends": "../../shared/tsconfig.shared.json",
+  "compilerOptions": {
+    "composite": true,
+    "outDir": "lib",
+    "rootDir": "src"
+  },
+  "include": [
+    "./src/**/*"
+  ],
+  "references": [
+    {
+      "path": "../../packages/cli/logger"
+    },
+    {
+      "path": "../../packages/commons/core-utils"
+    },
+  ]
+}

generators/browser-compatible-base/vitest.config.ts

@@ -0,0 +1 @@
+export { default } from "../../shared/vitest.config";

generators/csharp/codegen/package.json

@@ -29,7 +29,7 @@
   "dependencies": {
     "@fern-api/core-utils": "workspace:*",
     "@fern-api/fs-utils": "workspace:*",
-    "@fern-api/generator-commons": "workspace:*",
+    "@fern-api/base-generator": "workspace:*",
     "@fern-api/logging-execa": "workspace:*",
     "@fern-fern/ir-sdk": "^53.18.0",
     "lodash-es": "^4.17.21",

generators/csharp/codegen/src/FileGenerator.ts

@@ -1,7 +1,7 @@
 import { RelativeFilePath } from "@fern-api/fs-utils";
 import { AbstractCsharpGeneratorContext } from "./cli";
 import { BaseCsharpCustomConfigSchema } from "./custom-config";
-import { File } from "@fern-api/generator-commons";
+import { File } from "@fern-api/base-generator";
 
 export abstract class FileGenerator<
     GeneratedFile extends File,

generators/csharp/codegen/src/ast/ClassInstantiation.ts

@@ -1,4 +1,4 @@
-import { Arguments, hasNamedArgument, isNamedArgument } from "@fern-api/generator-commons";
+import { Arguments, hasNamedArgument, isNamedArgument } from "@fern-api/base-generator";
 import { ClassReference } from "./ClassReference";
 import { AstNode } from "./core/AstNode";
 import { Writer } from "./core/Writer";

generators/csharp/codegen/src/ast/CodeBlock.ts

@@ -1,4 +1,4 @@
-import { CodeBlock as CommonCodeBlock } from "@fern-api/generator-commons";
+import { CodeBlock as CommonCodeBlock } from "@fern-api/base-generator";
 import { AstNode, Writer } from "../csharp";
 
 export declare namespace CodeBlock {

generators/csharp/codegen/src/ast/Dictionary.ts

@@ -1,5 +1,5 @@
 import { assertNever } from "@fern-api/core-utils";
-import { UnnamedArgument } from "@fern-api/generator-commons";
+import { UnnamedArgument } from "@fern-api/base-generator";
 import { AstNode } from "./core/AstNode";
 import { Writer } from "./core/Writer";
 import { Type } from "./Type";

generators/csharp/codegen/src/ast/Ternary.ts

@@ -1,4 +1,4 @@
-import { Ternary as CommonTernary } from "@fern-api/generator-commons";
+import { Ternary as CommonTernary } from "@fern-api/base-generator";
 import { AstNode } from "./core/AstNode";
 import { Writer } from "./core/Writer";
 

generators/csharp/codegen/src/ast/core/AstNode.ts

@@ -1,4 +1,4 @@
-import { AbstractAstNode } from "@fern-api/generator-commons";
+import { AbstractAstNode } from "@fern-api/base-generator";
 import { execSync } from "child_process";
 import { BaseCsharpCustomConfigSchema } from "../../custom-config";
 import { Writer } from "./Writer";

generators/csharp/codegen/src/ast/core/Writer.ts

@@ -1,4 +1,4 @@
-import { AbstractWriter } from "@fern-api/generator-commons";
+import { AbstractWriter } from "@fern-api/base-generator";
 import { ClassReference } from "..";
 import { csharp } from "../..";
 import { BaseCsharpCustomConfigSchema } from "../../custom-config";

generators/csharp/codegen/src/cli/AbstractCsharpGeneratorCli.ts

@@ -1,5 +1,5 @@
 import { AbsoluteFilePath } from "@fern-api/fs-utils";
-import { AbstractGeneratorCli, parseIR } from "@fern-api/generator-commons";
+import { AbstractGeneratorCli, parseIR } from "@fern-api/base-generator";
 import { IntermediateRepresentation } from "@fern-fern/ir-sdk/api";
 import * as IrSerialization from "@fern-fern/ir-sdk/serialization";
 import { readFile } from "fs/promises";

generators/csharp/codegen/src/context/AbstractCsharpGeneratorContext.ts

@@ -1,5 +1,5 @@
 import { join, RelativeFilePath } from "@fern-api/fs-utils";
-import { AbstractGeneratorContext, FernGeneratorExec, GeneratorNotificationService } from "@fern-api/generator-commons";
+import { AbstractGeneratorContext, FernGeneratorExec, GeneratorNotificationService } from "@fern-api/base-generator";
 import {
     FernFilepath,
     HttpHeader,

generators/csharp/codegen/src/project/CSharpFile.ts

@@ -3,7 +3,7 @@ import { FernFilepath } from "@fern-fern/ir-sdk/api";
 import path from "path";
 import { Class, Enum, Interface } from "../ast";
 import { BaseCsharpCustomConfigSchema } from "../custom-config";
-import { File } from "@fern-api/generator-commons";
+import { File } from "@fern-api/base-generator";
 
 export type Namespace = string;
 

generators/csharp/codegen/src/project/CsharpProject.ts

@@ -1,5 +1,5 @@
 import { AbsoluteFilePath, join, RelativeFilePath } from "@fern-api/fs-utils";
-import { SourceFetcher, File, AbstractProject, FernGeneratorExec } from "@fern-api/generator-commons";
+import { SourceFetcher, File, AbstractProject, FernGeneratorExec } from "@fern-api/base-generator";
 import { loggingExeca } from "@fern-api/logging-execa";
 import { mkdir, readFile, writeFile } from "fs/promises";
 import { template } from "lodash-es";

generators/csharp/codegen/src/project/PrebuiltUtilities.ts

@@ -1,7 +1,7 @@
 import { AbsoluteFilePath, RelativeFilePath } from "@fern-api/fs-utils";
 import { readFile } from "fs/promises";
 import { Annotation, ClassReference } from "../ast";
-import { File } from "@fern-api/generator-commons";
+import { File } from "@fern-api/base-generator";
 
 export class PrebuiltUtilities {
     private utilitiesDirectory = RelativeFilePath.of("Utilities");

generators/csharp/codegen/tsconfig.json

@@ -6,6 +6,6 @@
     { "path": "../../../packages/commons/core-utils" },
     { "path": "../../../packages/commons/fs-utils" },
     { "path": "../../../packages/commons/logging-execa" },
-    { "path": "../../commons" }
+    { "path": "../../base" }
   ]
 }

generators/csharp/model/package.json

@@ -32,7 +32,7 @@
   "devDependencies": {
     "@fern-api/csharp-codegen": "workspace:*",
     "@fern-api/fs-utils": "workspace:*",
-    "@fern-api/generator-commons": "workspace:*",
+    "@fern-api/base-generator": "workspace:*",
     "@fern-fern/ir-sdk": "^53.18.0",
     "zod": "^3.22.3",
     "@types/jest": "^29.5.12",

generators/csharp/model/src/ModelGeneratorCli.ts

@@ -1,5 +1,5 @@
 import { AbstractCsharpGeneratorCli, validateReadOnlyMemoryTypes } from "@fern-api/csharp-codegen";
-import { FernGeneratorExec, GeneratorNotificationService } from "@fern-api/generator-commons";
+import { FernGeneratorExec, GeneratorNotificationService } from "@fern-api/base-generator";
 import { IntermediateRepresentation } from "@fern-fern/ir-sdk/api";
 import { generateModels } from "./generateModels";
 import { generateWellKnownProtobufFiles } from "./generateWellKnownProtobufFiles";

generators/csharp/model/tsconfig.json

@@ -4,7 +4,7 @@
   "include": ["./src/**/*"],
   "references": [
     { "path": "../../../packages/commons/fs-utils" },
-    { "path": "../../commons" },
+    { "path": "../../base" },
     { "path": "../codegen" }
   ]
 }

generators/csharp/sdk/package.json

@@ -34,7 +34,7 @@
     "@fern-api/csharp-codegen": "workspace:*",
     "@fern-api/fern-csharp-model": "workspace:*",
     "@fern-api/fs-utils": "workspace:*",
-    "@fern-api/generator-commons": "workspace:*",
+    "@fern-api/base-generator": "workspace:*",
     "@fern-api/logger": "workspace:*",
     "@fern-fern/generator-cli-sdk": "0.0.17",
     "@fern-fern/generator-exec-sdk": "^0.0.898",

generators/csharp/sdk/src/CsharpGeneratorAgent.ts

@@ -1,4 +1,4 @@
-import { AbstractGeneratorAgent } from "@fern-api/generator-commons";
+import { AbstractGeneratorAgent } from "@fern-api/base-generator";
 import { Logger } from "@fern-api/logger";
 import { FernGeneratorCli } from "@fern-fern/generator-cli-sdk";
 import { FernGeneratorExec } from "@fern-fern/generator-exec-sdk";