chore(cli): @fern-api/api-workspace-commons is browser compatible (#5294

)
fern-api · Nov 27, 2024 · ad26104 · ad26104
1 parent b6bd0d3
commit ad26104
Show file tree

Hide file tree

Showing 22 changed files with 66 additions and 38 deletions.
diff --git a/generators/browser-compatible-base/src/utils/getBasename.ts b/generators/browser-compatible-base/src/utils/getBasename.ts
diff --git a/generators/browser-compatible-base/src/utils/index.ts b/generators/browser-compatible-base/src/utils/index.ts
@@ -1,3 +1,2 @@
-export { getBasename } from "./getBasename";
 export { getPackageName } from "./getPackageName";
 export { getSdkVersion } from "./getSdkVersion";
diff --git a/generators/go-v2/ast/src/ast/core/Writer.ts b/generators/go-v2/ast/src/ast/core/Writer.ts
@@ -1,10 +1,6 @@
-import {
-    AbstractFormatter,
-    AbstractWriter,
-    getBasename,
-    NopFormatter
-} from "@fern-api/browser-compatible-base-generator";
+import { AbstractFormatter, AbstractWriter, NopFormatter } from "@fern-api/browser-compatible-base-generator";
 import { BaseGoCustomConfigSchema } from "../../custom-config/BaseGoCustomConfigSchema";
+import { basename } from "@fern-api/path-utils";
 
 type Alias = string;
 type ImportPath = string;
@@ -62,7 +58,7 @@ export class Writer extends AbstractWriter {
         if (maybeAlias != null) {
             return maybeAlias;
         }
-        let alias = this.getValidAlias(getBasename(importPath));
+        let alias = this.getValidAlias(basename(importPath));
         while (alias in this.imports) {
             alias = "_" + alias;
         }

diff --git a/generators/go-v2/ast/src/custom-config/resolveRootImportPath.ts b/generators/go-v2/ast/src/custom-config/resolveRootImportPath.ts
@@ -1,4 +1,5 @@
-import { FernGeneratorExec, getBasename } from "@fern-api/browser-compatible-base-generator";
+import { FernGeneratorExec } from "@fern-api/browser-compatible-base-generator";
+import { basename } from "@fern-api/path-utils";
 import { BaseGoCustomConfigSchema } from "./BaseGoCustomConfigSchema";
 
 const DEFAULT_MODULE_PATH = "sdk";
@@ -64,7 +65,7 @@ function maybeAppendMajorVersionSuffix({
     importPath: string;
     majorVersion: string;
 }): string {
-    if (getBasename(importPath) === majorVersion) {
+    if (basename(importPath) === majorVersion) {
         return importPath;
     }
     return `${importPath}/${majorVersion}`;

diff --git a/packages/cli/workspace-commons/package.json b/packages/cli/workspace-commons/package.json
@@ -30,15 +30,14 @@
   "dependencies": {
     "@fern-api/configuration": "workspace:*",
     "@fern-api/core-utils": "workspace:*",
-    "@fern-api/fs-utils": "workspace:*",
+    "@fern-api/path-utils": "workspace:*",
     "@fern-api/task-context": "workspace:*",
     "@fern-api/fern-definition-schema": "workspace:*",
     "lodash-es": "^4.17.21"
   },
   "devDependencies": {
     "@types/jest": "^29.5.12",
     "@types/lodash-es": "^4.17.12",
-    "@types/node": "18.7.18",
     "depcheck": "^1.4.6",
     "eslint": "^8.56.0",
     "vitest": "^2.1.4",

diff --git a/packages/cli/workspace-commons/src/APIChangelog.ts b/packages/cli/workspace-commons/src/APIChangelog.ts
@@ -1,4 +1,4 @@
-import { AbsoluteFilePath } from "@fern-api/fs-utils";
+import { AbsoluteFilePath } from "@fern-api/path-utils";
 
 export interface APIChangelog {
     files: ChangelogFile[];

diff --git a/packages/cli/workspace-commons/src/AbstractAPIWorkspace.ts b/packages/cli/workspace-commons/src/AbstractAPIWorkspace.ts
@@ -1,6 +1,6 @@
 import { TaskContext } from "@fern-api/task-context";
 import { generatorsYml } from "@fern-api/configuration";
-import { AbsoluteFilePath, RelativeFilePath } from "@fern-api/fs-utils";
+import { AbsoluteFilePath, RelativeFilePath } from "@fern-api/path-utils";
 import { ParsedFernFile } from "./FernFile";
 import { DefinitionFileSchema, PackageMarkerFileSchema, RootApiFileSchema } from "@fern-api/fern-definition-schema";
 import { FernWorkspace } from "./FernWorkspace";

diff --git a/packages/cli/workspace-commons/src/FernFile.ts b/packages/cli/workspace-commons/src/FernFile.ts
@@ -1,4 +1,4 @@
-import { AbsoluteFilePath, RelativeFilePath } from "@fern-api/fs-utils";
+import { AbsoluteFilePath, RelativeFilePath } from "@fern-api/path-utils";
 
 export interface FernFile {
     relativeFilepath: RelativeFilePath;

diff --git a/packages/cli/workspace-commons/src/FernWorkspace.ts b/packages/cli/workspace-commons/src/FernWorkspace.ts
@@ -1,5 +1,5 @@
 import { dependenciesYml } from "@fern-api/configuration";
-import { AbsoluteFilePath } from "@fern-api/fs-utils";
+import { AbsoluteFilePath } from "@fern-api/path-utils";
 import { AbstractAPIWorkspace, FernDefinition } from "./AbstractAPIWorkspace";
 
 export declare namespace FernWorkspace {

diff --git a/packages/cli/workspace-commons/src/utils/getAllDefinitionFiles.ts b/packages/cli/workspace-commons/src/utils/getAllDefinitionFiles.ts
@@ -1,4 +1,4 @@
-import { RelativeFilePath } from "@fern-api/fs-utils";
+import { RelativeFilePath } from "@fern-api/path-utils";
 import { DefinitionFileSchema } from "@fern-api/fern-definition-schema";
 import { ParsedFernFile } from "../FernFile";
 import { FernDefinition } from "../AbstractAPIWorkspace";

diff --git a/packages/cli/workspace-commons/src/utils/getAllNamedDefinitionFiles.ts b/packages/cli/workspace-commons/src/utils/getAllNamedDefinitionFiles.ts
@@ -1,5 +1,5 @@
 import { entries } from "@fern-api/core-utils";
-import { join, RelativeFilePath } from "@fern-api/fs-utils";
+import { join, RelativeFilePath } from "@fern-api/path-utils";
 import { DefinitionFileSchema } from "@fern-api/fern-definition-schema";
 import { mapKeys } from "lodash-es";
 import { ParsedFernFile } from "../FernFile";

diff --git a/packages/cli/workspace-commons/src/utils/getAllPackageMarkers.ts b/packages/cli/workspace-commons/src/utils/getAllPackageMarkers.ts
@@ -1,5 +1,5 @@
 import { entries } from "@fern-api/core-utils";
-import { join, RelativeFilePath } from "@fern-api/fs-utils";
+import { join, RelativeFilePath } from "@fern-api/path-utils";
 import { PackageMarkerFileSchema } from "@fern-api/fern-definition-schema";
 import { mapKeys } from "lodash-es";
 import { ParsedFernFile } from "../FernFile";

diff --git a/packages/cli/workspace-commons/src/utils/getDefinitionFile.ts b/packages/cli/workspace-commons/src/utils/getDefinitionFile.ts
@@ -1,4 +1,4 @@
-import { RelativeFilePath } from "@fern-api/fs-utils";
+import { RelativeFilePath } from "@fern-api/path-utils";
 import { DefinitionFileSchema } from "@fern-api/fern-definition-schema";
 import { FernWorkspace } from "../FernWorkspace";
 import { getAllDefinitionFiles } from "./getAllDefinitionFiles";

diff --git a/packages/cli/workspace-commons/src/utils/visitAllDefinitionFiles.ts b/packages/cli/workspace-commons/src/utils/visitAllDefinitionFiles.ts
@@ -1,6 +1,6 @@
 import { FERN_PACKAGE_MARKER_FILENAME } from "@fern-api/configuration";
 import { entries } from "@fern-api/core-utils";
-import { RelativeFilePath } from "@fern-api/fs-utils";
+import { RelativeFilePath } from "@fern-api/path-utils";
 import { DefinitionFileSchema } from "@fern-api/fern-definition-schema";
 import path from "path";
 import { FernWorkspace } from "../FernWorkspace";

diff --git a/packages/cli/workspace-commons/src/utils/visitAllPackageMarkers.ts b/packages/cli/workspace-commons/src/utils/visitAllPackageMarkers.ts
@@ -1,5 +1,5 @@
 import { entries } from "@fern-api/core-utils";
-import { RelativeFilePath } from "@fern-api/fs-utils";
+import { RelativeFilePath } from "@fern-api/path-utils";
 import { PackageMarkerFileSchema } from "@fern-api/fern-definition-schema";
 import { FernWorkspace } from "../FernWorkspace";
 import { getAllPackageMarkers } from "./getAllPackageMarkers";

diff --git a/packages/cli/workspace-commons/tsconfig.json b/packages/cli/workspace-commons/tsconfig.json
@@ -3,7 +3,7 @@
   "compilerOptions": { "composite": true, "outDir": "lib", "rootDir": "src" },
   "include": ["./src/**/*"],
   "references": [
-    { "path": "../../commons/fs-utils" },
+    { "path": "../../commons/path-utils" },
     { "path": "../configuration" },
     { "path": "../logger" },
     { "path": "../task-context" },

diff --git a/packages/commons/path-utils/src/basename.ts b/packages/commons/path-utils/src/basename.ts
@@ -0,0 +1,3 @@
+export function basename(path: string): string {
+    return path.split("/").pop() ?? "";
+}
diff --git a/packages/commons/path-utils/src/convertToOsPath.ts b/packages/commons/path-utils/src/convertToOsPath.ts
@@ -1,5 +1,3 @@
-import { AbsoluteFilePath } from "./AbsoluteFilePath";
-import { RelativeFilePath } from "./RelativeFilePath";
 import { isBrowser } from "./isBrowser";
 
 // in this function, we ignore drive paths and roots, since many strings are passed as partial relative paths

diff --git a/packages/commons/path-utils/src/dirname.ts b/packages/commons/path-utils/src/dirname.ts
@@ -0,0 +1,16 @@
+import { AbsoluteFilePath } from "./AbsoluteFilePath";
+import { RelativeFilePath } from "./RelativeFilePath";
+
+export function dirname(filepath: RelativeFilePath): RelativeFilePath;
+export function dirname(filepath: AbsoluteFilePath): AbsoluteFilePath;
+export function dirname(filepath: string): string {
+    const trimmed = filepath.replace(/\/+$/, "");
+    const lastSlashIndex = trimmed.lastIndexOf("/");
+    if (lastSlashIndex === -1) {
+        return ".";
+    }
+    if (lastSlashIndex === 0) {
+        return "/";
+    }
+    return filepath.slice(0, lastSlashIndex);
+}
diff --git a/packages/commons/path-utils/src/index.ts b/packages/commons/path-utils/src/index.ts
@@ -1,3 +1,6 @@
 export { AbsoluteFilePath } from "./AbsoluteFilePath";
 export { RelativeFilePath } from "./RelativeFilePath";
+export { basename } from "./basename";
 export { convertToOsPath } from "./convertToOsPath";
+export { dirname } from "./dirname";
+export { join } from "./join";
diff --git a/packages/commons/path-utils/src/join.ts b/packages/commons/path-utils/src/join.ts
@@ -0,0 +1,24 @@
+import { AbsoluteFilePath } from "./AbsoluteFilePath";
+import { RelativeFilePath } from "./RelativeFilePath";
+
+export function join(first: RelativeFilePath, ...parts: RelativeFilePath[]): RelativeFilePath;
+export function join(first: AbsoluteFilePath, ...parts: RelativeFilePath[]): AbsoluteFilePath;
+export function join(...parts: RelativeFilePath[]): RelativeFilePath;
+export function join(...parts: string[]): string {
+    const stack: string[] = [];
+    for (const part of parts.flatMap((segment) => segment.split("/")).filter(Boolean)) {
+        if (part === "." || part === "") {
+            continue;
+        }
+        if (part === "..") {
+            if (stack.length > 0 && stack[stack.length - 1] !== "..") {
+                stack.pop();
+            } else {
+                stack.push(part);
+            }
+        } else {
+            stack.push(part);
+        }
+    }
+    return (parts[0]?.startsWith("/") ? "/" : "") + stack.join("/");
+}
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml