Add `--check` option

Open
#21 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
48/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
rust
Domain
ci-cd, cli

Research direction

No files, tests, or entry points are named. Locate the CLI option parsing and document-generation entry points, then run the existing command on an up-to-date and modified document; done means --check shows a diff and returns nonzero only when the document is outdated.

Written by the indexing model from the issue text.

Description

Have --check spit out a diff with a nonzero exit code if the document isn't up to date, could be useful for ci workflows

Dominant language
Rust
Stars
112
Forks
2
Avg merge
2h 52m
Merged PRs (30d)
13

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from terror/present

All issues in terror/present

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.