Skip to content

Add wdl-doc config to sprocket.toml#773

Merged
a-frantz merged 9 commits intostjude-rust-labs:mainfrom
as1100k-forks:issue-772
Mar 30, 2026
Merged

Add wdl-doc config to sprocket.toml#773
a-frantz merged 9 commits intostjude-rust-labs:mainfrom
as1100k-forks:issue-772

Conversation

@AS1100K
Copy link
Copy Markdown
Contributor

@AS1100K AS1100K commented Mar 27, 2026

Fix #772

This pull request adds support for configuring the doc subcommand using the sprocket.toml configuration file. This allows users to specify documentation-related settings in the config file instead of passing them as command-line arguments. The implementation introduces a new DocConfig struct, updates the command logic to use these config values, and adds corresponding tests and documentation.

Before submitting this PR, please make sure:

For external contributors:

  • You have read the contributing guide in its entirety.
  • You have not used AI on any parts of this pull request.
  • You have added a few sentences describing the PR here.
  • Your code builds clean without any errors or warnings.

For all contributors:

  • You have added tests (when appropriate).
  • You have added an entry in the CHANGELOG (when appropriate).
  • You have updated the README or other documentation to account for these changes (when appropriate).
  • You have made a PR to the next branch in the sprocket.bio repository (when appropriate).

For PRs containing lint rule changes:

  • You have updated any and all effected entries within RULES.md.
  • You have added a test case in crates/wdl-lint/tests/lints that covers every
    possible diagnostic emitted for the rule within the file where the rule
    is implemented.

@AS1100K AS1100K marked this pull request as ready for review March 27, 2026 19:21
@AS1100K AS1100K requested a review from a team as a code owner March 27, 2026 19:21
@AS1100K AS1100K requested a review from adthrasher March 27, 2026 19:21
Comment thread src/commands/doc.rs
@adthrasher
Copy link
Copy Markdown
Member

Please restore the checklist (https://github.com/stjude-rust-labs/sprocket/blob/main/.github/pull_request_template.md) and complete

@adthrasher adthrasher added the S-awaiting-revisions PR is awaiting revisions from the contributor. label Mar 27, 2026
@AS1100K
Copy link
Copy Markdown
Contributor Author

AS1100K commented Mar 27, 2026

Please restore the checklist (https://github.com/stjude-rust-labs/sprocket/blob/main/.github/pull_request_template.md) and complete

done

Comment thread src/config.rs Outdated
Comment thread tests/cli/doc/custom_logo/args
Comment thread src/commands/doc.rs Outdated
@Serial-ATA Serial-ATA removed the S-awaiting-revisions PR is awaiting revisions from the contributor. label Mar 27, 2026
@codecov
Copy link
Copy Markdown

codecov bot commented Mar 27, 2026

Codecov Report

❌ Patch coverage is 96.77419% with 1 line in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
src/commands/doc.rs 95.65% 1 Missing ⚠️
Files with missing lines Coverage Δ
src/config.rs 58.66% <100.00%> (+2.32%) ⬆️
src/commands/doc.rs 58.97% <95.65%> (+3.31%) ⬆️

... and 4 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@AS1100K AS1100K requested a review from Serial-ATA March 29, 2026 15:24
Comment thread src/config.rs
Comment thread src/config.rs
Copy link
Copy Markdown
Collaborator

@Serial-ATA Serial-ATA left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@a-frantz a-frantz merged commit a34b40d into stjude-rust-labs:main Mar 30, 2026
24 checks passed
@sprocket-release-plz sprocket-release-plz bot mentioned this pull request Mar 30, 2026
raman976 pushed a commit to raman976/sprocket that referenced this pull request Apr 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add wdl-doc config to sprocket.toml

4 participants