resuml 1.2.5 → 1.3.0

package/README.md

@@ -1,6 +1,60 @@
-# resuml
+<h1 align="center">✨ Resuml</h1>
+<p align="center"><strong>Write your resume in YAML. Render it beautifully.</strong></p>
 
-A CLI tool for generating JSON resumes from YAML with theme support. This tool helps you maintain your resume in YAML format and convert it to various formats including JSON and HTML with different themes.
+<p align="center">
+  <a href="https://www.npmjs.com/package/resuml"><img src="https://img.shields.io/npm/v/resuml.svg" alt="npm version"></a>
+  <a href="https://www.npmjs.com/package/resuml"><img src="https://img.shields.io/npm/dm/resuml.svg" alt="npm downloads"></a>
+  <a href="https://github.com/phoinixi/resuml/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/resuml.svg" alt="license"></a>
+  <a href="https://github.com/phoinixi/resuml"><img src="https://img.shields.io/github/stars/phoinixi/resuml.svg?style=social" alt="GitHub stars"></a>
+</p>
+
+<p align="center">
+   <a href="https://www.buymeacoffee.com/leekbeds55j">
+      <img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" width="150" />
+   </a>
+</p>
+
+---
+
+### YAML in → Beautiful resume out
+
+```yaml
+# resume.yaml
+basics:
+  name: Jane Smith
+  label: Senior Software Engineer
+  email: jane@example.com
+  summary: >-
+    Passionate engineer with 8+ years
+    building scalable distributed systems.
+work:
+  - name: Acme Corp
+    position: Lead Engineer
+    startDate: 2020-01-15
+    highlights:
+      - Reduced deploy time by 60%
+      - Led team of 12 engineers
+```
+
+```bash
+resuml render --resume resume.yaml --theme stackoverflow --output resume.html
+```
+
+Your YAML becomes a polished, professional resume — ready to share, print, or export to PDF.
+
+---
+
+## Why YAML?
+
+| | YAML | JSON |
+|---|---|---|
+| **Comments** | ✅ `# explain your choices` | ❌ Not supported |
+| **Multi-line strings** | ✅ `summary: >-` block syntax | ❌ Escape everything |
+| **Readability** | ✅ Clean, minimal syntax | ⚠️ Brackets & quotes everywhere |
+| **Diffing** | ✅ Clean git diffs | ⚠️ Noisy diffs |
+| **Compatibility** | ✅ Valid JSON Resume schema | ✅ Native |
+
+YAML is a superset of JSON — your resume stays fully compatible with the [JSON Resume](https://jsonresume.org/) ecosystem while being far more pleasant to write and maintain.
 
 ## Prerequisites
 
@@ -29,44 +83,48 @@ npm install -g resuml
    resuml render --resume resume.yaml --theme stackoverflow --output resume.html
    ```
 
-## Usage
+## Commands
 
-### Validate resume data
+| Command | Description |
+|---------|-------------|
+| `validate` | Validate resume data against the JSON Resume schema |
+| `tojson` | Convert YAML resume data to JSON format |
+| `render` | Render the resume using a specified theme |
+| `dev` | Start a development server with hot-reload |
 
-```bash
-resuml validate --resume resume.yaml
-```
+## Options
 
-### Convert YAML to JSON
+| Option | Alias | Description |
+|--------|-------|-------------|
+| `--resume` | `-r` | Input YAML file(s) or directory |
+| `--output` | `-o` | Output file path |
+| `--theme` | `-t` | Theme to use for rendering |
+| `--port` | `-p` | Port for dev server (default: 3000) |
+| `--language` | | Language code for localization (default: `en`) |
+| `--debug` | | Enable debug mode for detailed errors |
 
-```bash
-resuml tojson --resume resume.yaml --output resume.json
-```
+## Compatible Themes
 
-### Render resume with theme
+Resuml supports themes from the JSON Resume ecosystem. Install a theme, then pass its name to `--theme`:
 
 ```bash
-resuml render --resume resume.yaml --theme stackoverflow --output resume.html
+npm install jsonresume-theme-stackoverflow
+resuml render --resume resume.yaml --theme stackoverflow
 ```
 
-## Examples
-
-For detailed examples and usage instructions, see the [examples/README.md](examples/README.md) file.
+| Theme | Install | Style |
+|-------|---------|-------|
+| [stackoverflow](https://github.com/francoislaberge/jsonresume-theme-stackoverflow) | `npm i jsonresume-theme-stackoverflow` | Clean, professional |
+| [elegant](https://github.com/mudassir0909/jsonresume-theme-elegant) | `npm i jsonresume-theme-elegant` | Modern, elegant |
+| [kendall](https://github.com/LinuxBozo/jsonresume-theme-kendall) | `npm i jsonresume-theme-kendall` | Minimal, classic |
+| [flat](https://github.com/erming/jsonresume-theme-flat) | `npm i jsonresume-theme-flat` | Flat design |
+| [onepage](https://github.com/aonemd/jsonresume-theme-onepage) | `npm i jsonresume-theme-onepage` | Single page |
 
-## Commands
+> Browse all themes at [jsonresume.org/themes](https://jsonresume.org/themes/) — any `jsonresume-theme-*` package works with resuml.
 
-- `validate` - Validates resume data against the JSON Resume schema
-- `tojson` - Converts YAML resume data to JSON format
-- `render` - Renders the resume using a specified theme
-- `dev` - Starts a development server with hot-reload
-
-## Options
+## Examples
 
-- `--resume, -r` - Input YAML file(s) or directory
-- `--output, -o` - Output file path
-- `--theme, -t` - Theme to use for rendering
-- `--port, -p` - Port for development server (default: 3000)
-- `--debug` - Enable debug mode for detailed error messages
+For detailed examples and usage instructions, see the [examples/README.md](examples/README.md) file.
 
 ## Example YAML Structure
 
@@ -91,24 +149,76 @@ work:
     summary: Led development of...
 ```
 
-## Available Themes
+## CI/CD: Auto-build on Push
 
-- `stackoverflow` - Clean and professional theme based on Stack Overflow's style
-- `react` - Modern React-based theme with interactive features
-- More themes coming soon...
+Use GitHub Actions to automatically rebuild your resume when you push changes:
+
+```yaml
+# .github/workflows/resume.yml
+name: Build Resume
+
+on:
+  push:
+    paths: ['resume.yaml', 'resume/*.yaml']
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - run: npm install -g resuml
+      - run: npm install jsonresume-theme-stackoverflow
+
+      - run: resuml render --resume resume.yaml --theme stackoverflow --output resume.html
+      - run: resuml tojson --resume resume.yaml --output resume.json
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: resume
+          path: |
+            resume.html
+            resume.json
+```
+
+## Node.js API Usage
+
+You can use resuml programmatically from Node.js:
+
+```js
+import {
+  processResumeData,
+  loadResumeFiles,
+  loadTheme,
+  themeRender
+} from 'resuml';
+
+// Load YAML files
+const { yamlContents } = await loadResumeFiles('resume.yaml');
+// Validate and merge
+const resume = await processResumeData(yamlContents);
+// Load a theme
+const theme = await loadTheme('stackoverflow');
+// Render HTML
+const html = await theme.render(resume, { locale: 'en' });
+```
+
+See the CLI and API for more details.
 
 ## Troubleshooting
 
 ### Common Issues
 
 1. **Validation Errors**
-
    - Ensure your YAML follows the JSON Resume schema
    - Check for proper indentation in your YAML file
    - Verify all required fields are present
 
 2. **Theme Rendering Issues**
-
    - Make sure the theme is properly installed
    - Check if all required theme dependencies are installed
    - Try running with `--debug` flag for more information
@@ -125,27 +235,3 @@ Contributions are welcome! Please feel free to submit a Pull Request.
 ## License
 
 ISC
-
-## Node.js API Usage
-
-You can use resuml programmatically from Node.js:
-
-```js
-import {
-  processResumeData,
-  loadResumeFiles,
-  loadTheme,
-  themeRender
-} from 'resuml';
-
-// Load YAML files
-const { yamlContents } = await loadResumeFiles('resume.yaml');
-// Validate and merge
-const resume = await processResumeData(yamlContents);
-// Load a theme
-const theme = await loadTheme('stackoverflow');
-// Render HTML
-const html = await theme.render(resume, { locale: 'en' });
-```
-
-See the CLI and API for more details.

package/dist/api.js

@@ -38,7 +38,7 @@ var getImportMetaUrl, importMetaUrl;
 var init_cjs_shims = __esm({
   "node_modules/tsup/assets/cjs_shims.js"() {
     "use strict";
-    getImportMetaUrl = () => typeof document === "undefined" ? new URL(`file:${__filename}`).href : document.currentScript && document.currentScript.src || new URL("main.js", document.baseURI).href;
+    getImportMetaUrl = () => typeof document === "undefined" ? new URL(`file:${__filename}`).href : document.currentScript && document.currentScript.tagName.toUpperCase() === "SCRIPT" ? document.currentScript.src : new URL("main.js", document.baseURI).href;
     importMetaUrl = /* @__PURE__ */ getImportMetaUrl();
   }
 });
@@ -180,7 +180,7 @@ var require_brace_expansion = __commonJS({
         var isSequence = isNumericSequence || isAlphaSequence;
         var isOptions = m.body.indexOf(",") >= 0;
         if (!isSequence && !isOptions) {
-          if (m.post.match(/,.*\}/)) {
+          if (m.post.match(/,(?!,).*\}/)) {
             str = m.pre + "{" + m.body + escClose + m.post;
             return expand2(str);
           }
@@ -261,7 +261,7 @@ __export(themeLoader_exports, {
 });
 async function installTheme(packageName) {
   try {
-    (0, import_child_process.execSync)(`npm install ${packageName}`, {
+    (0, import_child_process.execFileSync)("npm", ["install", packageName], {
       stdio: ["inherit", "pipe", "pipe"],
       encoding: "utf8"
     });
@@ -1066,7 +1066,7 @@ var path = {
 };
 var sep = defaultPlatform === "win32" ? path.win32.sep : path.posix.sep;
 minimatch.sep = sep;
-var GLOBSTAR = Symbol("globstar **");
+var GLOBSTAR = /* @__PURE__ */ Symbol("globstar **");
 minimatch.GLOBSTAR = GLOBSTAR;
 var qmark2 = "[^/]";
 var star2 = qmark2 + "*?";
@@ -1771,7 +1771,6 @@ if (typeof AC === "undefined") {
   };
 }
 var shouldWarn = (code) => !warned.has(code);
-var TYPE = Symbol("type");
 var isPosInt = (n) => n && n === Math.floor(n) && n > 0 && isFinite(n);
 var getUintArray = (max) => !isPosInt(max) ? null : max <= Math.pow(2, 8) ? Uint8Array : max <= Math.pow(2, 16) ? Uint16Array : max <= Math.pow(2, 32) ? Uint32Array : max <= Number.MAX_SAFE_INTEGER ? ZeroArray : null;
 var ZeroArray = class extends Array {
@@ -3116,37 +3115,37 @@ var isStream = (s) => !!s && typeof s === "object" && (s instanceof Minipass ||
 var isReadable = (s) => !!s && typeof s === "object" && s instanceof import_node_events.EventEmitter && typeof s.pipe === "function" && // node core Writable streams have a pipe() method, but it throws
 s.pipe !== import_node_stream.default.Writable.prototype.pipe;
 var isWritable = (s) => !!s && typeof s === "object" && s instanceof import_node_events.EventEmitter && typeof s.write === "function" && typeof s.end === "function";
-var EOF = Symbol("EOF");
-var MAYBE_EMIT_END = Symbol("maybeEmitEnd");
-var EMITTED_END = Symbol("emittedEnd");
-var EMITTING_END = Symbol("emittingEnd");
-var EMITTED_ERROR = Symbol("emittedError");
-var CLOSED = Symbol("closed");
-var READ = Symbol("read");
-var FLUSH = Symbol("flush");
-var FLUSHCHUNK = Symbol("flushChunk");
-var ENCODING = Symbol("encoding");
-var DECODER = Symbol("decoder");
-var FLOWING = Symbol("flowing");
-var PAUSED = Symbol("paused");
-var RESUME = Symbol("resume");
-var BUFFER = Symbol("buffer");
-var PIPES = Symbol("pipes");
-var BUFFERLENGTH = Symbol("bufferLength");
-var BUFFERPUSH = Symbol("bufferPush");
-var BUFFERSHIFT = Symbol("bufferShift");
-var OBJECTMODE = Symbol("objectMode");
-var DESTROYED = Symbol("destroyed");
-var ERROR = Symbol("error");
-var EMITDATA = Symbol("emitData");
-var EMITEND = Symbol("emitEnd");
-var EMITEND2 = Symbol("emitEnd2");
-var ASYNC = Symbol("async");
-var ABORT = Symbol("abort");
-var ABORTED = Symbol("aborted");
-var SIGNAL = Symbol("signal");
-var DATALISTENERS = Symbol("dataListeners");
-var DISCARDED = Symbol("discarded");
+var EOF = /* @__PURE__ */ Symbol("EOF");
+var MAYBE_EMIT_END = /* @__PURE__ */ Symbol("maybeEmitEnd");
+var EMITTED_END = /* @__PURE__ */ Symbol("emittedEnd");
+var EMITTING_END = /* @__PURE__ */ Symbol("emittingEnd");
+var EMITTED_ERROR = /* @__PURE__ */ Symbol("emittedError");
+var CLOSED = /* @__PURE__ */ Symbol("closed");
+var READ = /* @__PURE__ */ Symbol("read");
+var FLUSH = /* @__PURE__ */ Symbol("flush");
+var FLUSHCHUNK = /* @__PURE__ */ Symbol("flushChunk");
+var ENCODING = /* @__PURE__ */ Symbol("encoding");
+var DECODER = /* @__PURE__ */ Symbol("decoder");
+var FLOWING = /* @__PURE__ */ Symbol("flowing");
+var PAUSED = /* @__PURE__ */ Symbol("paused");
+var RESUME = /* @__PURE__ */ Symbol("resume");
+var BUFFER = /* @__PURE__ */ Symbol("buffer");
+var PIPES = /* @__PURE__ */ Symbol("pipes");
+var BUFFERLENGTH = /* @__PURE__ */ Symbol("bufferLength");
+var BUFFERPUSH = /* @__PURE__ */ Symbol("bufferPush");
+var BUFFERSHIFT = /* @__PURE__ */ Symbol("bufferShift");
+var OBJECTMODE = /* @__PURE__ */ Symbol("objectMode");
+var DESTROYED = /* @__PURE__ */ Symbol("destroyed");
+var ERROR = /* @__PURE__ */ Symbol("error");
+var EMITDATA = /* @__PURE__ */ Symbol("emitData");
+var EMITEND = /* @__PURE__ */ Symbol("emitEnd");
+var EMITEND2 = /* @__PURE__ */ Symbol("emitEnd2");
+var ASYNC = /* @__PURE__ */ Symbol("async");
+var ABORT = /* @__PURE__ */ Symbol("abort");
+var ABORTED = /* @__PURE__ */ Symbol("aborted");
+var SIGNAL = /* @__PURE__ */ Symbol("signal");
+var DATALISTENERS = /* @__PURE__ */ Symbol("dataListeners");
+var DISCARDED = /* @__PURE__ */ Symbol("discarded");
 var defer = (fn) => Promise.resolve().then(fn);
 var nodefer = (fn) => fn();
 var isEndish = (ev) => ev === "end" || ev === "finish" || ev === "prefinish";
@@ -4059,7 +4058,7 @@ var ChildrenCache = class extends LRUCache {
     });
   }
 };
-var setAsCwd = Symbol("PathScurry setAsCwd");
+var setAsCwd = /* @__PURE__ */ Symbol("PathScurry setAsCwd");
 var PathBase = class {
   /**
    * the basename of this path