Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Capture function coverage #20

Merged
merged 4 commits into from
Feb 8, 2024
Merged

Capture function coverage #20

merged 4 commits into from
Feb 8, 2024

Conversation

simonrw
Copy link
Collaborator

@simonrw simonrw commented Feb 8, 2024

Motivation

We should be transparent about which functions are covered and which aren't. This helps our users understand our current status, and indicate that we are not 100% complete with our implementation.

To aid with this process, I have created #19 which lists the functions we support, and encourage users to list/upvote their suggestions.
In turn, to support this I have added a script to capture the functions we implement, and to print them out to the console. We may automate this procedure in the process if it gets too arduous.

The example output from this script can be seen in the "Currently implemented functions" section of the linked issue.

Changes

  • Add script to capture feature coverage by introspecting the utilities library.
  • Fix a relative import issue when using the script

When importing the modules using the `scripts/coverage.mjs` script I got
an import error because the dynamodb utils use the main utils, and were
importing them by directory.

I do not understand JS import rules enough to debug this properly, so we
just import from the `index.js` instead. Let's see if the CI passes and
we can actually use the functions.
@simonrw simonrw self-assigned this Feb 8, 2024
@simonrw simonrw marked this pull request as ready for review February 8, 2024 11:14
@simonrw simonrw requested a review from whummer February 8, 2024 11:14
@simonrw simonrw merged commit 020e848 into main Feb 8, 2024
3 checks passed
@simonrw simonrw deleted the capture-coverage branch February 8, 2024 11:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant