@onlabsorg/stilo/lib/stilo-read.js

Command line tool for managing olojs document packages

/**
 *  *stilo read* command
 *  ============================================================================
 *
 *  Given a document path, the *read* command fetches a document from the
 *  repository and prints it to the stdout.
 *
 *  ```
 *  stilo read <path>
 *  ```
 *
 *  If the *path* argument is an absolute path, it will be considered relative
 *  to the repository root. If, instead, the *path* argument is a relative
 *  path it will be considered relative to the current working directory.
 *
 *  In order to write the feched source to a file, the `--output` option can
 *  be used:
 *
 *  ```
 *  stilo read <path> --output <file-path>
 *  ```
 *
 *  Finally,
 *  - the `--help` option will display a help message
 *  - the `--verbose` option will display a detailed log of the command
 */

const logger = require('./logger');
const pathlib = require('path');
const fs = require('fs');


module.exports = async function (path, options={}) {
    try {
        
        // Detect the stilo package
        if (options.verbose) logger.debug(`Locating repository package ...`);
        const Package = require('./package');
        const package = Package.find(process.cwd());

        // Retrieve the store
        if (options.verbose) logger.debug(`Retrieving store ...`);
        const store = await package.getStore();

        // Fetch the document source
        const rootPath = package.resolvePath('..');
        const cwp = `/${pathlib.relative(rootPath, process.cwd())}/`;
        const docPath = store.resolvePath(cwp, path);
        if (options.verbose) logger.debug(`Fetching document from '${docPath}' ...`);
        const source = await store.read(docPath);
        
        // Output the source
        if (options.output) {
            const outputPath = pathlib.resolve(options.output);
            if (options.verbose) logger.debug(`Writing document source to '${outputPath}' ...`);
            fs.writeFileSync(outputPath, source, 'utf8');
        } else {
            if (options.verbose) logger.debug(`Writing document source to stdout ...`);
            logger.log(source);            
        }
        
        return source;

    } catch (error) {
        if (options.verbose) {
            logger.error(error);
        } else {
            logger.error(error.message);
        }
    }
}