RobinTail / express-zod-api / 18045233393 / 3

100%

master: 100%

push

github

Renaming `options` to `ctx` (#2934)

I realized that context is more clear naming for that entity, which is
also the same in hono and trpc. It should also reduce the potential
confusion with "config options" and `OPTIONS` request method.

However, it might not be possible to rename in without breaking changes,
since it's present in public interfaces.

## todo
- [x] diagram
- [x] migration
- [x] changelog

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- Breaking Changes
- Standardized context naming: replace options with ctx across handlers,
middleware, and factory APIs. Renamed addOptions to addContext. This
affects handler signatures and how context is accessed.
- Documentation
  - Updated README and examples to reflect ctx-based usage and patterns.
- Tooling/Migration
- Added automated migration rules to rename options→ctx and
addOptions→addContext.
- Tests
  - Updated test suites to align with ctx terminology and behavior.
- Chores
  - CHANGELOG updated to document the API rename and guidance.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

1140 of 1181 branches covered (96.53%)

3915 of 3915 relevant lines covered (100.0%)

46.88 hits per line