refactor!: single import pattern module exports + update docs #19
Conversation
Consolidates all module exports into the main entry point by removing the separate './modules' export from package.json and build config. Updates documentation to use named imports from 'mailchannels-sdk' instead of subpath imports. Also removes redundant type re-exports from src/modules.ts and ensures all modules are exported from src/mailchannels.ts.
There was a problem hiding this comment.
Pull Request Overview
This PR consolidates module exports by enforcing a single import pattern, requiring all exports to come from the main 'mailchannels-sdk' entry point instead of allowing subpath imports like 'mailchannels-sdk/modules'.
Key Changes:
- Removed the './modules' export path from package.json and build configuration
- Updated all documentation examples to use named imports directly from 'mailchannels-sdk'
- Re-exported all modules through the main entry point (src/mailchannels.ts)
Reviewed Changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/modules.ts | Removed redundant type re-exports that are now handled by the main entry point |
| src/mailchannels.ts | Added wildcard export to expose all modules from the main entry point |
| package.json | Removed the './modules' subpath export configuration |
| build.config.ts | Removed './src/modules' from build entries to build only the main entry point |
| docs/modules/*.md | Updated all code examples to import modules directly from 'mailchannels-sdk' instead of 'mailchannels-sdk/modules' |
| docs/guide.md | Updated example to use single-line import from 'mailchannels-sdk' |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #19 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 14 14
Lines 810 810
Branches 146 146
=========================================
Hits 810 810
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Consolidates all module exports into the main entry point by removing the separate
mailchannels-sdk/modulesexport. Updates documentation to use named imports frommailchannels-sdkinstead of subpath imports.