Add `useValidationRule()` plugin

benjie commented 5 months ago

Description

As discussed with @n1ru4l, this adds the useValidationRule() plugin, which can be used to add a validation rule.

Type of change

Please delete options that are not relevant.

[ ] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[x] This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

[x] Added to your test suite

Checklist:

[ ] I have followed the CONTRIBUTING doc and the style guidelines of this project
[x] I have performed a self-review of my own code
[ ] I have commented on my code, particularly in hard-to-understand areas
[x] I have made corresponding changes to the documentation
[ ] My changes generate no new warnings
[x] I have added tests that prove my fix is effective or that my feature works
[ ] New and existing unit tests pass locally with my changes
[x] Any dependent changes have been merged and published in downstream modules

Further comments

The newrelic tests are failing locally; I think this is unrelated given how trivial the function I've added is.

changeset-bot[bot] commented 5 months ago

🦋 Changeset detected

Latest commit: 1f56053b0e667e0fde440e2063d242a32ce3ed2f

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

| Name | Type | | ------------- | ----- | | @envelop/core | Patch |

Not sure what this means? Click here to learn what changesets are.

[Click here if you're a maintainer who wants to add another changeset to this PR](https://github.com/benjie/envelop/new/validation-rule?filename=.changeset/late-socks-protect.md&value=---%0A%22website%22%3A%20patch%0A%22%40envelop%2Fcore%22%3A%20patch%0A---%0A%0AAdd%20%60useValidationRule()%60%20plugin%0A)

benjie commented 5 months ago

I do not know how to address these test failures. I do not think it's related to my changes?

n1ru4l / envelop