@compodoc/compodoc/src/app/engines/file.engine.ts

The missing documentation tool for your Angular application

import * as fs from 'fs-extra';
import * as path from 'path';

export class FileEngine {
    private static instance: FileEngine;
    private constructor() {}
    public static getInstance() {
        if (!FileEngine.instance) {
            FileEngine.instance = new FileEngine();
        }
        return FileEngine.instance;
    }

    public get(filepath: string): Promise<string> {
        return new Promise((resolve, reject) => {
            fs.readFile(path.resolve(filepath), 'utf8', (err, data) => {
                if (err) {
                    reject('Error during ' + filepath + ' read');
                } else {
                    resolve(data);
                }
            });
        });
    }

    public write(filepath: string, contents: string): Promise<void> {
        return new Promise((resolve, reject) => {
            fs.outputFile(path.resolve(filepath), contents, err => {
                if (err) {
                    reject(err);
                } else {
                    resolve();
                }
            });
        });
    }

    public writeSync(filepath: string, contents: string): void {
        fs.outputFileSync(filepath, contents);
    }

    public getSync(filepath: string): string {
        return fs.readFileSync(path.resolve(filepath), 'utf8');
    }

    /**
     * @param file The file to check
     */
    public existsSync(file: string): boolean {
        return fs.existsSync(file);
    }
}

export default FileEngine.getInstance();