markdown-to-html-cli/lib/index.js

Command line tool generates markdown as html.

import fs from 'fs-extra';
import path from 'path';
import minimist from 'minimist';
import { create, _dirname } from './create.js';
export * from './create.js';
const pkg = fs.readJSONSync(path.resolve(_dirname, '..', 'package.json'));
export function run(opts = {}) {
    const argvs = minimist(process.argv.slice(2), {
        alias: {
            help: 'h',
            version: 'v',
            config: 'c',
            source: 's',
            output: 'o',
        },
        default: {
            version: opts.v || opts.version || false,
            help: opts.h || opts.help || false,
            source: opts.s || opts.source || 'README.md',
            markdown: opts.markdown || '',
            description: opts.description || '',
            output: opts.o || opts.output || 'index.html',
        },
    });
    if (argvs.h || argvs.help) {
        console.log(`${cliHelp}${exampleHelp}`);
        return;
    }
    if (argvs.v || argvs.version) {
        console.log(`\n \x1b[35mmarkdown-to-html-cli\x1b[0m v${pkg.version}\n`);
        return pkg.version;
    }
    if (argvs.source && !argvs.markdown) {
        argvs.markdown = fs.readFileSync(path.resolve(argvs.source)).toString();
    }
    let options = { ...opts, ...argvs, document: { title: argvs.title, meta: [], link: [] } };
    const projectPkg = path.resolve(process.cwd(), opts.config || argvs.config || 'package.json');
    let pgkData = {};
    if (fs.existsSync(projectPkg)) {
        pgkData = fs.readJSONSync(projectPkg);
        if (pgkData.name && !options.document.title) {
            options.document.title = pgkData.name;
        }
        if (pgkData.repository && !argvs['github-corners']) {
            argvs['github-corners'] = typeof pgkData.repository === 'string' ? pgkData.repository : pgkData.repository.url;
        }
        if (pgkData['markdown-to-html']) {
            const mth = pgkData['markdown-to-html'];
            const { title, meta, link } = options.document;
            options = { ...options, ...mth, document: { title, meta, link, ...mth.document } };
            if (mth['github-corners']) {
                argvs['github-corners'] = mth['github-corners'];
            }
        }
    }
    if (argvs['github-corners']) {
        argvs['github-corners'] = argvs['github-corners'].replace(/^git[+]/, '');
    }
    if (Array.isArray(options.document.link) && options.favicon) {
        options.document.link.push({ rel: 'icon', href: options.favicon, type: 'image/x-icon' });
    }
    if (Array.isArray(options.document.meta)) {
        if (options.description) {
            options.document.meta.push({ description: options.description });
        }
        else if (pgkData.description) {
            options.document.meta.push({ description: pgkData.description });
        }
        if (options.keywords) {
            options.document.meta.push({ keywords: options.keywords });
        }
        else if (pgkData.keywords && Array.isArray(pgkData.keywords)) {
            options.document.meta.push({ keywords: pgkData.keywords.join(',') });
        }
        if (typeof options.author === 'string') {
            options.document.meta.push({ author: options.author });
        }
    }
    const output = path.resolve(argvs.output);
    const strMarkdown = create({ ...argvs, ...options });
    fs.writeFileSync(output, strMarkdown);
    console.log(`\nmarkdown-to-html: \x1b[32;1m${path.relative(process.cwd(), output)}\x1b[0m\n`);
}
export const cliHelp = `\n  Usage: markdown-to-html [options] [--help|h]

  Options:\n
    --author          Define the author of a page.
    --config, -o      Specify the configuration file. Default: "<process.cwd()>/package.json".
    --description     Define a description of your web page.
    --favicon         Add a Favicon to your Site.
    --github-corners  Add a Github corner to your project page.
    --github-corners-fork  Github corners style.
    --keywords        Define keywords for search engines.
    --markdown        Markdown string.
    --output, -o      Output static pages to the specified directory. Default: "index.html"
    --source, -s      The path of the target file "README.md". Default: "README.md"
    --title           The \`<title>\` tag is required in HTML documents!
    --version, -v     Show version number
    --help, -h        Displays help information.
`;
export const exampleHelp = `\n  Example:

    \x1b[35mnpm\x1b[0m markdown-to-html-cli
    \x1b[35mnpm\x1b[0m markdown-to-html     \x1b[33m--title\x1b[0m="Hello World!"
    \x1b[35mnpm\x1b[0m markdown-to-html     \x1b[33m--config\x1b[0m="config/conf.json"
    \x1b[35mnpm\x1b[0m markdown-to-html-cli \x1b[33m--markdown\x1b[0m="Hello World!"
    \x1b[35mnpm\x1b[0m markdown-to-html-cli \x1b[33m--github-corners\x1b[0m https://github.com/jaywcjlove/markdown-to-html-cli
    \x1b[35mnpm\x1b[0m markdown-to-html-cli \x1b[33m--github-corners\x1b[0m https://github.com/jaywcjlove --github-corners-fork
    \x1b[35mnpm\x1b[0m markdown-to-html-cli \x1b[33m--output\x1b[0m coverage/index.html
    \x1b[35mnpm\x1b[0m markdown-to-html-cli \x1b[33m--source\x1b[0m README.md
  
`;
//# sourceMappingURL=index.js.map