chore(cli): Add @fern-api/path-utils (#5285)

packages/commons/fs-utils/package.json

@@ -28,12 +28,15 @@
   },
   "dependencies": {
     "@fern-api/core-utils": "workspace:*",
+    "@fern-api/path-utils": "workspace:*",
     "glob": "^11.0.0",
     "json-stream-stringify": "^3.1.4",
     "stream-json": "^1.8.0",
     "tmp-promise": "^3.0.3"
   },
   "devDependencies": {
+    "@fern-api/core-utils": "workspace:*",
+    "@fern-api/path-utils": "workspace:*",
     "@types/jest": "^29.5.12",
     "@types/node": "18.7.18",
     "@types/stream-json": "^1.7.7",

packages/commons/fs-utils/src/AbsoluteFilePath.ts

@@ -1,15 +1,3 @@
-import path from "path";
-import { convertToOsPath } from "./osPathConverter";
-
-export type AbsoluteFilePath = string & {
-    __AbsoluteFilePath: void;
-};
-
-export const AbsoluteFilePath = {
-    of: (value: string): AbsoluteFilePath => {
-        if (!path.isAbsolute(value)) {
-            throw new Error("Filepath is not absolute: " + value);
-        }
-        return convertToOsPath(value) as AbsoluteFilePath;
-    }
-};
+// For convenience, we re-export the AbsoluteFilePath type for any caller
+// that requires fs-utils.
+export { AbsoluteFilePath } from "@fern-api/path-utils";

packages/commons/fs-utils/src/RelativeFilePath.ts

@@ -1,15 +1,3 @@
-import path from "path";
-import { convertToOsPath } from "./osPathConverter";
-
-export type RelativeFilePath = string & {
-    __RelativeFilePath: void;
-};
-
-export const RelativeFilePath = {
-    of: (value: string): RelativeFilePath => {
-        if (path.isAbsolute(value)) {
-            throw new Error("Filepath is not relative: " + value);
-        }
-        return convertToOsPath(value) as RelativeFilePath;
-    }
-};
+// For convenience, we re-export the RelativeFilePath type for any caller=
+// that requires fs-utils.
+export { RelativeFilePath } from "@fern-api/path-utils";

packages/commons/fs-utils/src/osPathConverter.ts

@@ -1,13 +1,17 @@
 import { AbsoluteFilePath } from "./AbsoluteFilePath";
 import { RelativeFilePath } from "./RelativeFilePath";
 
-// in this function, we ignore drive paths and roots, since many strings are passed as partial relative paths
-export function convertToOsPath(path: string): string {
-    if (process.platform === "win32") {
-        return path.replace(/\//g, "\\");
-    } else {
-        return path.replace(/\\/g, "/");
-    }
+// For convenience, we re-export the convertToOsPath type for any caller
+// that requires fs-utils.
+export { convertToOsPath } from "@fern-api/path-utils";
+
+export function convertToFernHostAbsoluteFilePath(path: AbsoluteFilePath): AbsoluteFilePath {
+    // Don't use 'of' here, as it will use OS path, we want fern path
+    return convertToFernHostPath(path) as AbsoluteFilePath;
+}
+export function convertToFernHostRelativeFilePath(path: RelativeFilePath): RelativeFilePath {
+    // Don't use 'of' here, as it will use OS path, we want fern path
+    return convertToFernHostPath(path) as RelativeFilePath;
 }
 
 function convertToFernHostPath(path: string): string {
@@ -18,12 +22,3 @@ function convertToFernHostPath(path: string): string {
 
     return unixPath.replace(/\\/g, "/");
 }
-
-export function convertToFernHostAbsoluteFilePath(path: AbsoluteFilePath): AbsoluteFilePath {
-    // Don't use 'of' here, as it will use OS path, we want fern path
-    return convertToFernHostPath(path) as AbsoluteFilePath;
-}
-export function convertToFernHostRelativeFilePath(path: RelativeFilePath): RelativeFilePath {
-    // Don't use 'of' here, as it will use OS path, we want fern path
-    return convertToFernHostPath(path) as RelativeFilePath;
-}

packages/commons/fs-utils/tsconfig.json

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

packages/commons/path-utils/.depcheckrc.json

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

packages/commons/path-utils/.prettierrc.cjs

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

packages/commons/path-utils/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@fern-api/path-utils",
+  "version": "0.0.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/fern-api/fern.git",
+    "directory": "packages/commons/path-utils"
+  },
+  "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"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.12",
+    "depcheck": "^1.4.6",
+    "eslint": "^8.56.0",
+    "organize-imports-cli": "^0.10.0",
+    "prettier": "^2.7.1",
+    "typescript": "4.6.4",
+    "vitest": "^2.0.5"
+  }
+}

packages/commons/path-utils/src/AbsoluteFilePath.ts

@@ -0,0 +1,17 @@
+import { getPathModule } from "./getPathModule";
+import { convertToOsPath } from "./convertToOsPath";
+
+const path = getPathModule();
+
+export type AbsoluteFilePath = string & {
+    __AbsoluteFilePath: void;
+};
+
+export const AbsoluteFilePath = {
+    of: (value: string): AbsoluteFilePath => {
+        if (!path.isAbsolute(value)) {
+            throw new Error("Filepath is not absolute: " + value);
+        }
+        return convertToOsPath(value) as AbsoluteFilePath;
+    }
+};

packages/commons/path-utils/src/RelativeFilePath.ts

@@ -0,0 +1,17 @@
+import { getPathModule } from "./getPathModule";
+import { convertToOsPath } from "./convertToOsPath";
+
+const path = getPathModule();
+
+export type RelativeFilePath = string & {
+    __RelativeFilePath: void;
+};
+
+export const RelativeFilePath = {
+    of: (value: string): RelativeFilePath => {
+        if (path.isAbsolute(value)) {
+            throw new Error("Filepath is not relative: " + value);
+        }
+        return convertToOsPath(value) as RelativeFilePath;
+    }
+};

packages/commons/path-utils/src/convertToOsPath.ts

@@ -0,0 +1,15 @@
+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
+export function convertToOsPath(path: string): string {
+    if (isBrowser()) {
+        return path.replace(/\\/g, "/");
+    }
+    if (process.platform === "win32") {
+        return path.replace(/\//g, "\\");
+    } else {
+        return path.replace(/\\/g, "/");
+    }
+}

packages/commons/path-utils/src/getPathModule.ts

@@ -0,0 +1,14 @@
+import { isBrowser } from "./isBrowser";
+
+// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
+export function getPathModule() {
+    if (isBrowser()) {
+        return {
+            isAbsolute: (value: string): boolean => {
+                return value.startsWith("/");
+            }
+        };
+    } else {
+        return require("path");
+    }
+}

packages/commons/path-utils/src/index.ts

@@ -0,0 +1,3 @@
+export { AbsoluteFilePath } from "./AbsoluteFilePath";
+export { RelativeFilePath } from "./RelativeFilePath";
+export { convertToOsPath } from "./convertToOsPath";

packages/commons/path-utils/src/isBrowser.ts

@@ -0,0 +1,3 @@
+export function isBrowser(): boolean {
+    return typeof window !== "undefined";
+}

packages/commons/path-utils/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "extends": "../../../shared/tsconfig.shared.json",
+  "compilerOptions": {
+    "composite": true,
+    "outDir": "lib",
+    "rootDir": "src"
+  },
+  "include": [
+    "./src/**/*"
+  ],
+}

packages/commons/path-utils/vitest.config.ts

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