Skip to content

Standardize plugin option names (keep old names as deprecated aliases) - #472

Open
doron050 wants to merge 3 commits into
mainfrom
options-naming-cleanup
Open

doron050 wants to merge 3 commits into
mainfrom
options-naming-cleanup

Conversation

@doron050

Copy link
Copy Markdown
Collaborator

Addresses #373 (naming standardization).

Renames

Old New
overrideDriverVersion driverVersion
overrideDapperVersion dapperVersion
withAsyncSuffix useAsyncSuffix
withCancellationToken useCancellationToken

Convention: use* for behaviours, generate* for artifacts, *Version for version pins. overrides, namespaceName and debugRequest are intentionally unchanged.

Compatibility

  • Old names are still accepted as deprecated aliases (resolved as new, then old, then default).
  • Setting both spellings to different values throws an ArgumentException.
  • Raw properties are now nullable and omitted from JSON when unset, so defaults live in Options.
  • No runtime deprecation warning: sqlc swallows plugin stderr on success, so deprecation is documented only.
  • Generated .cs/.csproj output is unchanged; only request.* files change (re-serialised options).

Also

  • Merged Add useAsyncEnumerable option for :many queries #471; useAsyncEnumerable already follows the convention. Its code and examples now use the new names, and it is documented in AGENTS.md.
  • Examples cover both spellings (new names in Npgsql examples, deprecated names in the MySqlConnector legacy examples).

Testing

  • make unit-tests: 12 + 143 pass.
  • make test-plugin: 275/279 end-to-end pass. The 4 failures (MySQL TestFloatingPointCopyFrom / TestIntegerCopyFrom) fail identically on clean main.
  • Not run locally: WASM diff (WASI SDK 25 not installed); needs CI.

🤖 Generated with Claude Code

doron050 and others added 2 commits October 24, 2026 21:56
…x, useCancellationToken

Old names stay as deprecated aliases; conflicting values are rejected.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Use the new option names in the useAsyncEnumerable code and examples,
and document useAsyncEnumerable in AGENTS.md.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@doron050 doron050 added the minor New features or enhancements that are backward compatible. label Oct 24, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Release Assistant - Passed

All requirements satisfied.

Release Information:

  • Type: minor

This PR is ready to merge.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

minor New features or enhancements that are backward compatible.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant