resuml 1.3.0 → 1.4.1

package/README.md

@@ -88,6 +88,7 @@ npm install -g resuml
 | Command | Description |
 |---------|-------------|
 | `validate` | Validate resume data against the JSON Resume schema |
+| `validate --ats` | Run ATS (Applicant Tracking System) compatibility analysis |
 | `tojson` | Convert YAML resume data to JSON format |
 | `render` | Render the resume using a specified theme |
 | `dev` | Start a development server with hot-reload |
@@ -102,6 +103,82 @@ npm install -g resuml
 | `--port` | `-p` | Port for dev server (default: 3000) |
 | `--language` | | Language code for localization (default: `en`) |
 | `--debug` | | Enable debug mode for detailed errors |
+| `--ats` | | Run ATS compatibility analysis (with `validate`) |
+| `--jd` | | Path to job description file for keyword matching (with `--ats`) |
+| `--ats-threshold` | | Minimum ATS score (0-100); exits with code 1 if below |
+
+## ATS Analysis
+
+Resumls built-in ATS (Applicant Tracking System) analysis helps ensure your resume passes automated screening. Fully offline and deterministic — no API keys or LLMs required.
+
+### Quick Start
+
+```bash
+# Basic ATS score
+resuml validate --resume resume.yaml --ats
+
+# Match against a specific job description
+resuml validate --resume resume.yaml --ats --jd job-description.txt
+
+# CI/CD gate: fail if score is below threshold
+resuml validate --resume resume.yaml --ats --ats-threshold 75
+
+# Machine-readable JSON output
+resuml validate --resume resume.yaml --ats --format json
+```
+
+### What It Checks
+
+The ATS engine runs 11 deterministic checks across 3 categories:
+
+**Contact Information**
+- Complete contact details (name, email, phone, city)
+- LinkedIn profile present
+
+**Content Quality**
+- Professional summary (length and presence)
+- Work highlights (minimum 2 per entry)
+- Action verbs (highlights start with strong verbs)
+- Quantified impact (numbers, percentages, metrics in highlights)
+- No first-person pronouns
+
+**Resume Structure**
+- Date consistency (no unexplained gaps > 6 months)
+- Skills populated (≥ 3 categories with keywords)
+- Education completeness
+- Essential sections present (basics, work, education, skills)
+
+### Job Description Matching
+
+Provide a job description file to get keyword matching:
+
+```bash
+resuml validate --resume resume.yaml --ats --jd job.txt
+```
+
+The engine extracts keywords from the job description using TF-based ranking with stem matching, then compares them against your resume. You get:
+- **Match percentage** — how many JD keywords appear in your resume
+- **Matched keywords** — what you already cover
+- **Missing keywords** — what to consider adding
+
+### Scoring
+
+| Score | Rating | Meaning |
+|-------|--------|-------------|
+| 90-100 | Excellent | Resume is well-optimized for ATS |
+| 75-89 | Good | Minor improvements possible |
+| 60-74 | Needs Work | Several issues to address |
+| 0-59 | Poor | Significant improvements needed |
+
+When a job description is provided, the final score is 60% generic checks + 40% keyword match.
+
+### Multi-Language Support
+
+ATS checks support English and German, with language-specific action verb lists and pronoun detection. Use the `--language` flag:
+
+```bash
+resuml validate --resume lebenslauf.yaml --ats --language de
+```
 
 ## Compatible Themes
 
@@ -174,6 +251,9 @@ jobs:
       - run: npm install -g resuml
       - run: npm install jsonresume-theme-stackoverflow
 
+      # Validate and check ATS score (fails if below 75)
+      - run: resuml validate --resume resume.yaml --ats --ats-threshold 75
+
       - run: resuml render --resume resume.yaml --theme stackoverflow --output resume.html
       - run: resuml tojson --resume resume.yaml --output resume.json
 
@@ -194,7 +274,8 @@ import {
   processResumeData,
   loadResumeFiles,
   loadTheme,
-  themeRender
+  themeRender,
+  analyzeAts
 } from 'resuml';
 
 // Load YAML files
@@ -205,6 +286,17 @@ const resume = await processResumeData(yamlContents);
 const theme = await loadTheme('stackoverflow');
 // Render HTML
 const html = await theme.render(resume, { locale: 'en' });
+
+// ATS analysis
+const atsResult = analyzeAts(resume, { language: 'en' });
+console.log(`ATS Score: ${atsResult.score}/100`);
+
+// With job description matching
+const jdResult = analyzeAts(resume, {
+  language: 'en',
+  jobDescription: 'Looking for a senior TypeScript developer...'
+});
+console.log(`Matched keywords: ${jdResult.keywords?.matched.join(', ')}`);
 ```
 
 See the CLI and API for more details.

package/bin/resuml

@@ -0,0 +1,21 @@
+#!/usr/bin/env node
+/* eslint-env node */
+
+const { existsSync } = require('fs');
+const { join } = require('path');
+const distPath = join(__dirname, '../dist/index.js');
+
+function startCli() {
+  try {
+    if (existsSync(distPath)) {
+      require(distPath);
+    } else {
+      throw new Error('CLI not built. Please run "npm run build" first.');
+    }
+  } catch (err) {
+    console.error('Error starting resuml CLI:', err);
+    process.exit(1);
+  }
+}
+
+startCli();

package/dist/{api.js → api.cjs}

@@ -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.tagName.toUpperCase() === "SCRIPT" ? document.currentScript.src : new URL("main.js", document.baseURI).href;
+    getImportMetaUrl = () => typeof document === "undefined" ? new URL(`file:${__filename}`).href : document.currentScript && 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);
           }
@@ -259,7 +259,7 @@ var themeLoader_exports = {};
 __export(themeLoader_exports, {
   loadTheme: () => loadTheme
 });
-async function installTheme(packageName) {
+function installTheme(packageName) {
   try {
     (0, import_child_process.execFileSync)("npm", ["install", packageName], {
       stdio: ["inherit", "pipe", "pipe"],
@@ -269,7 +269,7 @@ async function installTheme(packageName) {
     throw new Error(`Failed to install ${packageName}: ${error.message}`);
   }
 }
-async function loadTheme(themeName, options) {
+function loadTheme(themeName, options) {
   let jsonResumeThemeName;
   let nativeThemeName;
   const autoInstall = options?.autoInstall !== false;
@@ -290,7 +290,7 @@ Please install the theme package manually.`
         }
         console.log(`\u{1F4E6} Theme ${jsonResumeThemeName} not found. Installing...`);
         try {
-          await installTheme(jsonResumeThemeName);
+          installTheme(jsonResumeThemeName);
           console.log(`\u2705 Successfully installed ${jsonResumeThemeName}`);
           return require2(jsonResumeThemeName);
         } catch (installError) {
@@ -331,7 +331,7 @@ init_cjs_shims();
 // src/core.ts
 init_cjs_shims();
 var import_yaml = require("yaml");
-var import_lodash = __toESM(require("lodash.merge"));
+var import_lodash = __toESM(require("lodash.merge"), 1);
 var import_schema = require("@jsonresume/schema");
 async function processResumeData(yamlContents) {
   if (yamlContents.length === 0) {
@@ -370,13 +370,13 @@ async function processResumeData(yamlContents) {
 
 // src/utils/loadResume.ts
 init_cjs_shims();
-var import_promises3 = __toESM(require("fs/promises"));
-var import_yaml2 = __toESM(require("yaml"));
+var import_promises3 = __toESM(require("fs/promises"), 1);
+var import_yaml2 = __toESM(require("yaml"), 1);
 
 // src/utils/fileUtils.ts
 init_cjs_shims();
-var import_promises2 = __toESM(require("fs/promises"));
-var import_path = __toESM(require("path"));
+var import_promises2 = __toESM(require("fs/promises"), 1);
+var import_path = __toESM(require("path"), 1);
 
 // node_modules/glob/dist/esm/index.js
 init_cjs_shims();
@@ -1066,7 +1066,7 @@ var path = {
 };
 var sep = defaultPlatform === "win32" ? path.win32.sep : path.posix.sep;
 minimatch.sep = sep;
-var GLOBSTAR = /* @__PURE__ */ Symbol("globstar **");
+var GLOBSTAR = Symbol("globstar **");
 minimatch.GLOBSTAR = GLOBSTAR;
 var qmark2 = "[^/]";
 var star2 = qmark2 + "*?";
@@ -1771,6 +1771,7 @@ 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 {
@@ -3115,37 +3116,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 = /* @__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 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 defer = (fn) => Promise.resolve().then(fn);
 var nodefer = (fn) => fn();
 var isEndish = (ev) => ev === "end" || ev === "finish" || ev === "prefinish";
@@ -3184,7 +3185,7 @@ var PipeProxyErrors = class extends Pipe {
   }
   constructor(src, dest, opts) {
     super(src, dest, opts);
-    this.proxyErrors = (er) => dest.emit("error", er);
+    this.proxyErrors = (er) => this.dest.emit("error", er);
     src.on("error", this.proxyErrors);
   }
 };
@@ -3898,6 +3899,8 @@ var Minipass = class extends import_node_events.EventEmitter {
       return: stop,
       [Symbol.asyncIterator]() {
         return this;
+      },
+      [Symbol.asyncDispose]: async () => {
       }
     };
   }
@@ -3933,6 +3936,8 @@ var Minipass = class extends import_node_events.EventEmitter {
       return: stop,
       [Symbol.iterator]() {
         return this;
+      },
+      [Symbol.dispose]: () => {
       }
     };
   }
@@ -4058,7 +4063,7 @@ var ChildrenCache = class extends LRUCache {
     });
   }
 };
-var setAsCwd = /* @__PURE__ */ Symbol("PathScurry setAsCwd");
+var setAsCwd = Symbol("PathScurry setAsCwd");
 var PathBase = class {
   /**
    * the basename of this path
@@ -6848,4 +6853,4 @@ async function loadTheme2(themeName) {
   loadTheme,
   processResumeData
 });
-//# sourceMappingURL=api.js.map
+//# sourceMappingURL=api.cjs.map