chore: Update function params as interfaces for reusability

src/commands/setup/index.ts

@@ -40,7 +40,7 @@ export const setupCommand = () => {
           'will not be touched by default. Use --override to re-create them.',
       );
       log.info('Creating initial files for DEMS...');
-      createPath(cliConfig.root);
+      createPath({ path: cliConfig.root });
       createFile({ file: cliConfig.file, content: JSON.stringify(cliConfig) });
       createFile({
         file: cliConfig.currentProjectFile,
@@ -131,13 +131,13 @@ export const setupCommand = () => {
         }
 
         fs.writeFileSync(cliConfig.currentProjectFile, currentProject);
-        createPath(`${projectRootPath}`);
+        createPath({ path: projectRootPath });
         createFile({
           file: `${projectRootPath}/config.json`,
           content: JSON.stringify(config, null, 2),
           override: confirmOverride,
         });
-        createPath(dataPath);
+        createPath({ path: dataPath });
         dotEnv.generate(dotEnvFile, config);
       }
     });

src/config/env.ts

@@ -1,5 +1,5 @@
 import fs from 'fs';
-import log from '../utils/log.js';
+import log from '../utils/log';
 import { flattenObject } from '../utils/object';
 import { type DEMSProjectConfig } from './dems';
 

src/utils/compose.ts

@@ -1,15 +1,12 @@
 import fs from 'node:fs';
 import path from 'path';
+import type { ComposeFilesParams } from './interfaces';
 
 export const composeFiles = ({
   prefix = 'compose',
   filesDir = 'src/compose',
   dockerDir = '.docker',
-}: {
-  prefix?: string;
-  filesDir?: string;
-  dockerDir?: string;
-} = {}): string => {
+}: ComposeFilesParams): string => {
   let composeFileString = '';
 
   const readFilesRecursively = (currentDir: string) => {

src/utils/file-system.ts

@@ -1,5 +1,10 @@
 import fs from 'node:fs';
 import { confirm } from '@inquirer/prompts';
+import type {
+  FileModificationOperation,
+  PathModificationOperation,
+  SourceTargetOperation,
+} from './interfaces';
 import log from './log';
 
 export const isFile = (path: string): boolean => {
@@ -10,39 +15,32 @@ export const isDirectory = (path: string): boolean => {
   return fs.existsSync(path) && fs.lstatSync(path).isDirectory();
 };
 
-export const copyFile = (
-  source: string,
-  target: string,
-  output = true,
-): void => {
+export const copyFile = ({
+  source,
+  target,
+  verbose = true,
+}: SourceTargetOperation) => {
   if (isFile(target)) {
-    if (output) log.warning(`Path: ${target} already exists.`);
+    if (verbose) log.warning(`Path: ${target} already exists.`);
     return;
   }
 
   if (isFile(source)) {
     fs.copyFileSync(source, target, 0);
-    if (output)
+    if (verbose)
       log.success(`File: ${source} successfully copied to ${target}.`);
   } else {
-    if (output) log.error('Source is not a valid file.');
+    if (verbose) log.error('Source is not a valid file.');
     process.exit(1);
   }
 };
 
-interface FileModificiationInput {
-  file: string;
-  content: string;
-  verbose?: boolean;
-  override?: boolean;
-}
-
 export const createFile = ({
   file,
   content,
   verbose = true,
   override = false,
-}: FileModificiationInput): void => {
+}: FileModificationOperation) => {
   if (!isFile(file) || override) {
     if (verbose) log.info(`Creating file: ${file}...`);
     fs.writeFileSync(file, content, 'utf8');
@@ -52,7 +50,10 @@ export const createFile = ({
   }
 };
 
-export const createPath = (path: string, verbose = true): void => {
+export const createPath = ({
+  path,
+  verbose = true,
+}: PathModificationOperation) => {
   if (!fs.existsSync(path)) {
     if (verbose) log.info(`Creating path: ${path}...`);
     fs.mkdirSync(path, { recursive: true });
@@ -62,17 +63,11 @@ export const createPath = (path: string, verbose = true): void => {
   }
 };
 
-interface PathDeletionParams {
-  path: string;
-  force?: boolean;
-  verbose?: boolean;
-}
-
 export const deletePath = async ({
   path,
   force = false,
   verbose = true,
-}: PathDeletionParams) => {
+}: PathModificationOperation) => {
   if (isDirectory(path)) {
     if (
       force ||

src/utils/git.ts

@@ -1,12 +1,6 @@
-import fs from 'node:fs';
-import { createPath } from './file-system.js';
-import log from './log.js';
-
-type GitParams = {
-  workingDir: string;
-  repo: string;
-  ref: string;
-};
+import { createPath, isDirectory } from './file-system';
+import type { GitParams } from './interfaces';
+import log from './log';
 
 export default class Git {
   repoUrl: string;
@@ -21,7 +15,7 @@ export default class Git {
 
   clone({ workingDir, repo, ref }: GitParams) {
     this.remoteRepoExists(repo);
-    createPath(workingDir, false);
+    createPath({ path: workingDir, verbose: false });
     if (this.localRepoExists(this.repoPath)) {
       log.warning(`Repo ${repo} already cloned.`);
     } else {
@@ -44,10 +38,7 @@ export default class Git {
   }
 
   localRepoExists(path: string) {
-    return (
-      fs.existsSync(`${path}/.git`) &&
-      fs.lstatSync(`${path}/.git`).isDirectory()
-    );
+    return isDirectory(`${path}/.git`);
   }
 
   remoteRepoExists(repo: string = this.repoUrl, verbose = false) {

src/utils/interfaces.ts

@@ -0,0 +1,30 @@
+export interface SourceTargetOperation {
+  source: string;
+  target: string;
+  verbose?: boolean;
+}
+
+export interface FileModificationOperation {
+  file: string;
+  content: string;
+  verbose?: boolean;
+  override?: boolean;
+}
+
+export interface PathModificationOperation {
+  path: string;
+  force?: boolean;
+  verbose?: boolean;
+}
+
+export interface GitParams {
+  workingDir: string;
+  repo: string;
+  ref: string;
+}
+
+export interface ComposeFilesParams {
+  prefix?: string;
+  filesDir?: string;
+  dockerDir?: string;
+}

src/utils/object.ts

@@ -1,6 +1,6 @@
 import fs from 'node:fs';
-import { isFile } from './file-system.js';
-import log from './log.js';
+import { isFile } from './file-system';
+import log from './log';
 
 export const flattenObject = (
   // biome-ignore lint/suspicious/noExplicitAny:
@@ -79,9 +79,7 @@ export const replaceKeysInFile = (
     }
     fs.writeFileSync(filePath, updatedContent);
     if (verbose)
-      log.success(
-        `File ${filePath} updated successfully with replacements.`,
-      );
+      log.success(`File ${filePath} updated successfully with replacements.`);
   } catch (error) {
     if (verbose)
       log.error(`Error updating file ${filePath}. See below for more info:`);

test/utils/file-system.test.ts

@@ -36,7 +36,7 @@ describe('Utils: file-system', () => {
     // Create and copy file with createFile() and copyFile()
     createFile({ file: file, content: content, verbose: false });
     expect(isFile(file)).toBeTrue();
-    copyFile(file, copiedFile, false);
+    copyFile({ source: file, target: copiedFile, verbose: false });
     expect(isFile(copiedFile)).toBeTrue();
 
     // Ensure files are deleted