@yamlresume/node

@yamlresume/node proporciona las APIs de runtime de Node.js que utiliza el CLI de yamlresume. Combina el compilador de YAMLResume, independiente de la plataforma, con acceso al sistema de archivos, vigilancia de archivos, flujos de trabajo de archivos con IA y compilación de PDF.

Usa este paquete cuando necesites integrar YAMLResume en un script de Node.js, un servicio web, una extensión de editor, un pipeline de construcción u otra aplicación sin tener que iniciar el CLI.

Instalación

$ npm install @yamlresume/node

El paquete es un módulo ES e incluye declaraciones de TypeScript.

Inicio rápido

Lee y valida un currículum, y luego construye todos los diseños configurados:

import { buildResumeFile, readResumeFile } from '@yamlresume/node'

const result = readResumeFile('resume.yml')

if (result.validated === 'failed') {
  for (const error of result.errors ?? []) {
    console.error(
      `${error.path.join('.')}: ${error.message} ` +
        `(${error.line}:${error.column})`
    )
  }
  process.exit(1)
}

const { outputs } = await buildResumeFile('resume.yml', {
  output: 'dist',
})

console.log(outputs)

buildResumeFile itera sobre el array layouts del currículum y devuelve las rutas de todos los archivos generados. Dependiendo de los motores configurados, estos pueden incluir archivos DOCX, HTML, Markdown, LaTeX, Typst y PDF. La validación de esquema es orientativa durante las construcciones: los currículums inválidos producen advertencias en el logger y la construcción continúa. Usa readResumeFile primero, como en el ejemplo anterior, cuando los errores de validación deban detener tu flujo de trabajo.

Leer y validar archivos

readResumeFile

readResumeFile acepta archivos .yml, .yaml y .json. La validación está habilitada por defecto:

import { readResumeFile } from '@yamlresume/node'

const { resume, validated, errors } = readResumeFile('resume.yml')

El campo validated es uno de los siguientes:

Los errores de validación incluyen la ruta del esquema y números de línea y columna basados en uno. Deshabilita la validación de esquema cuando solo necesites analizar el archivo:

const { resume, validated } = readResumeFile('resume.yml', {
  validate: false,
})

// validated === 'unknown'

Un YAML inválido y los fallos del sistema de archivos lanzan un YAMLResumeError.

validateResume

Usa validateResume cuando el contenido YAML ya esté en memoria:

import { ResumeSchema } from '@yamlresume/core'
import { validateResume } from '@yamlresume/node'

const source = `
content:
  basics:
    name: Andy Dufresne
layouts:
  - engine: html
`

const errors = validateResume(source, ResumeSchema)

Devuelve errores posicionales ordenados por número de línea, o un array vacío cuando la fuente cumple con el esquema.

Construir salidas del currículum

import { buildResumeFile } from '@yamlresume/node'

const { outputs } = await buildResumeFile('resume.yml', {
  pdf: true,
  validate: true,
  output: 'dist',
  timeout: 60,
})

Opciones de construcción

Si el currículum no tiene un bloque layouts, YAMLResume utiliza sus diseños predeterminados. Cuando varios diseños usan el mismo motor, sus nombres de archivo de salida reciben un índice, como resume.0.html y resume.1.html.

Registro de eventos

Las APIs son silenciosas a menos que pases un logger que implemente la interfaz Logger de @yamlresume/core:

import type { Logger } from '@yamlresume/core'
import { buildResumeFile } from '@yamlresume/node'

const logger: Logger = {
  start: console.log,
  success: console.log,
  debug: console.debug,
  info: console.info,
  log: console.log,
  warn: console.warn,
  error: console.error,
}

await buildResumeFile('resume.yml', { logger })

Vigilar un currículum

watchResumeFile realiza una construcción inicial y reconstruye cuando el archivo fuente cambia:

import { watchResumeFile } from '@yamlresume/node'

const watcher = watchResumeFile('resume.yml', {
  output: 'dist',
  pdf: false,
})

process.on('SIGINT', async () => {
  await watcher.close()
  process.exit(0)
})

El vigilante usa Chokidar, gestiona los guardados atómicos de los editores, evita construcciones superpuestas y agrupa una ráfaga de cambios en una única construcción posterior.

Crear un currículum a partir de un ejemplo

newResumeFile crea un currículum completamente comentado con diseños predeterminados a partir del catálogo de @yamlresume/samples:

import { newResumeFile } from '@yamlresume/node'

newResumeFile('resume.yml', 'software-engineer', 'en')

No sobrescribe un archivo existente. Usa showSampleSource: true con un logger cuando quieras que el mensaje de éxito incluya el ID del ejemplo seleccionado.

Flujos de trabajo de archivos con IA

El paquete de Node envuelve a @yamlresume/ai con lectura y escritura de archivos, comprobaciones de configuración regional y protección contra conflictos.

Generar un currículum

import { generateResumeFile } from '@yamlresume/node'

await generateResumeFile('resume.yml', 'Backend Engineer', 'en', {
  model: 'gpt-5',
  maxRetries: 3,
  onChunk: (chunk) => process.stdout.write(chunk),
})

Traducir un currículum

import { translateResumeFile } from '@yamlresume/node'

await translateResumeFile(
  'resume.en.yml',
  'resume.fr.yml',
  'fr',
  {
    model: 'gpt-5',
    maxRetries: 3,
  }
)

El idioma de origen se lee de locale.language. La generación y la traducción validan los códigos de configuración regional y se niegan a sobrescribir un archivo de salida existente. Las claves de API de los proveedores y los valores predeterminados de los modelos utilizan las mismas variables de entorno que los comandos yamlresume ai.

Manejo de errores

Las APIs de Node lanzan YAMLResumeError para fallos esperados, como archivos ilegibles, YAML inválido, conflictos de salida, idiomas no soportados, compiladores de PDF no disponibles y tiempos de espera de compilación:

import { YAMLResumeError } from '@yamlresume/core'
import { buildResumeFile } from '@yamlresume/node'

try {
  await buildResumeFile('resume.yml')
} catch (error) {
  if (error instanceof YAMLResumeError) {
    console.error(error.code, error.message)
    process.exitCode = error.errno
  } else {
    throw error
  }
}

Resumen de la API

Para todas las opciones y tipos de retorno, consulta la referencia completa de la API de @yamlresume/node.