feat: allow input from std in or shell globbing for multiple files

Author: simonhaenisch

lib/get-md-files-in-dir.ts

@@ -17,13 +17,13 @@
   "engines": {
     "node": ">= 8.3.0"
   },
-  "main": "index.js",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "scripts": {
     "start": "node . --help",
     "build": "tsc",
     "prepare": "npm run build",
-    "pretest": "npm run build",
-    "test": "xo && nyc ava test/lib.spec.js && ava test/api.spec.js && ava test/cli.spec.js",
+    "test": "xo && nyc ava test/lib.spec.ts && ava test/api.spec.ts && ava test/cli.spec.ts",
     "release": "npx standard-version --infile=changelog.md && git push --follow-tags origin master && npm publish"
   },
   "bin": {
@@ -41,7 +41,7 @@
     "get-port": "5.1.1",
     "get-stdin": "7.0.0",
     "gray-matter": "4.0.2",
-    "highlight.js": "9.17.1",
+    "highlight.js": "9.18.0",
     "iconv-lite": "0.5.1",
     "listr": "0.14.3",
     "marked": "0.8.0",
@@ -54,11 +54,12 @@
     "@types/marked": "0.7.2",
     "@types/puppeteer": "2.0.0",
     "@types/serve-handler": "6.1.0",
-    "ava": "2.4.0",
-    "husky": "4.0.10",
+    "ava": "3.0.0",
+    "husky": "4.2.1",
     "nyc": "15.0.0",
     "prettier": "1.19.1",
     "tap-xunit": "2.4.1",
+    "ts-node": "8.6.2",
     "typescript": "3.7.5",
     "xo": "0.25.3"
   },
@@ -67,6 +68,14 @@
       "post-merge": "git diff-tree -r --name-only --no-commit-id ORIG_HEAD HEAD | grep --quiet package-lock.json && npm install"
     }
   },
+  "ava": {
+    "extensions": [
+      "ts"
+    ],
+    "require": [
+      "ts-node/register"
+    ]
+  },
   "prettier": {
     "printWidth": 120,
     "singleQuote": true,

package-lock.json

@@ -7,14 +7,13 @@ import path from 'path';
 import arg from 'arg';
 import chalk from 'chalk';
 import Listr from 'listr';
+import getStdin from 'get-stdin';
 import getPort from 'get-port';
 import { watch } from 'chokidar';
 
 import { help } from './lib/help';
-import { getMdFilesInDir } from './lib/get-md-files-in-dir';
-import { serveDirectory } from './lib/serve-dir';
+import { serveDirectory, closeServer } from './lib/serve-dir';
 import { defaultConfig, Config } from './lib/config';
-import { getDir } from './lib/helpers';
 import { convertMdToPdf } from './lib/md-to-pdf';
 import { setProcessAndTermTitle } from './lib/helpers';
 
@@ -24,6 +23,7 @@ import { setProcessAndTermTitle } from './lib/helpers';
 const cliFlags = arg({
 	'--help': Boolean,
 	'--version': Boolean,
+	'--basedir': String,
 	'--watch': Boolean,
 	'--stylesheet': [String],
 	'--css': String,
@@ -48,7 +48,15 @@ const cliFlags = arg({
 });
 
 // --
-// Main
+// Run
+
+main(cliFlags, defaultConfig).catch(error => {
+	console.error(error);
+	process.exit(1);
+});
+
+// --
+// Define Main Function
 
 async function main(args: typeof cliFlags, config: Config) {
 	setProcessAndTermTitle('md-to-pdf');
@@ -61,19 +69,22 @@ async function main(args: typeof cliFlags, config: Config) {
 		return help();
 	}
 
-	const [input, dest] = args._;
+	/**
+	 * 1. Get input.
+	 */
+
+	const files = args._;
 
-	const mdFiles = input ? [input] : await getMdFilesInDir('.');
+	const stdin = await getStdin();
 
-	if (mdFiles.length === 0) {
+	if (files.length === 0 && !stdin) {
 		return help();
 	}
 
-	if (dest) {
-		config.dest = dest;
-	}
+	/**
+	 * 2. Read config file and merge it into the config object.
+	 */
 
-	// merge config from config file
 	if (args['--config-file']) {
 		try {
 			const configFile: Partial<Config> = require(path.resolve(args['--config-file']));
@@ -92,38 +103,52 @@ async function main(args: typeof cliFlags, config: Config) {
 		}
 	}
 
-	// serve directory of first file because all files will be in the same dir
+	/**
+	 * 3. Start the file server.
+	 */
+
+	if (args['--basedir']) {
+		config.basedir = args['--basedir'];
+	}
+
 	config.port = args['--port'] || (await getPort());
-	const server = await serveDirectory(getDir(mdFiles[0]), config.port);
 
-	const getListrTask = (mdFile: string) => ({
-		title: `generating ${args['--as-html'] ? 'HTML' : 'PDF'} from ${chalk.underline(mdFile)}`,
-		task: () => convertMdToPdf(mdFile, config, args),
+	const server = await serveDirectory(config);
+
+	/**
+	 * 4. Either process stdin or create a Listr task for each file.
+	 */
+
+	if (stdin) {
+		await convertMdToPdf({ content: stdin }, config, args).catch(async (error: Error) => {
+			await closeServer(server);
+
+			console.error(error);
+			process.exit(1);
+		});
+
+		await closeServer(server);
+
+		return;
+	}
+
+	const getListrTask = (file: string) => ({
+		title: `generating ${args['--as-html'] ? 'HTML' : 'PDF'} from ${chalk.underline(file)}`,
+		task: () => convertMdToPdf({ path: file }, config, args),
 	});
 
-	// create list of tasks and run concurrently
-	await new Listr(mdFiles.map(getListrTask), { concurrent: true, exitOnError: false })
+	await new Listr(files.map(getListrTask), { concurrent: true, exitOnError: false })
 		.run()
 		.then(() => {
 			if (args['--watch']) {
 				console.log(chalk.bgBlue('\n watching for changes \n'));
 
-				watch(mdFiles).on('change', async mdFile => {
-					await new Listr([getListrTask(mdFile)])
-						.run()
-						.catch((error: Error) => args['--debug'] && console.error(error));
+				watch(files).on('change', async file => {
+					await new Listr([getListrTask(file)]).run().catch((error: Error) => args['--debug'] && console.error(error));
 				});
 			} else {
 				server.close();
 			}
 		})
 		.catch((error: Error) => (args['--debug'] && console.error(error)) || process.exit(1));
 }
-
-// --
-// Run
-
-main(cliFlags, defaultConfig).catch(error => {
-	console.error(error);
-	process.exit(1);
-});

package.json

@@ -4,29 +4,36 @@ import getPort from 'get-port';
 
 import { defaultConfig, Config } from './lib/config';
 import { serveDirectory } from './lib/serve-dir';
-import { getDir } from './lib/helpers';
 import { convertMdToPdf } from './lib/md-to-pdf';
+import { getDir } from './lib/helpers';
 
 /**
  * Convert a markdown file to PDF.
  *
  * @returns the path that the PDF was written to
  */
-export const mdToPdf = async (mdFile: string, config: Partial<Config> = {}) => {
-	if (typeof mdFile !== 'string') {
-		throw new TypeError(`mdFile has to be a string, received ${typeof mdFile}`);
+export const mdToPdf = async (input: { path: string } | { content: string }, config: Partial<Config> = {}) => {
+	if (!('path' in input ? input.path : input.content)) {
+		throw new Error('Specify either content or path.');
+	}
+
+	if (!config.port) {
+		config.port = await getPort();
 	}
 
-	config.port = config.port || (await getPort());
-	const server = await serveDirectory(getDir(mdFile), config.port);
+	if (!config.basedir) {
+		config.basedir = 'path' in input ? getDir(input.path) : process.cwd();
+	}
 
 	const mergedConfig: Config = {
 		...defaultConfig,
 		...config,
 		pdf_options: { ...defaultConfig.pdf_options, ...config.pdf_options },
 	};
 
-	const pdf = await convertMdToPdf(mdFile, mergedConfig);
+	const server = await serveDirectory(mergedConfig);
+
+	const pdf = await convertMdToPdf(input, mergedConfig);
 
 	server.close();
 

cli.ts src/cli.tscli.ts renamed to src/cli.ts

@@ -3,6 +3,7 @@ import { MarkedOptions } from 'marked';
 import { PDFOptions, LaunchOptions } from 'puppeteer';
 
 export const defaultConfig: Config = {
+	basedir: process.cwd(),
 	stylesheet: [resolve(__dirname, '..', '..', 'markdown.css')],
 	css: '',
 	body_class: [],
@@ -29,6 +30,11 @@ export const defaultConfig: Config = {
  * In config keys, dashes of cli flag names are replaced with underscores.
  */
 export interface Config {
+	/**
+	 * Base directory to be served by the file server.
+	 */
+	basedir: string;
+
 	/**
 	 * Optional destination path for the output file (including the extension).
 	 */

index.ts src/index.tsindex.ts renamed to src/index.ts

@@ -8,9 +8,9 @@ export const getMarked = (options: MarkedOptions) => {
 	if (!Object.prototype.hasOwnProperty.call(renderer, 'code')) {
 		renderer.code = (code, language) => {
 			// if the given language is not available in highlight.js, fall back to plaintext
-			language = (getLanguage(language) && language) || 'plaintext';
+			const languageName = language && getLanguage(language) ? language : 'plaintext';
 
-			return `<pre><code class="hljs ${language}">${highlight(language, code).value}</code></pre>`;
+			return `<pre><code class="hljs ${languageName}">${highlight(languageName, code).value}</code></pre>`;
 		};
 	}
 

lib/config.ts src/lib/config.tslib/config.ts renamed to src/lib/config.ts

@@ -4,7 +4,7 @@ import { Config } from './config';
 /**
  * Derive the output file path from the source markdown file.
  */
-export const getOutputFilePath = (mdFilePath: string, config: Config) => {
+export const getOutputFilePath = (mdFilePath: string, config: Partial<Config>) => {
 	const { dir, name } = parse(mdFilePath);
 	const extension = config.as_html ? 'html' : 'pdf';
 

lib/get-html.ts src/lib/get-html.tslib/get-html.ts renamed to src/lib/get-html.ts

@@ -8,6 +8,7 @@ const helpText = `
     -h, --help ${chalk.dim('...............')} Output usage information
     -v, --version ${chalk.dim('............')} Output version
     -w, --watch ${chalk.dim('..............')} Watch the current file(s) for changes
+    --basedir ${chalk.dim('................')} Base directory to be served by the file server
     --stylesheet ${chalk.dim('.............')} Path to a local or remote stylesheet (can be passed multiple times)
     --css ${chalk.dim('....................')} String of styles
     --body-class ${chalk.dim('.............')} Classes to be added to the body tag (can be passed multiple times)