Fix: sync API incorrectly required relativePath option

- `options` should be optional for sync methods too.
- TODO: add API interface tests for other APIs

BREAKING: CLI argument `relative` renamed to `relativePath`

src/hercule.js

@@ -65,13 +65,18 @@ export function transcludeFile(...args) {
 }
 
 
-export function transcludeFileSync(input, { relativePath }, log) {
-  const options = {
-    cwd: __dirname,
-    timeout: SYNC_TIMEOUT,
-  };
-  const args = [input, '--reporter', 'json-err'];
-  const result = childProcess.spawnSync('../bin/hercule', args, options);
+export function transcludeFileSync(...args) {
+  const input = args.shift();
+  const [options, log] = args;
+
+  const syncOptions = { cwd: __dirname, timeout: SYNC_TIMEOUT };
+  const syncArgs = [input, '--reporter', 'json-err'];
+
+  _.each(options, (optionValue, optionName) => {
+    syncArgs.push(`--${optionName}`, `${optionValue}`);
+  });
+
+  const result = childProcess.spawnSync('../bin/hercule', syncArgs, syncOptions);
   const outputContent = result.stdout.toString();
   const outputLogs = result.stderr.toString().split('\n');
 
@@ -86,14 +91,18 @@ export function transcludeFileSync(input, { relativePath }, log) {
 }
 
 
-export function transcludeStringSync(input, { relativePath }, log) {
-  const options = {
-    input,
-    cwd: __dirname,
-    timeout: SYNC_TIMEOUT,
-  };
-  const args = ['--relative', relativePath, '--reporter', 'json-err'];
-  const result = childProcess.spawnSync('../bin/hercule', args, options);
+export function transcludeStringSync(...args) {
+  const input = args.shift();
+  const [options, log] = args;
+
+  const syncOptions = { input, cwd: __dirname, timeout: SYNC_TIMEOUT };
+  const syncArgs = ['--reporter', 'json-err'];
+
+  _.each(options, (optionValue, optionName) => {
+    syncArgs.push(`--${optionName}`, `${optionValue}`);
+  });
+
+  const result = childProcess.spawnSync('../bin/hercule', syncArgs, syncOptions);
   const outputContent = result.stdout.toString();
   const outputLogs = result.stderr.toString().split('\n');
 

src/main.js

@@ -29,7 +29,7 @@ const parser = dashdash.createParser({
       helpArg: 'FILE',
     },
     {
-      names: ['relative', 'r'],
+      names: ['relativePath', 'r'],
       type: 'string',
       help: 'Relative path. stdin will be parsed relative to this path.',
     },
@@ -73,9 +73,10 @@ function main() {
   if (opts._args.length === 0) {
     // Reading input from stdin
     inputStream = process.stdin;
-    options.relativePath = opts.relative;
+    options.relativePath = opts.relativePath;
   } else {
     // Reading input from file
+    // TODO: handle file error!
     inputStream = fs.createReadStream(opts._args[0], { encoding: 'utf8' });
     options.relativePath = path.dirname(opts._args[0]);
   }

test/bats

@@ -13,7 +13,7 @@
 }
 
 @test "transcluding stdin" {
-  result="$(cat ./test/fixtures/local-link/index.md | ./bin/hercule --relative ./test/fixtures/local-link)"
+  result="$(cat ./test/fixtures/local-link/index.md | ./bin/hercule --relativePath ./test/fixtures/local-link)"
   expected="Jackdaws love my big sphinx of quartz."
   [ "$result" == "$expected" ]
 }

test/units/transcludeFileSync.js

@@ -0,0 +1,21 @@
+import test from 'ava';
+
+import { transcludeFileSync } from '../../lib/hercule';
+
+let major;
+let minor;
+
+[major, minor] = process.versions.node.split('.');
+
+if (major < 1 && minor < 12) {
+  test.only(`synchronous support not available < 0.12`, (t) => {
+    t.pass();
+  });
+}
+
+test(`should transclude with only required arguments`, (t) => {
+  const input = '../test/fixtures/no-link/index.md';
+  const expected = 'The quick brown fox jumps over the lazy dog.\n';
+  const output = transcludeFileSync(input);
+  t.same(output, expected);
+});

test/units/transcludeStringSync.js

@@ -0,0 +1,21 @@
+import test from 'ava';
+
+import { transcludeStringSync } from '../../lib/hercule';
+
+let major;
+let minor;
+
+[major, minor] = process.versions.node.split('.');
+
+if (major < 1 && minor < 12) {
+  test.only(`synchronous support not available < 0.12`, (t) => {
+    t.pass();
+  });
+}
+
+test(`should transclude with only required arguments`, (t) => {
+  const input = 'The quick brown fox jumps over the lazy dog.';
+  const expected = 'The quick brown fox jumps over the lazy dog.';
+  const output = transcludeStringSync(input);
+  t.same(output, expected);
+});