fix(cli): tweak required argument names and styles + validate CLI documentation drift by dotkas · Pull Request #45 · alchemaxinc/oapi-codegen-rust

dotkas · 2026-07-21T11:57:00Z

No description provided.

Copilot

Pull request overview

Updates the oapi-codegen CLI flag naming and propagates the new, consistent invocation style across user-facing docs, examples, and the project Makefile, while also aligning the embedded --help examples and a console hint with the renamed flags.

Changes:

Rename CLI args/flags to --config-file / --output-file and update the positional arg name to spec_file.
Update all documented CLI examples (README, docs, Makefile, example README, --help examples) to use “options first, spec file last”.
Adjust the “no output destination” console hint to reference --output-file.

Reviewed changes

Copilot reviewed 15 out of 16 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
README.md	Updates Quickstart and design-differences bullet to use `--config-file` / `--output-file`.
Makefile	Updates `generate-example` commands to the new flag names and consistent argument ordering.
examples/bookstore/README.md	Adds a dedicated example README documenting the regenerated commands with the new flags.
docs/design.md	Updates the design doc’s “explicit invocation” section to the new flag names.
docs/configuration.md	Updates CLI synopsis and flag descriptions to the new names (one placeholder inconsistency noted).
crates/oapi-codegen/src/main.rs	Renames CLI struct fields/flags and updates the embedded `--help` examples accordingly.
crates/oapi-codegen/src/console.rs	Updates the “no output destination” hint to reference `--output-file`.
.github/copilot-instructions.md	Adds a pinned guideline documenting the “options first, spec last” CLI example convention.

Copilot

Pull request overview

Copilot reviewed 15 out of 16 changed files in this pull request and generated 1 comment.

Comments suppressed due to low confidence (1)

docs/configuration.md:6

The CLI synopsis placeholder uses <spec.yaml> but the argument description below uses <spec-file>. Using one placeholder consistently makes it clearer that this is a positional argument name rather than a literal filename.

oapi-codegen --config-file <cfg.yaml> [--output-file <out.rs>] <spec.yaml>

Copilot

Pull request overview

Copilot reviewed 15 out of 16 changed files in this pull request and generated 1 comment.

Comments suppressed due to low confidence (1)

crates/oapi-codegen/tests/example_commands.rs:170

The temporary workspace directory is only removed at the end of the loop body. If any documented command fails (assert/panic), the test will unwind before the explicit remove_dir_all, leaving the copied workspace behind in the OS temp dir and potentially accumulating over time in CI.

        let workspace = std::env::temp_dir().join(format!("oapi-codegen-docs-{}-{offset}", std::process::id()));
        copy_dir(&example.dir, &workspace);

Copilot

Pull request overview

Copilot reviewed 15 out of 16 changed files in this pull request and generated 1 comment.

Copilot

Pull request overview

Copilot reviewed 15 out of 16 changed files in this pull request and generated no new comments.

Copilot

Pull request overview

Copilot reviewed 14 out of 15 changed files in this pull request and generated no new comments.

Copilot

Pull request overview

Copilot reviewed 14 out of 15 changed files in this pull request and generated 3 comments.

Copilot

Pull request overview

Copilot reviewed 14 out of 15 changed files in this pull request and generated 1 comment.

Copilot

Pull request overview

Copilot reviewed 14 out of 15 changed files in this pull request and generated 1 comment.

Copilot

Pull request overview

Copilot reviewed 14 out of 15 changed files in this pull request and generated 1 comment.

alchemax-housekeeper · 2026-07-21T21:49:17Z

🎉 This PR is included in version 1.0.0-dev.6 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Copilot

Pull request overview

Copilot reviewed 14 out of 15 changed files in this pull request and generated no new comments.

alchemax-housekeeper · 2026-08-13T12:50:17Z

🎉 This PR is included in version 1.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

dotkas added 2 commits July 21, 2026 13:32

fix: use -file as prefix for more explicit TUI

babd0e8

chore: keep to convention of cli usage examples

eed5b84

Copilot AI review requested due to automatic review settings July 21, 2026 11:57

dotkas changed the title ~~fix(cli): smaller TUI improvements~~ feat(cli): ensure ssot for documented examples of CLI usage + small TUI tweaks Jul 21, 2026

Copilot started reviewing on behalf of dotkas July 21, 2026 11:57 View session

dotkas changed the title ~~feat(cli): ensure ssot for documented examples of CLI usage + small TUI tweaks~~ fix(cli): ensure ssot for documented examples of CLI usage + small TUI tweaks Jul 21, 2026

fix: adding auto generated CLI usage examples

d94cddd

Copilot AI reviewed Jul 21, 2026

View reviewed changes

Comment thread docs/configuration.md Outdated

Copilot AI review requested due to automatic review settings July 21, 2026 11:59

Copilot started reviewing on behalf of dotkas July 21, 2026 12:00 View session

Copilot AI reviewed Jul 21, 2026

View reviewed changes

Comment thread crates/oapi-codegen/tests/example_commands.rs Outdated

fix: verify examples work programatically

da4e9d9

Copilot AI review requested due to automatic review settings July 21, 2026 12:20

Copilot started reviewing on behalf of dotkas July 21, 2026 12:20 View session

Copilot AI reviewed Jul 21, 2026

View reviewed changes

Comment thread crates/oapi-codegen/tests/example_commands.rs Outdated

chore: pr comments addressed

1a2a4ff

Copilot AI review requested due to automatic review settings July 21, 2026 19:52

Copilot started reviewing on behalf of dotkas July 21, 2026 19:52 View session

Copilot AI reviewed Jul 21, 2026

View reviewed changes

Comment thread crates/oapi-codegen/tests/example_commands.rs Outdated

chore: more review fixes

5c8be18

Copilot AI review requested due to automatic review settings July 21, 2026 20:00

Copilot started reviewing on behalf of dotkas July 21, 2026 20:01 View session

Copilot AI reviewed Jul 21, 2026

View reviewed changes

dotkas changed the title ~~fix(cli): ensure ssot for documented examples of CLI usage + small TUI tweaks~~ fix(cli): tweak required argument names and styles Jul 21, 2026

fix: dropped the bookstore test approach

578bbca

Copilot AI review requested due to automatic review settings July 21, 2026 20:28

dotkas changed the title ~~fix(cli): tweak required argument names and styles~~ fix(cli): tweak required argument names and styles + validate CLI documentation drift Jul 21, 2026

Copilot started reviewing on behalf of dotkas July 21, 2026 20:29 View session

Copilot AI reviewed Jul 21, 2026

View reviewed changes

chore: const should only contain strings, not markup

7e6cfca

Copilot AI review requested due to automatic review settings July 21, 2026 20:31

Copilot started reviewing on behalf of dotkas July 21, 2026 20:32 View session

Copilot AI reviewed Jul 21, 2026

View reviewed changes

Comment thread docs/configuration.md Outdated

Comment thread docs/configuration.md Outdated

Comment thread Makefile Outdated

Copilot AI review requested due to automatic review settings July 21, 2026 20:55

Copilot started reviewing on behalf of dotkas July 21, 2026 20:55 View session

Copilot AI reviewed Jul 21, 2026

View reviewed changes

Comment thread docs/configuration.md Outdated

Copilot AI review requested due to automatic review settings July 21, 2026 21:00

dotkas force-pushed the dotkas/better-tui-ux branch from 2a315ea to c85d6ff Compare July 21, 2026 21:00

Copilot started reviewing on behalf of dotkas July 21, 2026 21:01 View session

Copilot AI reviewed Jul 21, 2026

View reviewed changes

Comment thread crates/oapi-codegen/tests/cli_docs.rs

dotkas force-pushed the dotkas/better-tui-ux branch from c85d6ff to 2b5e0d2 Compare July 21, 2026 21:16

Copilot AI review requested due to automatic review settings July 21, 2026 21:16

Copilot started reviewing on behalf of dotkas July 21, 2026 21:16 View session

Copilot AI reviewed Jul 21, 2026

View reviewed changes

Comment thread crates/oapi-codegen/src/cli.rs Outdated

fix: pr comments

5fcfd4e

Copilot AI review requested due to automatic review settings July 21, 2026 21:47

dotkas force-pushed the dotkas/better-tui-ux branch from 2b5e0d2 to 5fcfd4e Compare July 21, 2026 21:47

Copilot started reviewing on behalf of dotkas July 21, 2026 21:48 View session

dotkas enabled auto-merge (squash) July 21, 2026 21:48

dotkas merged commit 0019c0e into develop Jul 21, 2026
7 checks passed

dotkas deleted the dotkas/better-tui-ux branch July 21, 2026 21:48

alchemax-housekeeper Bot added the released on @develop label Jul 21, 2026

Copilot AI reviewed Jul 21, 2026

View reviewed changes

alchemax-housekeeper Bot added the released label Aug 13, 2026

Uh oh!

Conversation

dotkas commented Jul 21, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

alchemax-housekeeper Bot commented Jul 21, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

alchemax-housekeeper Bot commented Aug 13, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants