resume-cli 3.5.0 → 3.6.0

package/README.md

@@ -25,6 +25,7 @@ npm install -g resume-cli
 | init | Initialize a `resume.json` file. |
 | validate | Schema validation test your `resume.json`. |
 | export path/to/file.html | Export to `.html`, `.pdf`, `.md` or `.txt`. |
+| themes | List the JSON Resume themes installed in `node_modules`. |
 | serve | Serve resume at `http://localhost:4000/`. |
 
 ### `resume --help`
@@ -104,6 +105,27 @@ Options:
 - `--format <file type>` Example: `--format pdf`
 - `--theme <name>` Example: `--theme even` (only used for `.html` / `.pdf`)
 
+### `resume themes`
+
+Lists the JSON Resume themes installed in `node_modules` — both in your project
+and globally — so you don't have to know a theme slug ahead of time. It prints
+the slug to pass to `--theme` for `export` / `serve`:
+
+```
+$ resume themes
+Installed themes (2) — pass the slug to --theme:
+  elegant v1.16.1
+  even    v0.6.0
+
+Use it:         resume export resume.html --theme elegant
+Browse the full gallery:  https://jsonresume.org/themes/
+```
+
+If none are installed yet, it points you at how to install one. Discovery is
+local and network-free; browse the full gallery (with screenshots) at
+https://jsonresume.org/themes/ and `npm install jsonresume-theme-<slug>` the one
+you want.
+
 ### `resume serve`
 
 Starts a web server that serves your local `resume.json`. It will live reload when you make changes to your `resume.json`.

package/build/list-themes.js

@@ -0,0 +1,139 @@
+"use strict";
+
+const fs = require('fs');
+const path = require('path');
+const chalk = require('chalk');
+const THEME_PREFIX = 'jsonresume-theme-';
+
+// Read a theme package's `package.json` (best effort). Returns null if the
+// directory is not a readable npm package — keeps discovery dependency-free
+// and resilient to half-installed/broken folders.
+const readThemePkg = themeDir => {
+  try {
+    const raw = fs.readFileSync(path.join(themeDir, 'package.json'), 'utf8');
+    return JSON.parse(raw);
+  } catch (err) {
+    return null;
+  }
+};
+
+// List the immediate child directories of a node_modules folder that look like
+// JSON Resume theme packages (`jsonresume-theme-*`). Returns one entry per
+// theme with its slug (the name passed to `--theme`), full package name,
+// version and description. Missing/unreadable folders yield an empty list.
+const listThemesInDir = nodeModulesDir => {
+  let entries;
+  try {
+    entries = fs.readdirSync(nodeModulesDir, {
+      withFileTypes: true
+    });
+  } catch (err) {
+    return [];
+  }
+  const themes = [];
+  for (const entry of entries) {
+    // Tolerate environments where `withFileTypes` is unavailable.
+    const name = entry.name || entry;
+    if (typeof name !== 'string' || !name.startsWith(THEME_PREFIX)) {
+      continue;
+    }
+    // Ignore the prefix itself with nothing after it.
+    const slug = name.slice(THEME_PREFIX.length);
+    if (!slug) {
+      continue;
+    }
+    const pkg = readThemePkg(path.join(nodeModulesDir, name));
+    if (!pkg) {
+      continue;
+    }
+    themes.push({
+      slug,
+      name,
+      version: typeof pkg.version === 'string' ? pkg.version : null,
+      description: typeof pkg.description === 'string' ? pkg.description : null
+    });
+  }
+  return themes;
+};
+
+// Build the list of `node_modules` directories to scan: every `node_modules`
+// from `cwd` up to the filesystem root (covers local + monorepo installs),
+// plus any directories supplied via `extraNodeModules` (e.g. the global root).
+const candidateNodeModules = (cwd, extraNodeModules) => {
+  const dirs = [];
+  let current = path.resolve(cwd);
+  // Walk up the tree collecting node_modules at each level.
+  // eslint-disable-next-line no-constant-condition
+  while (true) {
+    dirs.push(path.join(current, 'node_modules'));
+    const parent = path.dirname(current);
+    if (parent === current) {
+      break;
+    }
+    current = parent;
+  }
+  for (const extra of extraNodeModules) {
+    if (extra) {
+      dirs.push(extra);
+    }
+  }
+  return dirs;
+};
+
+// Discover installed JSON Resume themes.
+//
+// Scans `node_modules` from the current working directory up the tree plus any
+// `extraNodeModules` (the global install root by default) for
+// `jsonresume-theme-*` packages. Returns a list of unique themes sorted by
+// slug. The first occurrence of a slug wins, so a project-local install
+// shadows a global one — matching how `require.resolve` would pick a theme.
+//
+// Pure and network-free: callers inject `cwd` and `extraNodeModules` in tests.
+const discoverThemes = ({
+  cwd = process.cwd(),
+  extraNodeModules = []
+} = {}) => {
+  const seen = new Set();
+  const themes = [];
+  for (const dir of candidateNodeModules(cwd, extraNodeModules)) {
+    for (const theme of listThemesInDir(dir)) {
+      if (seen.has(theme.slug)) {
+        continue;
+      }
+      seen.add(theme.slug);
+      themes.push(theme);
+    }
+  }
+  themes.sort((a, b) => a.slug.localeCompare(b.slug));
+  return themes;
+};
+
+// Render the discovered themes as a clean, copy-pasteable block. Each line
+// shows the slug to pass to `--theme`. When nothing is installed we point the
+// user at how to install a theme; either way we link the full gallery.
+const formatThemesList = themes => {
+  const lines = [];
+  if (themes.length === 0) {
+    lines.push(chalk.yellow('No JSON Resume themes found in node_modules.'));
+    lines.push(`Install one:    ${chalk.cyan('npm install jsonresume-theme-even')}`);
+  } else {
+    const count = themes.length;
+    lines.push(chalk.bold(`Installed themes (${count}) — pass the slug to ${chalk.cyan('--theme')}:`));
+    const width = themes.reduce((max, t) => Math.max(max, t.slug.length), 0);
+    for (const theme of themes) {
+      const slug = chalk.green(theme.slug.padEnd(width));
+      const version = theme.version ? chalk.dim(` v${theme.version}`) : '';
+      lines.push(`  ${slug}${version}`);
+    }
+    lines.push('');
+    lines.push(`Use it:         ${chalk.cyan(`resume export resume.html --theme ${themes[0].slug}`)}`);
+  }
+  lines.push(`Browse the full gallery:  ${chalk.cyan('https://jsonresume.org/themes/')}`);
+  return lines.join('\n');
+};
+module.exports = {
+  THEME_PREFIX,
+  discoverThemes,
+  listThemesInDir,
+  formatThemesList
+};

package/build/list-themes.test.js

@@ -0,0 +1,168 @@
+"use strict";
+
+var _fs = _interopRequireDefault(require("fs"));
+var _os = _interopRequireDefault(require("os"));
+var _path = _interopRequireDefault(require("path"));
+var _listThemes = require("./list-themes");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+// Build a throwaway project directory on the real filesystem whose
+// `node_modules` mirrors a typical install: a couple of real themes, a broken
+// theme folder (no package.json), and unrelated packages that must be ignored.
+const buildFixtureProject = () => {
+  const root = _fs.default.mkdtempSync(_path.default.join(_os.default.tmpdir(), 'resume-cli-themes-'));
+  const nodeModules = _path.default.join(root, 'node_modules');
+  const writePkg = (dirName, pkg) => {
+    const dir = _path.default.join(nodeModules, dirName);
+    _fs.default.mkdirSync(dir, {
+      recursive: true
+    });
+    if (pkg) {
+      _fs.default.writeFileSync(_path.default.join(dir, 'package.json'), JSON.stringify(pkg));
+    }
+  };
+
+  // Two valid themes (out of alphabetical order to prove sorting).
+  writePkg('jsonresume-theme-even', {
+    name: 'jsonresume-theme-even',
+    version: '0.6.0',
+    description: 'A flat JSON Resume theme.'
+  });
+  writePkg('jsonresume-theme-elegant', {
+    name: 'jsonresume-theme-elegant',
+    version: '1.16.1'
+  });
+  // A theme-prefixed folder with no package.json — half-installed/broken;
+  // must be skipped, not crash discovery.
+  writePkg('jsonresume-theme-broken', null);
+  // Non-theme packages that must never appear in the list.
+  writePkg('chalk', {
+    name: 'chalk',
+    version: '4.1.0'
+  });
+  writePkg('jsonresume-other', {
+    name: 'jsonresume-other',
+    version: '1.0.0'
+  });
+  return {
+    root,
+    nodeModules
+  };
+};
+describe('list-themes discovery', () => {
+  let fixture;
+  beforeAll(() => {
+    fixture = buildFixtureProject();
+  });
+  afterAll(() => {
+    _fs.default.rmSync(fixture.root, {
+      recursive: true,
+      force: true
+    });
+  });
+  it('lists installed jsonresume-theme-* packages by slug, sorted', () => {
+    const themes = (0, _listThemes.discoverThemes)({
+      cwd: fixture.root
+    });
+    expect(themes.map(t => t.slug)).toEqual(['elegant', 'even']);
+  });
+  it('ignores non-theme packages and broken theme folders', () => {
+    const slugs = (0, _listThemes.discoverThemes)({
+      cwd: fixture.root
+    }).map(t => t.slug);
+    expect(slugs).not.toContain('broken');
+    expect(slugs).not.toContain('other');
+    expect(slugs).not.toContain('chalk');
+  });
+  it('captures the package name, version and description of each theme', () => {
+    const themes = (0, _listThemes.discoverThemes)({
+      cwd: fixture.root
+    });
+    const even = themes.find(t => t.slug === 'even');
+    expect(even).toEqual({
+      slug: 'even',
+      name: 'jsonresume-theme-even',
+      version: '0.6.0',
+      description: 'A flat JSON Resume theme.'
+    });
+    // A theme without a description still resolves, with description null.
+    const elegant = themes.find(t => t.slug === 'elegant');
+    expect(elegant.version).toEqual('1.16.1');
+    expect(elegant.description).toBeNull();
+  });
+  it('returns an empty list when node_modules is missing', () => {
+    const empty = _fs.default.mkdtempSync(_path.default.join(_os.default.tmpdir(), 'resume-cli-empty-'));
+    try {
+      expect((0, _listThemes.discoverThemes)({
+        cwd: empty
+      })).toEqual([]);
+    } finally {
+      _fs.default.rmSync(empty, {
+        recursive: true,
+        force: true
+      });
+    }
+  });
+  it('de-duplicates a slug installed in multiple node_modules (local wins)', () => {
+    // A second node_modules (e.g. a global root) also ships `even`, plus a
+    // theme not present locally. The local `even` should win; `global-only`
+    // should be added.
+    const globalRoot = _fs.default.mkdtempSync(_path.default.join(_os.default.tmpdir(), 'resume-cli-global-'));
+    try {
+      const writeGlobalPkg = (dirName, pkg) => {
+        const dir = _path.default.join(globalRoot, dirName);
+        _fs.default.mkdirSync(dir, {
+          recursive: true
+        });
+        _fs.default.writeFileSync(_path.default.join(dir, 'package.json'), JSON.stringify(pkg));
+      };
+      writeGlobalPkg('jsonresume-theme-even', {
+        name: 'jsonresume-theme-even',
+        version: '9.9.9'
+      });
+      writeGlobalPkg('jsonresume-theme-global-only', {
+        name: 'jsonresume-theme-global-only',
+        version: '2.0.0'
+      });
+      const themes = (0, _listThemes.discoverThemes)({
+        cwd: fixture.root,
+        extraNodeModules: [globalRoot]
+      });
+      const slugs = themes.map(t => t.slug);
+      expect(slugs).toEqual(['elegant', 'even', 'global-only']);
+      // Local install shadows the global one (version stays 0.6.0).
+      expect(themes.find(t => t.slug === 'even').version).toEqual('0.6.0');
+    } finally {
+      _fs.default.rmSync(globalRoot, {
+        recursive: true,
+        force: true
+      });
+    }
+  });
+  it('listThemesInDir returns [] for a non-existent directory', () => {
+    expect((0, _listThemes.listThemesInDir)('/no/such/dir/node_modules')).toEqual([]);
+  });
+});
+describe('formatThemesList', () => {
+  it('prints each slug and a usage example when themes are installed', () => {
+    const output = (0, _listThemes.formatThemesList)([{
+      slug: 'elegant',
+      name: 'jsonresume-theme-elegant',
+      version: '1.16.1'
+    }, {
+      slug: 'even',
+      name: 'jsonresume-theme-even',
+      version: '0.6.0'
+    }]);
+    expect(output).toContain('Installed themes (2)');
+    expect(output).toContain('elegant');
+    expect(output).toContain('even');
+    expect(output).toContain('--theme elegant');
+    expect(output).toContain('https://jsonresume.org/themes/');
+  });
+  it('prints an install hint and the gallery link when nothing is installed', () => {
+    const output = (0, _listThemes.formatThemesList)([]);
+    expect(output).toContain('No JSON Resume themes found');
+    expect(output).toContain('npm install jsonresume-theme-even');
+    expect(output).toContain('https://jsonresume.org/themes/');
+  });
+});

package/build/main.js

@@ -20,6 +20,25 @@ const {
 const {
   formatOkSummary
 } = require('./validate-errors');
+const {
+  discoverThemes,
+  formatThemesList
+} = require('./list-themes');
+
+// Best-effort guess at the global `node_modules` root so `resume themes` also
+// surfaces globally-installed themes (e.g. `npm install -g`). Derived from the
+// node executable path; no network or extra dependency required.
+const globalNodeModules = () => {
+  try {
+    // <prefix>/bin/node -> <prefix>/lib/node_modules (POSIX),
+    // <prefix>/node.exe -> <prefix>/node_modules (Windows).
+    const binDir = path.dirname(process.execPath);
+    const candidates = [path.join(binDir, '..', 'lib', 'node_modules'), path.join(binDir, 'node_modules')];
+    return candidates;
+  } catch (err) {
+    return [];
+  }
+};
 const normalizeTheme = (value, defaultValue) => {
   const theme = value || defaultValue;
   // TODO - This is not great, but bypasses this function if it is a relative path
@@ -74,6 +93,13 @@ const normalizeTheme = (value, defaultValue) => {
       console.log(chalk.green('\nDone! Find your new', format, 'resume at:\n', path.resolve(process.cwd(), fileName + format)));
     });
   });
+  program.command('themes').description('List JSON Resume themes installed in node_modules (the slug to pass to --theme). Browse the full gallery at https://jsonresume.org/themes/.').action(async () => {
+    const themes = discoverThemes({
+      cwd: process.cwd(),
+      extraNodeModules: globalNodeModules()
+    });
+    console.log(formatThemesList(themes));
+  });
   program.command('serve').description('Serve resume at http://localhost:4000/').action(async () => {
     serve({
       ...program,

package/build/main.test.js

@@ -90,6 +90,10 @@ describe('cli configuration', () => {
                                             need no theme; pick a theme for
                                             .html/.pdf with --theme
                                             (https://jsonresume.org/themes/).
+        themes                              List JSON Resume themes installed in
+                                            node_modules (the slug to pass to
+                                            --theme). Browse the full gallery at
+                                            https://jsonresume.org/themes/.
         serve                               Serve resume at http://localhost:4000/
         help [command]                      display help for command
       "
@@ -139,6 +143,23 @@ describe('cli configuration', () => {
       `);
     });
   });
+  describe('themes', () => {
+    it('lists installed themes by slug and links the gallery', async () => {
+      const {
+        stdout,
+        code
+      } = await run(['themes'], {
+        waitForVolumeExport: false
+      });
+      expect(code).toEqual(0);
+      // The CLI bundles the `elegant` and `even` themes as dependencies, so
+      // they are always discoverable from the package's node_modules.
+      expect(stdout).toContain('elegant');
+      expect(stdout).toContain('even');
+      expect(stdout).toContain('--theme');
+      expect(stdout).toContain('https://jsonresume.org/themes/');
+    });
+  });
   describe('export', () => {
     it('should read from stdin when path is a dash', async () => {
       const {

package/package.json

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