resume-cli 3.2.0 → 3.3.0

package/build/builder.js

@@ -5,6 +5,10 @@ const fs = require('fs');
 const request = require('superagent');
 const chalk = require('chalk');
 const renderHtml = require('./render-html').default;
+const {
+  ThemeNotFoundError,
+  formatThemeNotFound
+} = require('./theme-errors');
 const denormalizeTheme = value => {
   return value.match(/jsonresume-theme-(.*)/)[1];
 };
@@ -45,7 +49,13 @@ module.exports = function resumeBuilder(theme, dir, resumeFilename, cb) {
       });
       cb(null, html);
     } catch (err) {
-      console.log(err);
+      if (err instanceof ThemeNotFoundError) {
+        // Theme isn't installed locally. Show an actionable message, then fall
+        // back to the hosted theme server (preserving existing behavior).
+        console.log(formatThemeNotFound(err.theme));
+      } else {
+        console.log(err);
+      }
       console.log(chalk.yellow('Could not run the render function from local theme.'));
       sendExportHTML(resumeJson, theme, cb);
     }

package/build/export-resume.js

@@ -8,6 +8,9 @@ const writeFile = (0, _util.promisify)(_fs.default.writeFile);
 const path = require('path');
 const puppeteer = require('puppeteer');
 const btoa = require('btoa');
+const {
+  ThemeNotFoundError
+} = require('./theme-errors');
 module.exports = ({
   resume: resumeJson,
   fileName,
@@ -24,14 +27,16 @@ module.exports = ({
   const formatToUse = '.' + fileFormatToUse;
   if (formatToUse === '.html') {
     createHtml(resumeJson, fileName, theme, formatToUse, error => {
-      if (error) {
+      // ThemeNotFoundError is reported as a friendly message by the caller;
+      // don't dump the raw object here.
+      if (error && !(error instanceof ThemeNotFoundError)) {
         console.error(error, '`createHtml` errored out');
       }
       callback(error, fileName, formatToUse);
     });
   } else if (formatToUse === '.pdf') {
     createPdf(resumeJson, fileName, theme, formatToUse, error => {
-      if (error) {
+      if (error && !(error instanceof ThemeNotFoundError)) {
         console.error(error, '`createPdf` errored out');
       }
       callback(error, fileName, formatToUse);
@@ -58,16 +63,24 @@ const getThemePkg = theme => {
     const themePkg = require(theme);
     return themePkg;
   } catch (err) {
-    // Theme not installed
-    console.log('You have to install this theme relative to the folder to use it e.g. `npm install ' + theme + '`');
-    process.exit();
+    // Theme not installed. Throw a typed error so the caller can render an
+    // actionable, stack-trace-free message and exit with a non-zero code.
+    throw new ThemeNotFoundError(theme);
   }
 };
 async function createHtml(resumeJson, fileName, themePath, format, callback) {
-  const html = await (0, _renderHtml.default)({
-    resume: resumeJson,
-    themePath
-  });
+  let html;
+  try {
+    html = await (0, _renderHtml.default)({
+      resume: resumeJson,
+      themePath
+    });
+  } catch (err) {
+    // Surface theme-resolution (and other render) failures to the caller so
+    // they can be reported as an actionable message rather than an
+    // unhandled-rejection stack trace.
+    return callback(err);
+  }
   const pathToStream = path.resolve(process.cwd(), fileName + format);
   await writeFile(pathToStream, ''); // workaround for https://github.com/streamich/unionfs/issues/428
   const stream = _fs.default.createWriteStream(pathToStream);

package/build/main.js

@@ -13,6 +13,10 @@ const serve = require('./serve');
 const program = require('commander');
 const chalk = require('chalk');
 const path = require('path');
+const {
+  ThemeNotFoundError,
+  formatThemeNotFound
+} = require('./theme-errors');
 const normalizeTheme = (value, defaultValue) => {
   const theme = value || defaultValue;
   // TODO - This is not great, but bypasses this function if it is a relative path
@@ -22,7 +26,7 @@ const normalizeTheme = (value, defaultValue) => {
   return theme.match('jsonresume-theme-.*') ? theme : `jsonresume-theme-${theme}`;
 };
 (async () => {
-  program.name('resume').usage('[command] [options]').version(pkg.version).option('-F, --force', 'Used by `publish` and `export` - bypasses schema testing.').option('-t, --theme <theme name>', 'Specify theme used by `export` and `serve` or specify a path starting with . (use . for current directory or ../some/other/dir)', normalizeTheme, 'jsonresume-theme-elegant').option('-f, --format <file type extension>', 'Used by `export`.').option('-r, --resume <resume filename>', "path to the resume in json format. Use '-' to read from stdin", 'resume.json').option('-p, --port <port>', 'Used by `serve` (default: 4000)', 4000).option('-s, --silent', 'Used by `serve` to tell it if open browser auto or not.', false).option('-d, --dir <path>', 'Used by `serve` to indicate a public directory path.', 'public').option('--schema <relativePath>', 'Used by `validate` to validate against a custom schema.');
+  program.name('resume').usage('[command] [options]').version(pkg.version).option('-F, --force', 'Used by `publish` and `export` - bypasses schema testing.').option('-t, --theme <theme name>', 'Theme used by `export` and `serve` (browse themes at https://jsonresume.org/themes/), or a path starting with . (use . for current directory or ../some/other/dir)', normalizeTheme, 'jsonresume-theme-elegant').option('-f, --format <file type extension>', 'Used by `export`.').option('-r, --resume <resume filename>', "path to the resume in json format. Use '-' to read from stdin", 'resume.json').option('-p, --port <port>', 'Used by `serve` (default: 4000)', 4000).option('-s, --silent', 'Used by `serve` to tell it if open browser auto or not.', false).option('-d, --dir <path>', 'Used by `serve` to indicate a public directory path.', 'public').option('--schema <relativePath>', 'Used by `validate` to validate against a custom schema.');
   program.command('init').description('Initialize a resume.json file').action(async () => {
     await (0, _init.default)({
       resumePath: program.resume
@@ -40,12 +44,13 @@ const normalizeTheme = (value, defaultValue) => {
         resume,
         schema
       });
+      console.log(chalk.green(`✓ ${program.resume} is valid`));
     } catch (e) {
       console.error(e.message);
       process.exitCode = 1;
     }
   });
-  program.command('export [fileName]').description('Export locally to .html or .pdf. Supply a --format <file format> flag and argument to specify export format.').action(async fileName => {
+  program.command('export [fileName]').description('Export locally to .html or .pdf. Supply a --format <file format> flag and argument to specify export format. Pick a theme with --theme (https://jsonresume.org/themes/).').action(async fileName => {
     const resume = await (0, _getResume.default)({
       path: program.resume
     });
@@ -54,6 +59,15 @@ const normalizeTheme = (value, defaultValue) => {
       resume,
       fileName
     }, (err, fileName, format) => {
+      if (err) {
+        if (err instanceof ThemeNotFoundError) {
+          console.error(formatThemeNotFound(err.theme));
+        } else {
+          console.error(err.message || err);
+        }
+        process.exitCode = 1;
+        return;
+      }
       console.log(chalk.green('\nDone! Find your new', format, 'resume at:\n', path.resolve(process.cwd(), fileName + format)));
     });
   });

package/build/main.test.js

@@ -8,12 +8,15 @@ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e
 const exec = (0, _util.promisify)(_child_process.exec);
 const run = async (argv, {
   waitForVolumeExport = true,
-  stdin = ''
+  stdin = '',
+  captureStderr = false
 } = {}) => {
   let volume;
   let exitCode;
   const child = (0, _child_process.spawn)(process.execPath, ['build/test-utils/cli-test-entry.js', ...argv], {
-    stdio: ['pipe', 'pipe', 2, 'ipc']
+    // When captureStderr is set, pipe fd 2 so the test can read the
+    // friendly error output; otherwise inherit it (existing behavior).
+    stdio: ['pipe', 'pipe', captureStderr ? 'pipe' : 2, 'ipc']
   });
   const allChecks = Promise.all([waitForVolumeExport ? new Promise(volumeSet => {
     child.on('message', async message => {
@@ -30,12 +33,16 @@ const run = async (argv, {
   })]);
   child.stdin.write(stdin);
   child.stdin.end();
-  const stdout = await (0, _streamToString.default)(child.stdout);
+  const stdoutPromise = (0, _streamToString.default)(child.stdout);
+  const stderrPromise = captureStderr ? (0, _streamToString.default)(child.stderr) : Promise.resolve('');
+  const stdout = await stdoutPromise;
+  const stderr = await stderrPromise;
   await allChecks;
   return {
     volume,
     code: exitCode,
-    stdout
+    stdout,
+    stderr
   };
 };
 describe('cli configuration', () => {
@@ -53,10 +60,11 @@ describe('cli configuration', () => {
         -V, --version                       output the version number
         -F, --force                         Used by \`publish\` and \`export\` - bypasses
                                             schema testing.
-        -t, --theme <theme name>            Specify theme used by \`export\` and
-                                            \`serve\` or specify a path starting with .
-                                            (use . for current directory or
-                                            ../some/other/dir) (default:
+        -t, --theme <theme name>            Theme used by \`export\` and \`serve\`
+                                            (browse themes at
+                                            https://jsonresume.org/themes/), or a
+                                            path starting with . (use . for current
+                                            directory or ../some/other/dir) (default:
                                             "jsonresume-theme-elegant")
         -f, --format <file type extension>  Used by \`export\`.
         -r, --resume <resume filename>      path to the resume in json format. Use
@@ -77,7 +85,9 @@ describe('cli configuration', () => {
         validate                            Validate your resume's schema
         export [fileName]                   Export locally to .html or .pdf. Supply
                                             a --format <file format> flag and
-                                            argument to specify export format.
+                                            argument to specify export format. Pick a
+                                            theme with --theme
+                                            (https://jsonresume.org/themes/).
         serve                               Serve resume at http://localhost:4000/
         help [command]                      display help for command
       "
@@ -88,16 +98,37 @@ describe('cli configuration', () => {
       const {
         stdout
       } = await run(['validate', '--schema', '/test-resumes/only-number-schema.json', '--resume', '/test-resumes/only-number.json']);
-      expect(stdout).toMatchInlineSnapshot(`""`);
+      expect(stdout).toMatchInlineSnapshot(`
+        "✓ /test-resumes/only-number.json is valid
+        "
+      `);
     });
     it('should fail when trying to validate an invalid resume specified by the --resume option', async () => {
       expect((await run(['validate', '--resume', '/test-resumes/invalid-resume.json'])).code).toEqual(1);
     });
+    it('should print the per-field error list (not a success line) when validation fails', async () => {
+      const {
+        code,
+        stdout,
+        stderr
+      } = await run(['validate', '--resume', '/test-resumes/invalid-resume.json'], {
+        waitForVolumeExport: false,
+        captureStderr: true
+      });
+      expect(code).toEqual(1);
+      expect(stderr).toContain('Invalid resume:');
+      expect(stderr).toContain('data/basics/name must be string');
+      // The success line must not appear for an invalid resume.
+      expect(stdout).not.toContain('is valid');
+    });
     it('should validate a resume specified by the --resume option', async () => {
       const {
         stdout
       } = await run(['validate', '--resume', '/test-resumes/resume.json']);
-      expect(stdout).toMatchInlineSnapshot(`""`);
+      expect(stdout).toMatchInlineSnapshot(`
+        "✓ /test-resumes/resume.json is valid
+        "
+      `);
     });
   });
   describe('export', () => {
@@ -139,5 +170,20 @@ describe('cli configuration', () => {
         "
       `);
     });
+    it('should print a friendly, actionable message and exit non-zero when the theme is not installed', async () => {
+      const {
+        code,
+        stderr
+      } = await run(['export', '/test-resumes/exported-resume.html', '--resume', '/test-resumes/resume.json', '--theme', 'nonexistent-xyz'], {
+        waitForVolumeExport: false,
+        captureStderr: true
+      });
+      expect(code).toEqual(1);
+      expect(stderr).toContain("Theme 'nonexistent-xyz' not found.");
+      expect(stderr).toContain('npm install jsonresume-theme-nonexistent-xyz');
+      expect(stderr).toContain('https://jsonresume.org/themes/');
+      // The raw stack trace must not leak to the user.
+      expect(stderr).not.toContain('at _default');
+    });
   });
 });

package/build/render-html.js

@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
+var _themeErrors = require("./theme-errors");
 const tryResolve = (...args) => {
   try {
     return require.resolve(...args);
@@ -22,7 +23,7 @@ var _default = async ({
       paths: [cwd]
     });
     if (!path) {
-      throw new Error(`Theme ${themePath} could not be resolved relative to ${cwd}`);
+      throw new _themeErrors.ThemeNotFoundError(themePath);
     }
   }
   if (!path) {
@@ -36,7 +37,7 @@ var _default = async ({
     });
   }
   if (!path) {
-    throw new Error(`theme path ${themePath} could not be resolved from current working directory`);
+    throw new _themeErrors.ThemeNotFoundError(themePath);
   }
   const theme = require(path);
   if (typeof theme?.render !== 'function') {

package/build/theme-errors.js

@@ -0,0 +1,35 @@
+"use strict";
+
+const chalk = require('chalk');
+
+// Strip the `jsonresume-theme-` prefix (and any relative-path noise) so the
+// message we show the user matches what they would type with `--theme`.
+const shortThemeName = theme => {
+  if (!theme) {
+    return theme;
+  }
+  const base = theme.replace(/^.*jsonresume-theme-/, '');
+  return base.replace(/[/\\].*$/, '');
+};
+
+// Error raised when a `--theme` cannot be resolved. Carries the requested
+// theme name so the CLI can render an actionable, stack-trace-free message.
+class ThemeNotFoundError extends Error {
+  constructor(theme) {
+    super(`Theme not found: ${theme}`);
+    this.name = 'ThemeNotFoundError';
+    this.theme = theme;
+  }
+}
+
+// Build the user-facing, actionable message for a missing theme.
+const formatThemeNotFound = theme => {
+  const short = shortThemeName(theme);
+  const pkg = short.startsWith('jsonresume-theme-') ? short : `jsonresume-theme-${short}`;
+  return [chalk.red(`Theme '${short}' not found.`), `Install it:  ${chalk.cyan(`npm install ${pkg}`)}`, `Browse themes:  ${chalk.cyan('https://jsonresume.org/themes/')}`].join('\n');
+};
+module.exports = {
+  ThemeNotFoundError,
+  formatThemeNotFound,
+  shortThemeName
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "resume-cli",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "description": "The JSON Resume command line interface",
   "main": "build/main.js",
   "engines": {