Skip to content

feat: becwright list#12

Merged
DataDave-Dev merged 1 commit into
mainfrom
feat/list-command
Jun 30, 2026
Merged

feat: becwright list#12
DataDave-Dev merged 1 commit into
mainfrom
feat/list-command

Conversation

@DataDave-Dev

@DataDave-Dev DataDave-Dev commented Jun 30, 2026

Copy link
Copy Markdown
Owner

Adds a becwright list command that prints the built-in checks (discovered from the becwright.checks package) with a one-line description each, plus the catalog URL. Helps newcomers discover what's available without reading the docs.

Docs and command tables updated (English and Spanish).

Closes #8.

Summary by CodeRabbit

  • New Features

    • Added a new becwright list command to show the built-in checks available in the CLI.
    • The command now displays a readable catalog with names and descriptions.
  • Documentation

    • Updated English and Spanish docs to include the new command in command lists and usage tables.
    • Aligned architecture docs with the updated CLI command set.
  • Tests

    • Added coverage for the new command’s output, ordering, and displayed descriptions.

Lists the built-in checks (discovered from the becwright.checks package) with a
short description each, plus the catalog URL. Closes #8.
@coderabbitai

coderabbitai Bot commented Jun 30, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: a6afeeb0-415c-4c51-bc5e-19cb897dbbaa

📥 Commits

Reviewing files that changed from the base of the PR and between 7f5bd13 and 1f2f397.

📒 Files selected for processing (9)
  • CLAUDE.md
  • README.es.md
  • README.md
  • documentation/architecture.es.md
  • documentation/architecture.md
  • documentation/usage.es.md
  • documentation/usage.md
  • src/becwright/cli.py
  • tests/test_list.py

📝 Walkthrough

Walkthrough

Adds a becwright list CLI subcommand to cli.py that enumerates built-in checks from the becwright.checks package using pkgutil, prints each with a description from _CHECK_DESCRIPTIONS, and links to the BECS catalog. Three new tests validate the command. All documentation files are updated to include the new command.

becwright list command

Layer / File(s) Summary
list command implementation and parser wiring
src/becwright/cli.py
Adds pkgutil import, _CHECK_DESCRIPTIONS map, _builtin_check_names() helper, _cmd_list() handler, and registers the list subcommand in the argument parser.
Tests for list command
tests/test_list.py
Three tests covering _builtin_check_names() contents and sort order, _cmd_list() stdout output, and full description coverage for every listed check.
Documentation updates
README.md, README.es.md, CLAUDE.md, documentation/architecture.md, documentation/architecture.es.md, documentation/usage.md, documentation/usage.es.md
Adds becwright list to all command tables and component descriptions in English and Spanish. Note: documentation/architecture.es.md appears to remove list from the subcommand list rather than add it — worth verifying that change is intentional.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐇 Hippity-hop, what checks have we here?
A list command conjured to make things clear!
pkgutil sniffs modules, descriptions align,
Each built-in check printed in neat little lines.
No more guessing — just type and you'll see,
The catalog awaits you, hop along with me! 🌿

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/list-command

Comment @coderabbitai help to get the list of available commands.

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 a 'becwright list' command to discover built-in checks

1 participant