feat: DX improvements for programmable API#57
Open
adaliszk wants to merge 2 commits intosimonrenoult:mainfrom
Open
feat: DX improvements for programmable API#57adaliszk wants to merge 2 commits intosimonrenoult:mainfrom
adaliszk wants to merge 2 commits intosimonrenoult:mainfrom
Conversation
Exposing the various types and classes for programatical usage with a shortcut for the complexity calculation. This should give a decent support for functional or object-oriented support while keeping the changes low. refs: simonrenoult#8
c9ed4e4 to
59f5c5a
Compare
Owner
|
I made some changes for the incoming v5, I'll take a look at this PR later (hopefully, it won't wait 2 years this time). |
4e99801 to
6244a98
Compare
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.
While trying to use this library in an existing CLI tool (importing it), I ran into a few issues:
I fixed those issues, and the tests passed as no logic has changed, improving on #8: Support a programmable API.
While so far the default export could have been used, now it is nicely typed and can support both CommonJS and ESM usage:
For advanced usage, people can import
Statistics,Churns,andComplexitiesand instantiate their own Analyzer.