Gerando documentos

O uso secundário do configlet é gerar documentos.

Uso

O comando generate pode ser usado para gerar documentos de instruções/introduções a partir de um template.

configlet [global-options] generate

Global options:
  -h, --help                   Show this help message and exit
      --version                Show this tool's version information and exit
  -t, --track-dir <dir>        Specify a track directory to use instead of the current directory
  -v, --verbosity <verbosity>  The verbosity of output. Allowed values: q[uiet], n[ormal], d[etailed]

Documentos

Estes são os documentos que o configlet pode gerar.

Documento: arquivo introduction.md de um exercício de conceito

Cada exercício de conceito tem um arquivo introduction.md. Cada exercício pode ter um arquivo introduction.md.tpl opcional.

O arquivo de template deve ser tratado como um arquivo Markdown comum, mas com um detalhe a mais: a possibilidade de especificar placeholders. Os seguintes placeholders são aceitos:

• %{concept:<slug>}: refere-se ao documento introduction.md do conceito.

Quando o configlet detecta que um exercício de conceito tem um arquivo introduction.md.tpl, ele gera um arquivo introduction.md a partir dele. A introdução gerada terá o mesmo conteúdo do template, exceto pelos placeholders, que serão substituídos pelo conteúdo dos documentos aos quais se referem.

Documento: arquivo introduction.md de um exercício de prática

Quando o configlet detecta que um exercício de prática implementa um exercício do Problem Specifications que tem um arquivo introduction.md, o configlet sincroniza o arquivo .meta/introduction.md do exercício de prática com o arquivo introduction.md do exercício do Problem Specifications.

Documento: arquivo instructions.md de um exercício de prática

Quando o configlet detecta que um exercício de prática implementa um exercício do Problem Specifications, o configlet sincroniza o arquivo .meta/instructions.md do exercício de prática com o arquivo instructions.md do exercício do Problem Specifications ou com o arquivo description.md dele quando nenhum arquivo instructions.md for encontrado.

Documento: arquivo .meta/config.json de um exercício de prática

Quando o configlet detecta que um exercício de prática implementa um exercício do Problem Specifications, o configlet sincroniza as chaves source e source_url do arquivo metadata.yml do exercício do Problem Specifications com as propriedades source e source_url do arquivo .meta/config.json do exercício de prática.