resume-cli 3.0.2 → 3.0.6

package/README.md

@@ -10,6 +10,11 @@ This is the command line tool for [JSON Resume](https://jsonresume.org), the ope
 
 [Read more...](https://jsonresume.org/schema/)
 
+
+Alternatives: The Resume CLI tool works as it is so there isn't a huge amount of active development on it, try these alternatives if it doesn't work for you;
+- [Resumed](https://github.com/rbardini/resumed)
+
+
 # Getting Started
 
 Install the command-line tool:
@@ -23,7 +28,7 @@ npm install -g resume-cli
 | command                | description                               |
 | ---------------------- | ----------------------------------------- |
 | init                   | Initialize a `resume.json` file           |
-| test                   | Schema validation test your `resume.json` |
+| validate               | Schema validation test your `resume.json` |
 | export [fileName.html] | Export locally to `.html`                 |
 | serve                  | Serve resume at `http://localhost:4000/`  |
 
@@ -40,7 +45,7 @@ Creates a new `resume.json` file in your current working directory.
 Complete the `resume.json` with your text editor. Be sure to follow the schema
 (available at http://jsonresume.org).
 
-## `resume test`
+## `resume validate`
 
 Validates your `resume.json` against our schema tests to ensure it complies with
 the standard. Tries to identify where any errors may be occurring.

package/build/builder.js

@@ -0,0 +1,61 @@
+"use strict";
+
+const themeServer = process.env.THEME_SERVER || 'https://themes.jsonresume.org/theme/';
+
+const fs = require('fs');
+
+const request = require('superagent');
+
+const chalk = require('chalk');
+
+const renderHtml = require('./render-html').default;
+
+const denormalizeTheme = value => {
+  return value.match(/jsonresume-theme-(.*)/)[1];
+};
+
+const sendExportHTML = (resumeJson, theme, callback) => {
+  console.log(resumeJson, theme);
+  console.log('Requesting theme from server...');
+  request.post(themeServer + denormalizeTheme(theme)).send({
+    resume: resumeJson
+  }).set('Accept', 'application/json').end((err, response) => {
+    if (err) {
+      callback('There was an error downloading your generated html resume from our server: ' + err);
+    } else if (response.text) {
+      callback(null, response.text);
+    } else {
+      callback('There was an error downloading your generated html resume from our server.');
+    }
+  });
+};
+
+module.exports = function resumeBuilder(theme, dir, resumeFilename, cb) {
+  fs.readFile(resumeFilename, async (err, resumeJson) => {
+    if (err) {
+      console.log(chalk.yellow('Could not find:'), resumeFilename);
+      console.log(chalk.cyan('Using example resume.json from resume-schema instead...'));
+      resumeJson = require('resume-schema').resumeJson;
+    } else {
+      try {
+        // todo: test resume schema
+        resumeJson = JSON.parse(resumeJson);
+      } catch (e) {
+        err = 'Parse error: ' + resumeFilename;
+        return cb(err);
+      }
+    }
+
+    try {
+      const html = await renderHtml({
+        resume: resumeJson,
+        themePath: theme
+      });
+      cb(null, html);
+    } catch (err) {
+      console.log(err);
+      console.log(chalk.yellow('Could not run the render function from local theme.'));
+      sendExportHTML(resumeJson, theme, cb);
+    }
+  });
+};

package/{lib → build}/export-resume.js

@@ -1,16 +1,27 @@
-import renderHTML from './render-html';
-import { promisify } from 'util';
-import fs from 'fs';
+"use strict";
+
+var _renderHtml = _interopRequireDefault(require("./render-html"));
+
+var _util = require("util");
+
+var _fs = _interopRequireDefault(require("fs"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const writeFile = (0, _util.promisify)(_fs.default.writeFile);
 
-const writeFile = promisify(fs.writeFile);
 const path = require('path');
+
 const puppeteer = require('puppeteer');
+
 const btoa = require('btoa');
 
-module.exports = (
-  { resume: resumeJson, fileName, theme, format },
-  callback,
-) => {
+module.exports = ({
+  resume: resumeJson,
+  fileName,
+  theme,
+  format
+}, callback) => {
   if (!fileName) {
     console.error('Please enter a export destination.');
     process.exit(1);
@@ -20,18 +31,21 @@ module.exports = (
   fileName = fileNameAndFormat.fileName;
   const fileFormatToUse = fileNameAndFormat.fileFormatToUse;
   const formatToUse = '.' + fileFormatToUse;
+
   if (formatToUse === '.html') {
-    createHtml(resumeJson, fileName, theme, formatToUse, (error) => {
+    createHtml(resumeJson, fileName, theme, formatToUse, error => {
       if (error) {
         console.error(error, '`createHtml` errored out');
       }
+
       callback(error, fileName, formatToUse);
     });
   } else if (formatToUse === '.pdf') {
-    createPdf(resumeJson, fileName, theme, formatToUse, (error) => {
+    createPdf(resumeJson, fileName, theme, formatToUse, error => {
       if (error) {
         console.error(error, '`createPdf` errored out');
       }
+
       callback(error, fileName, formatToUse);
     });
   } else {
@@ -40,41 +54,49 @@ module.exports = (
   }
 };
 
-const extractFileFormat = (fileName) => {
+const extractFileFormat = fileName => {
   const dotPos = fileName.lastIndexOf('.');
+
   if (dotPos === -1) {
     return null;
   }
+
   return fileName.substring(dotPos + 1).toLowerCase();
 };
 
-const getThemePkg = (theme) => {
+const getThemePkg = theme => {
   if (theme[0] === '.') {
-    theme = path.join(process.cwd(), theme, 'index.js');
+    theme = path.join(process.cwd(), 'index.js');
+  } else {
+    theme = path.join(process.cwd(), 'node_modules', theme, 'index.js');
   }
+
   try {
     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 +
-        '`',
-    );
+    console.log('You have to install this theme relative to the folder to use it e.g. `npm install ' + theme + '`');
     process.exit();
   }
 };
 
 async function createHtml(resumeJson, fileName, themePath, format, callback) {
-  const html = await renderHTML({ resume: resumeJson, themePath });
+  const html = await (0, _renderHtml.default)({
+    resume: resumeJson,
+    themePath
+  });
   const pathToStream = path.resolve(process.cwd(), fileName + format);
   await writeFile(pathToStream, ''); // workaround for https://github.com/streamich/unionfs/issues/428
-  const stream = fs.createWriteStream(pathToStream);
+
+  const stream = _fs.default.createWriteStream(pathToStream);
+
   stream.write(html, () => {
     stream.close(callback);
   });
 }
+
 const createPdf = (resumeJson, fileName, theme, format, callback) => {
   (async () => {
     const themePkg = getThemePkg(theme);
@@ -84,39 +106,37 @@ const createPdf = (resumeJson, fileName, theme, format, callback) => {
       puppeteerLaunchArgs.push('--no-sandbox');
     }
 
-    const html = await renderHTML(resumeJson, theme);
+    const html = await (0, _renderHtml.default)({
+      resume: resumeJson,
+      themePath: theme
+    });
     const browser = await puppeteer.launch({
-      args: puppeteerLaunchArgs,
+      args: puppeteerLaunchArgs
     });
     const page = await browser.newPage();
+    await page.emulateMediaType(themePkg.pdfRenderOptions && themePkg.pdfRenderOptions.mediaType || 'screen');
+    await page.goto(`data:text/html;base64,${btoa(unescape(encodeURIComponent(html)))}`, {
+      waitUntil: 'networkidle0'
+    });
 
-    await page.emulateMediaType(
-      (themePkg.pdfRenderOptions && themePkg.pdfRenderOptions.mediaType) ||
-        'screen',
-    );
-    await page.goto(
-      `data:text/html;base64,${btoa(unescape(encodeURIComponent(html)))}`,
-      { waitUntil: 'networkidle0' },
-    );
     if (themePkg.pdfViewport) {
       await page.setViewport(themePkg.pdfViewport);
     }
+
     await page.pdf({
       path: fileName + format,
       format: 'Letter',
       printBackground: true,
-      ...themePkg.pdfRenderOptions,
+      ...themePkg.pdfRenderOptions
     });
-
     await browser.close();
-  })()
-    .then(callback)
-    .catch(callback);
+  })().then(callback).catch(callback);
 };
 
 const getFileNameAndFormat = (fileName, format) => {
   const fileFormatFound = extractFileFormat(fileName);
   let fileFormatToUse = format;
+
   if (format && fileFormatFound && format === fileFormatFound) {
     fileName = fileName.substring(0, fileName.lastIndexOf('.'));
   } else if (fileFormatFound) {
@@ -126,6 +146,6 @@ const getFileNameAndFormat = (fileName, format) => {
 
   return {
     fileName: fileName,
-    fileFormatToUse: fileFormatToUse,
+    fileFormatToUse: fileFormatToUse
   };
-};
+};

package/build/get-resume.js

@@ -0,0 +1,66 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _fs = _interopRequireDefault(require("fs"));
+
+var _mimeTypes = require("mime-types");
+
+var _path = require("path");
+
+var _quaff = _interopRequireDefault(require("quaff"));
+
+var _streamToString = _interopRequireDefault(require("stream-to-string"));
+
+var _yamlJs = _interopRequireDefault(require("yaml-js"));
+
+var _util = require("util");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const {
+  createReadStream
+} = _fs.default;
+const stat = (0, _util.promisify)(_fs.default.stat);
+const parsers = {
+  'text/yaml': string => _yamlJs.default.load(string),
+  'application/json': string => JSON.parse(string)
+};
+
+var _default = async ({
+  path,
+  mime: inputMime
+}) => {
+  let input;
+  let mime;
+
+  if ('-' === path) {
+    mime = inputMime || (0, _mimeTypes.lookup)('.json');
+    input = process.stdin;
+  } else if (path && (await stat(path)).isDirectory()) {
+    return (0, _quaff.default)(path);
+  }
+
+  if (!input) {
+    mime = inputMime || (0, _mimeTypes.lookup)(path);
+    input = createReadStream((0, _path.resolve)(process.cwd(), path));
+  }
+
+  if (!input) {
+    throw new Error('resume could not be gotten from path or stdin');
+  }
+
+  const resumeString = await (0, _streamToString.default)(input);
+  const parser = parsers[mime];
+
+  if (!parser) {
+    throw new Error(`no parser available for detected mime type ${mime}`);
+  }
+
+  return parser(resumeString);
+};
+
+exports.default = _default;

package/build/get-schema.js

@@ -0,0 +1,28 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _fs = require("fs");
+
+var _util = require("util");
+
+const readFile = (0, _util.promisify)(_fs.readFile);
+
+var _default = async ({
+  path: pathArg
+} = {}) => {
+  let path = pathArg;
+
+  if (!path) {
+    path = require.resolve('resume-schema/schema.json');
+  }
+
+  return JSON.parse(await readFile(path, {
+    encoding: 'utf-8'
+  }));
+};
+
+exports.default = _default;

package/build/init.js

@@ -0,0 +1,67 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _util = require("util");
+
+var _fs = _interopRequireDefault(require("fs"));
+
+var _chalk = _interopRequireDefault(require("chalk"));
+
+var _yesno = _interopRequireDefault(require("yesno"));
+
+var _objectPathImmutable = require("object-path-immutable");
+
+var _fileExists = _interopRequireDefault(require("file-exists"));
+
+var _read = _interopRequireDefault(require("read"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const writeFile = (0, _util.promisify)(_fs.default.writeFile);
+const read = (0, _util.promisify)(_read.default);
+
+const resume = require('resume-schema/sample.resume.json');
+
+var _default = async ({
+  resumePath
+}) => {
+  if (await (0, _fileExists.default)(resumePath)) {
+    console.log(_chalk.default.yellow('There is already a resume.json file in this directory.'));
+
+    if (!(await (0, _yesno.default)({
+      question: 'Do you want to override?'
+    }))) {
+      return;
+    }
+  }
+
+  console.log(`This utility will generate a file at ${resumePath}.`);
+  console.log('Fill out your name and email to get started, or leave the fields blank.');
+  console.log('All fields are optional.\n');
+  console.log('Press ^C at any time to quit.');
+  const name = await read({
+    prompt: 'name: '
+  });
+  const email = await read({
+    prompt: 'email: '
+  });
+  const personalizedResume = Object.entries({
+    name,
+    email
+  }).reduce((acc, [key, value]) => (0, _objectPathImmutable.set)(acc, `basics.${key}`, value), resume);
+  await writeFile(resumePath, JSON.stringify(personalizedResume, undefined, 2));
+  console.log(`Your resume has been created at ${resumePath}`);
+  console.log('');
+  console.log('To generate a formatted .html .md .txt or .pdf resume from your resume');
+  console.log('type: `resume export [someFileName]` including file extension eg: `resume export myresume.html`');
+  console.log('\nYou can optionally specify an available theme for html and pdf resumes using the --theme flag.');
+  console.log('Example: `resume export myresume.pdf --theme even`');
+  console.log('Or simply type: `resume export` and follow the prompts.');
+  console.log('');
+};
+
+exports.default = _default;

package/build/render-html.js

@@ -0,0 +1,58 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+const tryResolve = (...args) => {
+  try {
+    return require.resolve(...args);
+  } catch (err) {
+    return false;
+  }
+};
+
+var _default = async ({
+  resume,
+  themePath
+}) => {
+  const cwd = process.cwd();
+  let path;
+
+  if (themePath[0] === '.') {
+    path = tryResolve(require('path').join(cwd, themePath), {
+      paths: [cwd]
+    });
+
+    if (!path) {
+      throw new Error(`Theme ${themePath} could not be resolved relative to ${cwd}`);
+    }
+  }
+
+  if (!path) {
+    path = tryResolve(themePath, {
+      paths: [cwd]
+    });
+  }
+
+  if (!path && /^[a-z0-9]/i.test(path)) {
+    path = tryResolve(`jsonresume-theme-${themePath}`, {
+      paths: [cwd]
+    });
+  }
+
+  if (!path) {
+    throw new Error(`theme path ${themePath} could not be resolved from current working directory`);
+  }
+
+  const theme = require(path);
+
+  if (typeof (theme === null || theme === void 0 ? void 0 : theme.render) !== 'function') {
+    throw new Error('theme.render is not a function');
+  }
+
+  return theme.render(resume);
+};
+
+exports.default = _default;

package/{lib → build}/serve.js

@@ -1,6 +1,11 @@
+"use strict";
+
 const fs = require('fs');
+
 const path = require('path');
+
 const readline = require('readline');
+
 const bs = require('browser-sync').create();
 
 const builder = require('./builder');
@@ -13,10 +18,11 @@ const reBuildResume = (theme, dir, resumeFilename, cb) => {
       html = err;
     }
 
-    fs.writeFile(path.join(process.cwd(), dir, 'index.html'), html, (err) => {
+    fs.writeFile(path.join(process.cwd(), dir, 'index.html'), html, err => {
       if (err) {
         console.log(err);
       }
+
       cb();
     });
   });
@@ -27,7 +33,7 @@ module.exports = function ({
   theme,
   silent,
   dir,
-  resumeFilename,
+  resumeFilename
 }) {
   if (!fs.existsSync(dir)) {
     fs.mkdirSync(dir);
@@ -43,13 +49,12 @@ module.exports = function ({
       server: dir,
       port: port,
       open: !silent && 'local',
-      ui: false,
+      ui: false
     });
   });
-
   console.log('');
   const previewUrl = 'http://localhost:' + port;
   console.log('Preview: ' + previewUrl);
   console.log('Press ctrl-c to stop');
   console.log('');
-};
+};

package/build/validate.js

@@ -0,0 +1,36 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _util = require("util");
+
+var _zSchema = _interopRequireDefault(require("z-schema"));
+
+var _zSchemaErrors = _interopRequireDefault(require("z-schema-errors"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const reporter = _zSchemaErrors.default.init();
+
+const validator = new _zSchema.default();
+const validate = (0, _util.promisify)((...args) => validator.validate(...args)); // maintains context
+
+var _default = async ({
+  resume,
+  schema
+}) => {
+  try {
+    return await validate(resume, schema);
+  } catch (errors) {
+    throw new Error(reporter.extractMessage({
+      report: {
+        errors
+      }
+    }));
+  }
+};
+
+exports.default = _default;

package/package.json

@@ -1,20 +1,19 @@
 {
   "name": "resume-cli",
-  "version": "3.0.2",
+  "version": "3.0.6",
   "description": "The JSON Resume command line interface",
   "main": "index.js",
   "engines": {
     "node": ">=10.18.1"
   },
   "files": [
-    "index.js",
-    "lib/*"
+    "build/*",
+    "!test-utils",
+    "!*.test.js"
   ],
   "scripts": {
     "dev": "babel-node lib/main.js",
-    "format": "prettier --write .",
-    "format:check": "prettier --check .",
-    "lint": "eslint --ignore-path .gitignore lib",
+    "lint": "eslint --ignore-path .gitignore .",
     "_postinstall": "husky install",
     "prepublishOnly": "pinst --disable",
     "postpublish": "pinst --enable",
@@ -51,21 +50,23 @@
     "util.promisify": "^1.0.1",
     "yaml-js": "^0.2.3",
     "yesno": "^0.3.1",
-    "z-schema": "^4.2.3",
+    "z-schema": "^5.0.0",
     "z-schema-errors": "^0.2.1"
   },
   "devDependencies": {
     "@babel/cli": "7.12.10",
-    "@babel/core": "7.12.9",
+    "@babel/core": "7.12.10",
     "@babel/eslint-parser": "7.12.1",
-    "@babel/node": "7.12.6",
+    "@babel/node": "7.12.10",
     "@babel/plugin-proposal-optional-chaining": "7.12.7",
-    "@babel/preset-env": "7.12.10",
+    "@babel/preset-env": "7.12.11",
     "babel-eslint": "10.1.0",
     "babel-jest": "^26.6.3",
     "dedent": "0.7.0",
-    "eslint": "7.14.0",
+    "eslint": "7.15.0",
+    "eslint-config-prettier": "7.0.0",
     "eslint-plugin-jest": "24.1.3",
+    "eslint-plugin-prettier": "3.2.0",
     "flat": "5.0.2",
     "fs-monkey": "1.0.1",
     "husky": "5.0.6",