bouajila-resume-generator

bouajila-resume-generator is a TypeScript library designed to generate professional PDF resumes from structured data using Typst.

It provides a programmatic way to build resumes by defining content in a type-safe manner and compiling it into high-quality PDFs.

Features

• Type-Safe Resume Definition: Use TypeScript interfaces to define your resume structure.
• Typst-Powered: Leverages the power and speed of the Typst typesetting system.
• Customizable: Easily extendable blocks and templates.

Prerequisites

Before using bouajila-resume-generator, ensure you have the following installed:

1. Node.js (>= 18)
2. pnpm (recommended)
3. Typst CLI: The typst command must be available in your system's PATH.
   • Installation Guide for Typst

Installation

pnpm install bouajila-resume-generator

Usage

Basic Example

import { compile, Resume, SectionType } from "bouajila-resume-generator";

const myResume: Resume = {
  name: "Jane Doe",
  description: "Software Engineer",
  lastUpdate: "2025-02-09",
  personalInfo: {
    name: "Jane Doe",
    location: "New York, NY",
    contact: [
      { id: 1, type: "Email", value: "[email protected]" },
      { id: 2, type: "LinkedIn", value: "linkedin.com/in/janedoe" }
    ]
  },
  sections: [
    {
      type: SectionType.Education,
      body: [
        {
          id: 1,
          degreeName: "Computer Science",
          degreeType: "B.S.",
          institution: "State University",
          summary: "Graduated with Honors, GPA: 3.8/4.0",
          highlights: ["Dean's List 2017-2019", "Thesis on Distributed Hash Tables"],
          startDate: "2018",
          endDate: "2022"
        }
      ]
    },
    // Add more sections like WorkExperience, Projects, Skills, etc.
  ]
};

// Compile to a file
await compile(myResume, { outputPath: "./resume.pdf" });

// Or get the buffer
const { buffer } = await compile(myResume);

Advanced Usage: Generating Typst Source

If you want to handle the compilation yourself or debug the output, you can generate the Typst source code directly:

import { generateTypstSource } from "bouajila-resume-generator";

const typstCode = generateTypstSource(myResume);
console.log(typstCode);

Documentation

Run the documentation site locally:

pnpm run docs

Development

Scripts

• Build: pnpm run build - Transpiles TypeScript to JavaScript in dist/.
• Typecheck: pnpm run typecheck - Runs the TypeScript compiler without emitting files.
• Dev (Single Run): pnpm run dev - Compiles the mock resume to output/resume.pdf.
• Dev (Watch Mode): pnpm run dev:watch - Watches for changes and re-runs the dev compilation.
• Test: pnpm run test - Runs unit and integration tests using Vitest.
• Docs: pnpm run docs - Starts the Docusaurus development server.

Project Structure

• src/compiler: Core logic for generating Typst code and calling the CLI.
• types/: TypeScript definitions for the resume schema.
• template/: Typst library files and icons used for styling.
• output/: Default directory for generated files during tests.

License

ISC