feat: Make module exports consistent and update documentation #108
Conversation
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
All utility modules should be consistently accessible from the main package entry point to provide a unified API experience. Previously, random and transport were only available via subpath imports, creating inconsistency in how modules are accessed.
The documentation was outdated, referencing the project as a hybrid JavaScript/TypeScript codebase when it has been fully migrated to TypeScript. It also lacked information about the comprehensive test suite, improved CI/CD workflow, and the recent removal of the uri module. Updates include: - Full TypeScript migration completion - Comprehensive test suite with 100% coverage - Split CI workflow (lint, test, build jobs) - Codecov integration - Updated build output structure (dist/ directory) - Consistent module exports from main entry point - Removal of uri module documentation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #108 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 7 7
Lines 1870 1870
Branches 47 47
=========================================
Hits 1870 1870 Continue to review full report in Codecov by Sentry.
🚀 New features to boost your workflow:
|
jallamsetty1
approved these changes
Nov 3, 2025
saghul
approved these changes
Nov 3, 2025
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
Changes
Export Consistency (index.ts)
All utility modules are now consistently exported from the main package entry point. Previously,
randomandtransportwere only available via subpath imports, creating inconsistency.Users can now import everything from the main entry:
Subpath imports continue to work as an alternative:
Documentation Updates (CLAUDE.md)
Updated project documentation to accurately reflect:
Test plan
npm run build)npm run lint)