chore(cli): @fern-api/ir-generator uses @fern-api/path-utils (#5299)

fern-api · Dec 1, 2024 · d6a7822 · d6a7822
1 parent edc2457
commit d6a7822
Show file tree

Hide file tree

Showing 15 changed files with 31 additions and 29 deletions.
diff --git a/packages/cli/generation/ir-generator/package.json b/packages/cli/generation/ir-generator/package.json
@@ -32,7 +32,7 @@
     "@fern-api/configuration": "workspace:*",
     "@fern-api/core-utils": "workspace:*",
     "@fern-api/fern-definition-schema": "workspace:*",
-    "@fern-api/fs-utils": "workspace:*",
+    "@fern-api/path-utils": "workspace:*",
     "@fern-api/ir-sdk": "workspace:*",
     "@fern-api/source-resolver": "workspace:*",
     "@fern-api/task-context": "workspace:*",
@@ -43,7 +43,6 @@
   },
   "devDependencies": {
     "@types/lodash-es": "^4.17.12",
-    "@types/node": "18.7.18",
     "@types/object-hash": "^3.0.6",
     "@types/prettier": "^2.7.1",
     "@types/url-join": "4.0.1",

diff --git a/packages/cli/generation/ir-generator/src/FernFileContext.ts b/packages/cli/generation/ir-generator/src/FernFileContext.ts
@@ -1,4 +1,4 @@
-import { RelativeFilePath } from "@fern-api/fs-utils";
+import { RelativeFilePath } from "@fern-api/path-utils";
 import { FernFilepath, TypeReference } from "@fern-api/ir-sdk";
 import { DefinitionFileSchema, RawSchemas, RootApiFileSchema } from "@fern-api/fern-definition-schema";
 import { mapValues } from "lodash-es";

diff --git a/packages/cli/generation/ir-generator/src/generateIntermediateRepresentation.ts b/packages/cli/generation/ir-generator/src/generateIntermediateRepresentation.ts
@@ -1,6 +1,6 @@
 import { Audiences, FERN_PACKAGE_MARKER_FILENAME, generatorsYml } from "@fern-api/configuration";
 import { noop, visitObject } from "@fern-api/core-utils";
-import { dirname, join, RelativeFilePath } from "@fern-api/fs-utils";
+import { dirname, join, RelativeFilePath } from "@fern-api/path-utils";
 import {
     ExampleType,
     HttpEndpoint,
@@ -45,7 +45,7 @@ import { ExampleResolverImpl } from "./resolvers/ExampleResolver";
 import { PropertyResolverImpl } from "./resolvers/PropertyResolver";
 import { TypeResolverImpl } from "./resolvers/TypeResolver";
 import { VariableResolverImpl } from "./resolvers/VariableResolver";
-import { SourceResolver, NopSourceResolver } from "@fern-api/source-resolver";
+import { SourceResolver } from "@fern-api/source-resolver";
 import { convertToFernFilepath } from "./utils/convertToFernFilepath";
 import { getAudienceForEnvironment } from "./utils/getEnvironmentsByAudience";
 import { isGeneric } from "@fern-api/fern-definition-schema";

diff --git a/packages/cli/generation/ir-generator/src/resolvers/ResolvedType.ts b/packages/cli/generation/ir-generator/src/resolvers/ResolvedType.ts
@@ -1,4 +1,4 @@
-import { RelativeFilePath } from "@fern-api/fs-utils";
+import { RelativeFilePath } from "@fern-api/path-utils";
 import { DeclaredTypeName, Literal as IrLiteral, PrimitiveType, TypeReference } from "@fern-api/ir-sdk";
 import { RawSchemas } from "@fern-api/fern-definition-schema";
 import { FernFileContext } from "../FernFileContext";

diff --git a/packages/cli/generation/ir-generator/src/utils/convertToFernFilepath.ts b/packages/cli/generation/ir-generator/src/utils/convertToFernFilepath.ts
@@ -1,7 +1,6 @@
-import { FERN_PACKAGE_MARKER_FILENAME } from "@fern-api/configuration";
-import { dirname, RelativeFilePath } from "@fern-api/fs-utils";
+import { FERN_PACKAGE_MARKER_FILENAME_NO_EXTENSION } from "@fern-api/configuration";
+import { basename, dirname, RelativeFilePath, sep } from "@fern-api/path-utils";
 import { FernFilepath } from "@fern-api/ir-sdk";
-import path, { basename } from "path";
 import { CasingsGenerator } from "../casings/CasingsGenerator";
 
 export function convertToFernFilepath({
@@ -12,15 +11,13 @@ export function convertToFernFilepath({
     casingsGenerator: CasingsGenerator;
 }): FernFilepath {
     const pathToPackage = dirname(relativeFilepath);
-    const filename = basename(relativeFilepath);
+    const filename = basename(relativeFilepath, { stripExtension: true });
 
     const packagePath =
-        pathToPackage === "." ? [] : pathToPackage.split(path.sep).map((part) => casingsGenerator.generateName(part));
+        pathToPackage === "." ? [] : pathToPackage.split(sep).map((part) => casingsGenerator.generateName(part));
 
     const file =
-        filename !== FERN_PACKAGE_MARKER_FILENAME
-            ? casingsGenerator.generateName(path.parse(filename).name)
-            : undefined;
+        filename !== FERN_PACKAGE_MARKER_FILENAME_NO_EXTENSION ? casingsGenerator.generateName(filename) : undefined;
 
     const allParts = [];
     allParts.push(...packagePath);

diff --git a/packages/cli/generation/ir-generator/src/utils/getAllPropertiesForObject.ts b/packages/cli/generation/ir-generator/src/utils/getAllPropertiesForObject.ts
@@ -1,4 +1,4 @@
-import { RelativeFilePath } from "@fern-api/fs-utils";
+import { RelativeFilePath } from "@fern-api/path-utils";
 import { FernWorkspace, getDefinitionFile } from "@fern-api/api-workspace-commons";
 import { isRawObjectDefinition, RawSchemas } from "@fern-api/fern-definition-schema";
 import { constructCasingsGenerator } from "../casings/CasingsGenerator";

diff --git a/packages/cli/generation/ir-generator/src/utils/getResolvedPathOfImportedFile.ts b/packages/cli/generation/ir-generator/src/utils/getResolvedPathOfImportedFile.ts
@@ -1,4 +1,4 @@
-import { dirname, join, RelativeFilePath } from "@fern-api/fs-utils";
+import { dirname, join, RelativeFilePath } from "@fern-api/path-utils";
 
 export function getResolvedPathOfImportedFile({
     referencedIn,

diff --git a/packages/cli/generation/ir-generator/src/utils/parseReferenceToEndpointName.ts b/packages/cli/generation/ir-generator/src/utils/parseReferenceToEndpointName.ts
@@ -1,4 +1,4 @@
-import { RelativeFilePath } from "@fern-api/fs-utils";
+import { RelativeFilePath } from "@fern-api/path-utils";
 import { getResolvedPathOfImportedFile } from "./getResolvedPathOfImportedFile";
 
 export interface ReferenceToEndpointName {

diff --git a/packages/cli/generation/ir-generator/src/utils/parseReferenceToTypeName.ts b/packages/cli/generation/ir-generator/src/utils/parseReferenceToTypeName.ts
@@ -1,4 +1,4 @@
-import { RelativeFilePath } from "@fern-api/fs-utils";
+import { RelativeFilePath } from "@fern-api/path-utils";
 import { getResolvedPathOfImportedFile } from "./getResolvedPathOfImportedFile";
 
 export interface ReferenceToTypeName {

diff --git a/packages/cli/generation/ir-generator/tsconfig.json b/packages/cli/generation/ir-generator/tsconfig.json
@@ -13,7 +13,7 @@
       "path": "../../../commons/core-utils"
     },
     {
-      "path": "../../../commons/fs-utils"
+      "path": "../../../commons/path-utils"
     },
     {
       "path": "../../../ir-sdk"

diff --git a/packages/commons/path-utils/src/basename.ts b/packages/commons/path-utils/src/basename.ts
@@ -1,3 +1,7 @@
-export function basename(path: string): string {
-    return path.split("/").pop() ?? "";
+export function basename(path: string, options?: { stripExtension?: boolean }): string {
+    const basename = path.split("/").pop() ?? path;
+    if (options?.stripExtension) {
+        return basename.split(".")[0] ?? basename;
+    }
+    return basename;
 }
diff --git a/packages/commons/path-utils/src/getPathModule.ts b/packages/commons/path-utils/src/getPathModule.ts
@@ -1,7 +1,10 @@
 import { isBrowser } from "./isBrowser";
 
-// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
-export function getPathModule() {
+export interface PathModule {
+    isAbsolute: (value: string) => boolean;
+}
+
+export function getPathModule(): PathModule {
     if (isBrowser()) {
         return {
             isAbsolute: (value: string): boolean => {

diff --git a/packages/commons/path-utils/src/index.ts b/packages/commons/path-utils/src/index.ts
@@ -4,3 +4,4 @@ export { basename } from "./basename";
 export { convertToOsPath } from "./convertToOsPath";
 export { dirname } from "./dirname";
 export { join } from "./join";
+export { sep } from "./sep";
diff --git a/packages/commons/path-utils/src/sep.ts b/packages/commons/path-utils/src/sep.ts
@@ -0,0 +1 @@
+export const sep = "/";
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml