[kbn-eslint-plugin-eslint] add scout_api_test_encourage_api_client rule #245172
+390
−0
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
Adds a new ESLint rule to encourage the use of the
apiClientfixture in API tests within Scout. The rule emits a warning if an API test does not useapiClient, guiding test authors to follow our best practice of usingapiClientfor endpoint validation rather thanapiServicesorkbnClientin the test body.Why
apiServicesorkbnClientdirectly in test bodies.What changed
apiClientusage in API test blocks.apiClientis not used, but can be overridden with a comment in edge cases.How to use
apiClientis used for the main endpoint validation.