Utility functions for working with files.

files.ts

/**
 * This file contains utility functions for working with your project files.
 *
 * @link https://nodejs.dev/en/learn/nodejs-file-paths/
 *
 * @author Davey Jacobson <daveyjake21 [at] geemail [dot] com>
 * @version 1.0.0
 */

import fs from 'fs';

/**
 * Check if a file exists in the OneRack filesystem.
 *
 * @since 1.0.0
 *
 * @param filename Full path with extension for files or no trailing
 *                 slash if checking for a directory.
 *
 * @returns TRUE if found. FALSE if not.
 */
function fileExists( filename: string ): boolean {
  const stats = fs.statSync( filename );
  
  if ( stats.isFile() || stats.isDirectory() ) {
    return true;
  }

  return false;
}

/**
 * Get files from directory.
 *
 * @since 1.0.0
 *
 * @param directory Full path to directory containing files we need.
 *
 * @returns Array of filenames with extension if successful. Original
 *          `directory` argument if not.
 */
function getFiles( directory: string ): Array<string> | string {
  const stats = fs.statSync( directory );
  
  if ( ! stats.isDirectory() ) {
    console.warn( `${ directory } is a directory!` );
    return directory;
  }
   
  return fs.readdirSync( directory, { withFileTypes: true }).filter( item => ! item.isDirectory() ).map( item => item.name );
}

/**
 * Get file content.
 *
 * @since 1.0.0
 *
 * @see fileExists()
 *
 * @param fileName Full path to file to get contents from.
 *
 * @returns Stringified data if successful. FALSE if not.
 */
function getFileContent( fileName: string ): string | boolean {
  // If file doesn't exists, return false.
  if ( ! fileExists( fileName ) ) {
    return false;
  }

  const final = { content: '' };

  fs.readFile( filename, 'utf8', ( err, data ) => {
    if ( err ) {
      console.error( err );
      return false;
    }

    final.content = data.toString();
  });

  return final.content;
}

export { fileExists, getFiles, getFileContent }