resume-cli 3.1.1 → 3.2.0

package/README.md

@@ -1,19 +1,15 @@
 # resume-cli
 
-[![matrix](https://img.shields.io/badge/matrix-join%20chat-%230dbd8b)](https://matrix.to/#/#json-resume:one.ems.host)
-[![Build status](https://img.shields.io/github/actions/workflow/status/jsonresume/resume-cli/test.yml?branch=master)](https://github.com/jsonresume/resume-cli/actions)
 [![npm package](https://badge.fury.io/js/resume-cli.svg)](https://www.npmjs.org/package/resume-cli)
 
 This is the command line tool for [JSON Resume](https://jsonresume.org), the open-source initiative to create a JSON-based standard for resumes.
 
-## Project Status
-
-This repository is not actively maintained. It's recommended to use one of the third-party clients that support the JSON Resume standard instead:
-
-* [Resumed](https://github.com/rbardini/resumed)
+> **Note:** `resume-cli` has been revived and now lives in the [jsonresume.org monorepo](https://github.com/jsonresume/jsonresume.org) as `packages/cli` (modernized for Node.js 18+). It keeps its npm identity as [`resume-cli`](https://www.npmjs.com/package/resume-cli) and is published from this workspace. The old standalone [jsonresume/resume-cli](https://github.com/jsonresume/resume-cli) repository is archived — please open issues and PRs against the monorepo.
 
 ## Getting Started
 
+Requires Node.js 18 or newer.
+
 Install the command-line tool:
 
 ```
@@ -91,6 +87,17 @@ Supported resume data MIME types are:
 - `application/json`
 - `text/yaml`
 
+## Development
+
+This package is part of the [jsonresume.org monorepo](https://github.com/jsonresume/jsonresume.org). From `packages/cli`:
+
+```
+pnpm dev    # run the CLI from source (babel-node lib/main.js)
+pnpm build  # compile lib/ to build/ with Babel
+pnpm test   # run the Jest test suite
+pnpm lint   # run ESLint
+```
+
 ## License
 
 Available under [the MIT license](http://mths.be/mit).

package/build/builder.js

@@ -28,7 +28,7 @@ module.exports = function resumeBuilder(theme, dir, resumeFilename, cb) {
     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;
+      resumeJson = require('@jsonresume/schema/sample.resume.json');
     } else {
       try {
         // todo: test resume schema

package/build/export-resume.js

@@ -3,7 +3,7 @@
 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 }; }
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const writeFile = (0, _util.promisify)(_fs.default.writeFile);
 const path = require('path');
 const puppeteer = require('puppeteer');

package/build/get-resume.js

@@ -11,7 +11,7 @@ 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 }; }
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const {
   createReadStream
 } = _fs.default;

package/build/get-resume.test.js

@@ -3,7 +3,7 @@
 var _waait = _interopRequireDefault(require("waait"));
 var _getResume = _interopRequireDefault(require("./get-resume"));
 var _mockStdin = require("mock-stdin");
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 jest.mock('fs', () => {
   const build = require('./test-utils/mocked-volume-builder');
   const {
@@ -17,8 +17,8 @@ describe('get-resume', () => {
     expect(await (0, _getResume.default)({
       path: '/resume.yaml'
     })).toMatchInlineSnapshot(`
-      Object {
-        "basics": Object {
+      {
+        "basics": {
           "email": "thomas@example.com",
           "name": "thomas",
         },
@@ -29,25 +29,25 @@ describe('get-resume', () => {
     expect(await (0, _getResume.default)({
       path: '/resume.json'
     })).toMatchInlineSnapshot(`
-        Object {
-          "basics": Object {
-            "email": "thomas@example.com",
-            "name": "thomas",
-          },
-        }
-      `);
+      {
+        "basics": {
+          "email": "thomas@example.com",
+          "name": "thomas",
+        },
+      }
+    `);
   });
   it('should consume an entire directory as if it were a json object', async () => {
     expect(await (0, _getResume.default)({
       path: '/quaff'
     })).toMatchInlineSnapshot(`
-      Object {
-        "basics": Object {
+      {
+        "basics": {
           "email": "thomas@example.com",
           "name": "thomas",
         },
-        "work": Array [
-          Object {
+        "work": [
+          {
             "company": "Pied Piper",
             "endDate": "2014-12-01",
             "position": "CEO/President",
@@ -71,8 +71,8 @@ describe('get-resume', () => {
     }));
     stdin.send(null);
     expect(await gotResume).toMatchInlineSnapshot(`
-      Object {
-        "basics": Object {
+      {
+        "basics": {
           "email": "thomas@example.com",
           "name": "thomas",
         },

package/build/get-schema.js

@@ -12,7 +12,7 @@ var _default = async ({
 } = {}) => {
   let path = pathArg;
   if (!path) {
-    path = require.resolve('resume-schema/schema.json');
+    path = require.resolve('@jsonresume/schema/schema.json');
   }
   return JSON.parse(await readFile(path, {
     encoding: 'utf-8'

package/build/init.js

@@ -11,10 +11,10 @@ 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 }; }
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const writeFile = (0, _util.promisify)(_fs.default.writeFile);
 const read = (0, _util.promisify)(_read.default);
-const resume = require('resume-schema/sample.resume.json');
+const resume = require('@jsonresume/schema/sample.resume.json');
 var _default = async ({
   resumePath
 }) => {

package/build/main.js

@@ -6,7 +6,7 @@ var _init = _interopRequireDefault(require("./init"));
 var _getResume = _interopRequireDefault(require("./get-resume"));
 var _getSchema = _interopRequireDefault(require("./get-schema"));
 var _validate = _interopRequireDefault(require("./validate"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const pkg = require('../package.json');
 const exportResume = require('./export-resume');
 const serve = require('./serve');
@@ -22,7 +22,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-even').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>', '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.command('init').description('Initialize a resume.json file').action(async () => {
     await (0, _init.default)({
       resumePath: program.resume

package/build/main.test.js

@@ -4,7 +4,7 @@ var _child_process = require("child_process");
 var _streamToString = _interopRequireDefault(require("stream-to-string"));
 var _util = require("util");
 var _package = _interopRequireDefault(require("../package.json"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const exec = (0, _util.promisify)(_child_process.exec);
 const run = async (argv, {
   waitForVolumeExport = true,
@@ -57,17 +57,17 @@ describe('cli configuration', () => {
                                             \`serve\` or specify a path starting with .
                                             (use . for current directory or
                                             ../some/other/dir) (default:
-                                            \\"jsonresume-theme-even\\")
+                                            "jsonresume-theme-elegant")
         -f, --format <file type extension>  Used by \`export\`.
         -r, --resume <resume filename>      path to the resume in json format. Use
                                             '-' to read from stdin (default:
-                                            \\"resume.json\\")
+                                            "resume.json")
         -p, --port <port>                   Used by \`serve\` (default: 4000) (default:
                                             4000)
         -s, --silent                        Used by \`serve\` to tell it if open
                                             browser auto or not. (default: false)
         -d, --dir <path>                    Used by \`serve\` to indicate a public
-                                            directory path. (default: \\"public\\")
+                                            directory path. (default: "public")
         --schema <relativePath>             Used by \`validate\` to validate against a
                                             custom schema.
         -h, --help                          display help for command
@@ -105,8 +105,12 @@ describe('cli configuration', () => {
       const {
         stdout,
         volume
-      } = await run(['export', '/test-resumes/exported-resume-from-stdin.html', '--resume', '-' // this is the dash
-      ], {
+      } = await run(['export', '/test-resumes/exported-resume-from-stdin.html', '--resume', '-',
+      // this is the dash
+      // The default theme (elegant) throws on resumes missing a
+      // `basics.location`; `even` renders minimal resumes, and this test
+      // only exercises the export plumbing, not a specific theme.
+      '--theme', 'even'], {
         stdin: JSON.stringify({
           basics: {
             name: 'thomas-from-stdin'
@@ -124,7 +128,10 @@ describe('cli configuration', () => {
     it('should export a resume from the path specified by --resume to the path specified immediately after the export command', async () => {
       const {
         stdout
-      } = await run(['export', '/test-resumes/exported-resume.html', '--resume', '/test-resumes/resume.json']);
+      } = await run(['export', '/test-resumes/exported-resume.html', '--resume', '/test-resumes/resume.json',
+      // See note above: `even` renders minimal resumes; the default
+      // `elegant` theme requires a `basics.location`.
+      '--theme', 'even']);
       expect(stdout).toMatchInlineSnapshot(`
         "
         Done! Find your new .html resume at:

package/build/render-html.js

@@ -39,7 +39,7 @@ var _default = async ({
     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') {
+  if (typeof theme?.render !== 'function') {
     throw new Error('theme.render is not a function');
   }
   return theme.render(resume);

package/build/render-html.test.js

@@ -1,7 +1,7 @@
 "use strict";
 
 var _renderHtml = _interopRequireDefault(require("./render-html"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 describe('renderHTML', () => {
   beforeAll(() => {
     const originalRequireResolve = require.resolve;

package/build/serve.js

@@ -6,6 +6,12 @@ const readline = require('readline');
 const bs = require('browser-sync').create();
 const builder = require('./builder');
 const reBuildResume = (theme, dir, resumeFilename, cb) => {
+  console.log({
+    theme,
+    dir,
+    resumeFilename,
+    cb
+  });
   builder(theme, dir, resumeFilename, (err, html) => {
     if (err) {
       readline.cursorTo(process.stdout, 0);

package/build/test-utils/cli-test-entry.js

@@ -4,9 +4,8 @@ var _mockedVolumeBuilder = _interopRequireDefault(require("./mocked-volume-build
 var _fsMonkey = require("fs-monkey");
 var _unionfs = require("unionfs");
 var fs = _interopRequireWildcard(require("fs"));
-function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function () { return cache; }; return cache; }
-function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const mockVolume = (0, _mockedVolumeBuilder.default)({
   mount: '/test-resumes'
 });

package/build/test-utils/mocked-volume-builder.js

@@ -14,8 +14,9 @@ module.exports = ({
     }),
     'only-number.json': '123',
     'invalid-resume.json': JSON.stringify({
-      notAValidKey: {
-        foo: 'bar'
+      basics: {
+        // name must be a string per the JSON Resume schema
+        name: 123
       }
     }),
     'resume.json': JSON.stringify({

package/build/validate.js

@@ -4,25 +4,35 @@ 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 _ajv = _interopRequireDefault(require("ajv"));
+var _ajvFormats = _interopRequireDefault(require("ajv-formats"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+// Format a single Ajv error into a readable `field message` line.
+const formatError = error => {
+  // instancePath is like "/basics/name"; the root is an empty string.
+  const field = error.instancePath ? `data${error.instancePath}` : 'data';
+  if (error.keyword === 'additionalProperties') {
+    return `${field} ${error.message} (${error.params.additionalProperty})`;
+  }
+  return `${field} ${error.message}`;
+};
 var _default = async ({
   resume,
   schema
 }) => {
-  try {
-    return await validate(resume, schema);
-  } catch (errors) {
-    throw new Error(reporter.extractMessage({
-      report: {
-        errors
-      }
-    }));
+  // strict:false is required: the JSON Resume schema is an externally authored
+  // draft-07 document that uses keywords (e.g. additionalItems without an
+  // array `items`) that Ajv's strict mode would otherwise reject.
+  const ajv = new _ajv.default({
+    allErrors: true,
+    strict: false
+  });
+  (0, _ajvFormats.default)(ajv);
+  const validateFn = ajv.compile(schema);
+  if (validateFn(resume)) {
+    return true;
   }
+  const details = (validateFn.errors || []).map(formatError).join('\n  ');
+  throw new Error(`Invalid resume:\n  ${details}`);
 };
 exports.default = _default;

package/build/validate.test.js

@@ -2,7 +2,7 @@
 
 var _validate = _interopRequireDefault(require("./validate"));
 var _getSchema = _interopRequireDefault(require("./get-schema"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 describe('validate', () => {
   let defaultSchema;
   beforeEach(async () => {
@@ -16,13 +16,18 @@ describe('validate', () => {
       schema: defaultSchema
     });
   });
-  it('should throw an error for an invalid resume object', async () => {
+  it('should throw a per-field error for an invalid resume object', async () => {
     await expect((0, _validate.default)({
       resume: {
-        notInTheSchema: true
+        basics: {
+          name: 123
+        }
       },
       schema: defaultSchema
-    })).rejects.toMatchInlineSnapshot(`[Error: An error occurred 'Additional properties not allowed: notInTheSchema'.]`);
+    })).rejects.toMatchInlineSnapshot(`
+      [Error: Invalid resume:
+        data/basics/name must be string]
+    `);
   });
   it('should accept a schema override', async () => {
     await (0, _validate.default)({
@@ -36,6 +41,9 @@ describe('validate', () => {
       schema: {
         type: 'number'
       }
-    })).rejects.toMatchInlineSnapshot(`[Error: An error occurred 'Expected type number but found type string'.]`);
+    })).rejects.toMatchInlineSnapshot(`
+      [Error: Invalid resume:
+        data must be number]
+    `);
   });
 });

package/package.json

@@ -1,25 +1,16 @@
 {
   "name": "resume-cli",
-  "version": "3.1.1",
+  "version": "3.2.0",
   "description": "The JSON Resume command line interface",
-  "main": "index.js",
+  "main": "build/main.js",
   "engines": {
-    "node": ">=12 <18"
+    "node": ">=18"
   },
   "files": [
     "build/*",
     "!test-utils",
     "!*.test.js"
   ],
-  "scripts": {
-    "dev": "babel-node lib/main.js",
-    "lint": "eslint --ignore-path .gitignore .",
-    "_postinstall": "husky install",
-    "prepublishOnly": "pinst --disable",
-    "postpublish": "pinst --enable",
-    "prepare": "babel lib -d build --copy-files",
-    "test": "jest"
-  },
   "repository": {
     "type": "git",
     "url": "https://github.com/jsonresume/resume-cli.git"
@@ -29,6 +20,8 @@
     "resume": "build/main.js"
   },
   "dependencies": {
+    "ajv": "^8.17.1",
+    "ajv-formats": "^3.0.1",
     "async": "^3.2.0",
     "browser-sync": "^2.29.3",
     "btoa": "^1.2.1",
@@ -37,29 +30,26 @@
     "dotenv": "^8.2.0",
     "file-exists": "^5.0.1",
     "jest-extended": "^0.11.5",
-    "jsonresume-theme-even": "^0.6.0",
+    "jsonresume-theme-elegant": "^1.16.1",
+    "jsonresume-theme-even": "0.6.0",
     "mime-types": "^2.1.27",
     "object-path-immutable": "^4.1.1",
-    "puppeteer": "^18.2.1",
+    "puppeteer": "^23.0.0",
     "quaff": "^4.2.0",
     "read": "^1.0.7",
-    "resume-schema": "^1.0.0",
     "stream-to-string": "^1.2.1",
     "superagent": "^6.0.0",
     "yaml-js": "^0.2.3",
     "yesno": "^0.3.1",
-    "z-schema": "^5.0.0",
-    "z-schema-errors": "^0.2.1"
+    "@jsonresume/schema": "1.2.1"
   },
   "devDependencies": {
-    "@babel/cli": "7.12.10",
-    "@babel/core": "7.12.10",
-    "@babel/eslint-parser": "7.12.1",
-    "@babel/node": "7.12.10",
-    "@babel/plugin-proposal-optional-chaining": "7.12.7",
-    "@babel/preset-env": "7.12.11",
-    "babel-eslint": "10.1.0",
-    "babel-jest": "28.1.2",
+    "@babel/cli": "^7.25.0",
+    "@babel/core": "^7.25.0",
+    "@babel/eslint-parser": "^7.25.0",
+    "@babel/node": "^7.25.0",
+    "@babel/preset-env": "^7.25.0",
+    "babel-jest": "^29.7.0",
     "dedent": "0.7.0",
     "eslint": "7.15.0",
     "eslint-config-prettier": "7.0.0",
@@ -67,13 +57,17 @@
     "eslint-plugin-prettier": "3.2.0",
     "flat": "5.0.2",
     "fs-monkey": "1.0.1",
-    "husky": "5.0.6",
-    "jest": "28.1.2",
-    "lint-staged": "10.5.3",
-    "memfs": "3.2.0",
+    "jest": "^29.7.0",
+    "memfs": "3.6.0",
     "mock-stdin": "1.0.0",
     "prettier": "2.2.1",
     "unionfs": "4.4.0",
     "waait": "1.0.5"
+  },
+  "scripts": {
+    "dev": "babel-node lib/main.js",
+    "lint": "eslint --ignore-path .gitignore .",
+    "build": "babel lib -d build --copy-files",
+    "test": "jest"
   }
-}
+}