extwee/src/CLI/ProcessConfig/readDirectories.js

A story compiler tool using Twine-compatible formats

import { readdirSync } from 'node:fs';
import { isDirectory } from '../isDirectory.js';

/**
 * Read the contents of a directory and returns all directories.
 * @function readDirectories
 * @description This function reads the contents of a directory and returns a list of directories.
 * @param {string} directory - The path to the directory to read.
 * @returns {Array<string>} - An array of directories in the directory.
 * @throws {Error} - If the directory does not exist or if there is an error reading the directory.
 */
export function readDirectories(directory) {

    // Create default response.
    let results = [];

    // Check if the directory exists.
    const isDir = isDirectory(directory);
    // If the directory does not exist, return an empty array
    //  and log an error message.
    if (isDir == false) {
        console.error(`Error: Directory ${directory} does not exist.`);
    }

    // Read the directory and return the list of files.
    try {
        results = readdirSync(directory);
    } catch (error) {
        console.error(`Error reading directory ${directory}:`, error);
        results = [];
    }

    // Check if results is an array.
    // This should not happen, but for some reason it can.
    if (!Array.isArray(results)) {
        results = [];
    }

    // Filter the list to only include directories.
    const directoriesOnly = results.filter((item) => {
        return isDirectory(`${directory}/${item}`);
    });

    // Return the list of directories.
    return directoriesOnly;
}