docs(claude): add 'no legacy CLI flag aliases' rule#423
Merged
Conversation
When the WSDL canonical name differs from an existing CLI flag, rename it as a breaking change rather than keeping the old name as a second Click alias. Reference implementation: PR #421 (campaigns). This rule was articulated during Wave 2 (#402) review and applies project-wide. New CLI options must be exactly the kebab-case form of the WSDL request parameter (e.g. `SitelinkFieldNames` → `--sitelink-field-names`).
This was referenced May 28, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add a project-wide rule to `CLAUDE.md`: when a CLI flag name diverges from its WSDL-canonical form, rename it as a breaking change rather than keeping the old name as a second Click alias.
Background: during Wave 2 (#402) the proposed approach for `campaigns get` was to register both `--text-campaign-fields` (legacy) and `--text-campaign-field-names` (canonical) as aliases on the same Click option. This was rejected in favour of a clean breaking rename — see PR #421 for the reference implementation.
This commit codifies the rule so future contributors / agents don't re-litigate it.
Test plan
Documentation-only change.
🤖 Generated with Claude Code