Refactor fs and path helpers in renderers core (#787)

Author: lorisleiva

.changeset/eager-bottles-pull.md

@@ -0,0 +1,5 @@
+---
+'@codama/renderers-core': minor
+---
+
+Add new path helpers and refactor fs helpers.

packages/renderers-core/README.md

@@ -34,7 +34,7 @@ deleteDirectory(directoryPath);
 
 // Creates a new file at the given path with the given content.
 // Creates its parent directory, recursively, if it does not exist.
-createFile(filePath, content);
+writeFile(filePath, content);
 ```
 
 ## Render maps

packages/renderers-core/src/RenderMap.ts

@@ -1,6 +1,6 @@
 import { CODAMA_ERROR__VISITORS__RENDER_MAP_KEY_NOT_FOUND, CodamaError } from '@codama/errors';
 
-import { createFile } from './fs';
+import { writeFile } from './fs';
 
 export class RenderMap {
     protected readonly _map: Map<string, string> = new Map();
@@ -67,7 +67,7 @@ export class RenderMap {
 
     write(path: string): void {
         this._map.forEach((code, relativePath) => {
-            createFile(`${path}/${relativePath}`, code);
+            writeFile(`${path}/${relativePath}`, code);
         });
     }
 }

packages/renderers-core/src/fs.ts

@@ -2,23 +2,17 @@ import { existsSync, mkdirSync, readFileSync, rmSync, writeFileSync } from 'node
 
 import { CODAMA_ERROR__NODE_FILESYSTEM_FUNCTION_UNAVAILABLE, CodamaError } from '@codama/errors';
 
-export function readJson<T extends object>(value: string): T {
-    if (!__NODEJS__) {
-        throw new CodamaError(CODAMA_ERROR__NODE_FILESYSTEM_FUNCTION_UNAVAILABLE, { fsFunction: 'readFileSync' });
-    }
+import { Path, pathDirectory } from './path';
 
-    return JSON.parse(readFileSync(value, 'utf-8')) as T;
-}
-
-export const createDirectory = (path: string): void => {
+export const createDirectory = (path: Path): void => {
     if (!__NODEJS__) {
         throw new CodamaError(CODAMA_ERROR__NODE_FILESYSTEM_FUNCTION_UNAVAILABLE, { fsFunction: 'mkdirSync' });
     }
 
     mkdirSync(path, { recursive: true });
 };
 
-export const deleteDirectory = (path: string): void => {
+export const deleteDirectory = (path: Path): void => {
     if (!__NODEJS__) {
         throw new CodamaError(CODAMA_ERROR__NODE_FILESYSTEM_FUNCTION_UNAVAILABLE, { fsFunction: 'rmSync' });
     }
@@ -28,14 +22,26 @@ export const deleteDirectory = (path: string): void => {
     }
 };
 
-export const createFile = (path: string, content: string): void => {
+export const writeFile = (path: Path, content: string): void => {
     if (!__NODEJS__) {
         throw new CodamaError(CODAMA_ERROR__NODE_FILESYSTEM_FUNCTION_UNAVAILABLE, { fsFunction: 'writeFileSync' });
     }
 
-    const directory = path.substring(0, path.lastIndexOf('/'));
+    const directory = pathDirectory(path);
     if (!existsSync(directory)) {
         createDirectory(directory);
     }
     writeFileSync(path, content);
 };
+
+export function readFile(path: Path): string {
+    if (!__NODEJS__) {
+        throw new CodamaError(CODAMA_ERROR__NODE_FILESYSTEM_FUNCTION_UNAVAILABLE, { fsFunction: 'readFileSync' });
+    }
+
+    return readFileSync(path, 'utf-8');
+}
+
+export function readJson<T>(path: Path): T {
+    return JSON.parse(readFile(path)) as T;
+}

packages/renderers-core/src/index.ts

@@ -1,3 +1,4 @@
 export * from './fs';
-export * from './RenderMap';
+export * from './path';
+export * from './renderMap';
 export * from './writeRenderMapVisitor';

packages/renderers-core/src/path.ts

@@ -0,0 +1,19 @@
+import { dirname, join } from 'node:path';
+
+export type Path = string;
+
+export function joinPath(...paths: Path[]): string {
+    if (!__NODEJS__) {
+        return paths.join('/').replace(/\/+/g, '/');
+    }
+
+    return join(...paths);
+}
+
+export function pathDirectory(path: Path): Path {
+    if (!__NODEJS__) {
+        return path.substring(0, path.lastIndexOf('/'));
+    }
+
+    return dirname(path);
+}

packages/renderers-core/src/writeRenderMapVisitor.ts

@@ -1,7 +1,7 @@
 import { NodeKind } from '@codama/nodes';
 import { mapVisitor, Visitor } from '@codama/visitors-core';
 
-import { RenderMap } from './RenderMap';
+import { RenderMap } from './renderMap';
 
 export function writeRenderMapVisitor<TNodeKind extends NodeKind = NodeKind>(
     visitor: Visitor<RenderMap, TNodeKind>,

packages/renderers-core/test/fs.test.ts

@@ -1,7 +1,7 @@
 import { CODAMA_ERROR__NODE_FILESYSTEM_FUNCTION_UNAVAILABLE, CodamaError } from '@codama/errors';
 import { expect, test } from 'vitest';
 
-import { createDirectory, createFile, deleteDirectory, readJson } from '../src';
+import { createDirectory, deleteDirectory, readJson, writeFile } from '../src';
 
 if (__NODEJS__) {
     test('it reads JSON objects from files', () => {
@@ -24,8 +24,8 @@ if (__NODEJS__) {
             new CodamaError(CODAMA_ERROR__NODE_FILESYSTEM_FUNCTION_UNAVAILABLE, { fsFunction: 'rmSync' }),
         );
     });
-    test('it fails to call createFile', () => {
-        expect(() => createFile('./path', 'content')).toThrow(
+    test('it fails to call writeFile', () => {
+        expect(() => writeFile('./path', 'content')).toThrow(
             new CodamaError(CODAMA_ERROR__NODE_FILESYSTEM_FUNCTION_UNAVAILABLE, { fsFunction: 'writeFileSync' }),
         );
     });

packages/renderers-core/test/path.test.ts

@@ -0,0 +1,13 @@
+import { expect, test } from 'vitest';
+
+import { joinPath, pathDirectory } from '../src';
+
+test('it joins path together', () => {
+    const result = joinPath('foo', 'bar', 'baz');
+    expect(result).toEqual('foo/bar/baz');
+});
+
+test('it gets the directory of a path', () => {
+    const result = pathDirectory('foo/bar/baz');
+    expect(result).toEqual('foo/bar');
+});