src/polyfills/FileSystem.ts

/*
 * This file is part of SudoBot.
 *
 * Copyright (C) 2021-2023 OSN Developers.
 *
 * SudoBot is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * SudoBot is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with SudoBot. If not, see <https://www.gnu.org/licenses/>.
 */

import { existsSync } from "fs";
import { readFile, writeFile } from "fs/promises";

type ReadFileContentOptions<T extends boolean> = {
    json?: T;
};

type ReadFileResult<T extends boolean, J> = T extends true ? J : string;

/**
 * A file system utility class, that works with both Node.js and Bun.
 */
export default class FileSystem {
    /**
     * Reads the contents of a file.
     * @param path - The path of the file to read.
     * @param options - The options for reading the file.
     * @returns A promise that resolves to the contents of the file.
     */
    static async readFileContents<J = unknown, T extends boolean = false>(
        path: string,
        { json }: ReadFileContentOptions<T> = {}
    ): Promise<ReadFileResult<T, J>> {
        let contents = "";

        if (process.versions.bun) {
            const file = Bun.file(path);
            contents = await (json ? file.json() : file.text());
        } else {
            contents = await readFile(path, { encoding: "utf-8" });

            if (json) {
                return JSON.parse(contents);
            }
        }

        return contents as ReadFileResult<T, J>;
    }

    /**
     * Checks if a file exists.
     *
     * @param filePath - The path of the file to check.
     * @returns A promise that resolves to a boolean indicating if the file exists.
     */
    static async exists(filePath: string) {
        if (process.versions.bun) {
            return Bun.file(filePath).exists();
        } else {
            return existsSync(filePath);
        }
    }

    /**
     * Writes the contents to a file.
     *
     * @param path - The path of the file to write to.
     * @param contents - The contents to write to the file.
     * @returns A promise that resolves when the file is written.
     * @throws An error if the file cannot be written.
     */
    static async writeFileContents(path: string, contents: Stringable, json: boolean = false): Promise<void> {
        if (process.versions.bun) {
            await Bun.write(path, json ? JSON.stringify(contents) : contents.toString());
        } else {
            await writeFile(path, json ? JSON.stringify(contents) : contents.toString(), { encoding: "utf-8" });
        }
    }
}

type Stringable = { toString: () => string } | string;
1	rakinar2	577	/*
2			* This file is part of SudoBot.
3			*
4			* Copyright (C) 2021-2023 OSN Developers.
5			*
6			* SudoBot is free software; you can redistribute it and/or modify it
7			* under the terms of the GNU Affero General Public License as published by
8			* the Free Software Foundation, either version 3 of the License, or
9			* (at your option) any later version.
10			*
11			* SudoBot is distributed in the hope that it will be useful, but
12			* WITHOUT ANY WARRANTY; without even the implied warranty of
13			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14			* GNU Affero General Public License for more details.
15			*
16			* You should have received a copy of the GNU Affero General Public License
17			* along with SudoBot. If not, see <https://www.gnu.org/licenses/>.
18			*/
19
20			import { existsSync } from "fs";
21			import { readFile, writeFile } from "fs/promises";
22
23			type ReadFileContentOptions<T extends boolean> = {
24			json?: T;
25			};
26
27			type ReadFileResult<T extends boolean, J> = T extends true ? J : string;
28
29			/**
30			* A file system utility class, that works with both Node.js and Bun.
31			*/
32			export default class FileSystem {
33			/**
34			* Reads the contents of a file.
35			* @param path - The path of the file to read.
36			* @param options - The options for reading the file.
37			* @returns A promise that resolves to the contents of the file.
38			*/
39			static async readFileContents<J = unknown, T extends boolean = false>(
40			path: string,
41			{ json }: ReadFileContentOptions<T> = {}
42			): Promise<ReadFileResult<T, J>> {
43			let contents = "";
44
45			if (process.versions.bun) {
46			const file = Bun.file(path);
47			contents = await (json ? file.json() : file.text());
48			} else {
49			contents = await readFile(path, { encoding: "utf-8" });
50
51			if (json) {
52			return JSON.parse(contents);
53			}
54			}
55
56			return contents as ReadFileResult<T, J>;
57			}
58
59			/**
60			* Checks if a file exists.
61			*
62			* @param filePath - The path of the file to check.
63			* @returns A promise that resolves to a boolean indicating if the file exists.
64			*/
65			static async exists(filePath: string) {
66			if (process.versions.bun) {
67			return Bun.file(filePath).exists();
68			} else {
69			return existsSync(filePath);
70			}
71			}
72
73			/**
74			* Writes the contents to a file.
75			*
76			* @param path - The path of the file to write to.
77			* @param contents - The contents to write to the file.
78			* @returns A promise that resolves when the file is written.
79			* @throws An error if the file cannot be written.
80			*/
81			static async writeFileContents(path: string, contents: Stringable, json: boolean = false): Promise<void> {
82			if (process.versions.bun) {
83			await Bun.write(path, json ? JSON.stringify(contents) : contents.toString());
84			} else {
85			await writeFile(path, json ? JSON.stringify(contents) : contents.toString(), { encoding: "utf-8" });
86			}
87			}
88			}
89
90			type Stringable = { toString: () => string } \| string;