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

[bug] published package is missing tests #44

Open
DerekNonGeneric opened this issue Jul 21, 2022 · 0 comments
Open

[bug] published package is missing tests #44

DerekNonGeneric opened this issue Jul 21, 2022 · 0 comments
Labels
bug Something isn't working
Milestone

Comments

@DerekNonGeneric
Copy link
Member

This package is currently being flagged by Socket with a Severity: Medium issue due to a lack of tests. This is negatively impacting how its quality score is performing over there. I do not yet have a testing strategy in mind, but we should ensure that our tests are at least in line with any usage guidelines we provide to ensure that results are consistent. There are a lot of ways to wrongly check an error (e.g., instanceof is not cross-realm). Those antipattern ways should probably not be what we use in our tests since they are not very consistent and may give folks the wrong impression who refer to tests for usage examples.


We are being suggested to add tests and publish a new version of the package once we have done so. It is unclear whether the tests are expected to be runnable using what we have specified in dependencies or whether devDependencies would be sufficient. I want to avoid shipping packages that contain devDependencies since they frequently become outdated a lot more quickly than everything else, meaning that we would have to ship much more often. Seeing as how it would be for a reason that doesn't affect the APIs provided by the module, it would be giving consumers very little reason to upgrade to these newer versions only having these innocuous dependency updates that have no effect on production code.

@DerekNonGeneric DerekNonGeneric added the bug Something isn't working label Jul 21, 2022
@DerekNonGeneric DerekNonGeneric added this to the Version 3.0 milestone Aug 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant