CLI

YAMLResume adopte une structure mono-repo, ce qui signifie que tous les packages sont contenus dans un seul dépôt. Grâce à pnpm workspace, cette approche simplifie la gestion des dépendances et le versioning entre les packages.

Au moment de l'écriture, le dépôt YAMLResume a deux packages :

yamlresume/cli : l'interface CLI pour YAMLResume.
yamlresume/core : contient le moteur principal pour YAMLResume. Il gère l'analyse, la validation et le rendu des CV basés sur le schéma officiel.

Construction de yamlresume/core

yamlresume/cli dépend de yamlresume/core pour fonctionner correctement. Donc quand vous voulez tester yamlresume/cli, vous devez vous assurer que yamlresume/core est aussi construit et disponible.

Vous pouvez faire cela avec les commandes suivantes :

# construire pour le développement
pnpm core build

# construire pour la production, ce qui va minifier la sortie et générer les fichiers
# TypeScript DTS `.d.ts`
pnpm core build:prod

# surveiller les changements de fichiers et construire automatiquement
pnpm core build:watch

Construction de yamlresume/cli

Une fois que yamlresume/core est construit, vous pouvez exécuter les commandes CLI de deux façons :

construire yamlresume/cli localement et exécuter node.js avec dist/cli.js :

pnpm cli build
node packages/cli/dist/cli.js <command> [options]

exécuter yamlresume/cli directement avec l'aide de tsx :

pnpm cli dev <command> [options]

# cette commande se traduira par
# tsx src/cli.ts

Démonstration

Construction de yamlresume/core :

$ pnpm core build

> @yamlresume/yamlresume@0.7.1 core /Users/hanyu/work/yamlresume/yamlresume
> pnpm --filter @yamlresume/core build

> @yamlresume/core@0.7.1 build /Users/hanyu/work/yamlresume/yamlresume/packages/core
> tsup

CLI Building entry: src/index.ts
CLI Using tsconfig: tsconfig.json
CLI tsup v8.4.0
CLI Using tsup config: /Users/hanyu/work/yamlresume/yamlresume/packages/core/tsup.config.ts
CLI Target: esnext
CLI Cleaning output folder
ESM Build start
ESM dist/index.js 160.91 KB
ESM ⚡️ Build success in 111ms

Construction de yamlresume/cli :

$ pnpm cli build

> @yamlresume/yamlresume@0.7.1 cli /Users/hanyu/work/yamlresume/yamlresume
> pnpm --filter yamlresume build

> yamlresume@0.7.1 build /Users/hanyu/work/yamlresume/yamlresume/packages/cli
> tsup

CLI Building entry: src/cli.ts
CLI Using tsconfig: tsconfig.json
CLI tsup v8.4.0
CLI Using tsup config: /Users/hanyu/work/yamlresume/yamlresume/packages/cli/tsup.config.ts
CLI Target: esnext
CLI Cleaning output folder
ESM Build start
ESM dist/cli.js 11.36 KB
ESM ⚡️ Build success in 42ms

Tester yamlresume/cli avec tsx par pnpm cli dev :

$ pnpm cli dev help

> @yamlresume/yamlresume@0.7.1 cli /Users/hanyu/work/yamlresume/yamlresume
> pnpm --filter yamlresume dev help

> yamlresume@0.7.1 dev /Users/hanyu/work/yamlresume/yamlresume/packages/cli
> tsx src/cli.ts help

Usage: yamlresume [options] [command]

YAMLResume — Resume as Code in YAML

 __   __ _    __  __ _     ____
 \ \ / // \  |  \/  | |   |  _ \ ___  ___ _   _ ___  ___   ___
  \ V // _ \ | |\/| | |   | |_) / _ \/ __| | | / _ \/ _ \ / _ \
   | |/ ___ \| |  | | |___|  _ <  __/\__ \ |_| | | | | | |  __/
   |_/_/   \_\_|  |_|_____|_| \_\___||___/\____|_| |_| |_|\___|


Options:
  -V, --version                  output the version number
  -v, --verbose                  verbose output
  -h, --help                     display help for command

Commands:
  new [filename]                 create a new resume
  build [options] <resume-path>  build a resume to LaTeX and PDF
  dev [options] <resume-path>    build on file changes (watch mode)
  languages                      i18n and l10n support
  templates                      manage resume templates
  validate <resume-path>         validate a resume against the YAMLResume schema
  help [command]                 display help for command

Tester yamlresume/cli avec Node.js :

$ node packages/cli/dist/cli.js -V
0.7.1

Construction de yamlresume/core

Construction de yamlresume/cli

Démonstration

On this page