CLI

O YAMLResume adota uma estrutura de mono-repo, o que significa que todos os pacotes estão contidos num único repositório. Graças ao workspace de pnpm, esta abordagem simplifica a gestão de dependências e a versão entre pacotes.

No momento de escrever, o repositório do YAMLResume tem dois pacotes:

yamlresume/cli: a interface CLI para o YAMLResume.
yamlresume/core: contém o motor central para o YAMLResume. Processa a análise, validação e renderização de currículos baseado no esquema oficial.

yamlresume/core build

yamlresume/cli depende de yamlresume/core para funcionar corretamente. Então quando quiseres testar yamlresume/cli, precisas de assegurar que yamlresume/core também está construído e disponível.

Podes fazer isto com os seguintes comandos:

# construir para propósito de desenvolvimento
pnpm core build

# construir para produção, o qual minificará a saída e gerará ficheiros
# DTS de TypeScript `.d.ts`
pnpm core build:prod

# vigiar alterações de ficheiro e construir automaticamente
pnpm core build:watch

yamlresume/cli build

Uma vez que yamlresume/core está construído, podes executar os comandos CLI de duas formas:

construir yamlresume/cli localmente e executar node.js com dist/cli.js:

pnpm cli build
node packages/cli/dist/cli.js <comando> [opções]

executar yamlresume/cli diretamente com a ajuda de tsx:

pnpm cli dev <comando> [opções]

# este comando será traduzido para
# tsx src/cli.ts

Demo

yamlresume/core build:

$ 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

yamlresume/cli build:

$ 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

Testar yamlresume/cli com tsx através de 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

Testar yamlresume/cli com Node.js:

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

yamlresume/core build

yamlresume/cli build

Demo

On this page