[Security Solutions] Removes tech debt of exporting all from linter rule for metrics_entities plugin in the server section #120412
Conversation
This file contains 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
FrankHassanabad
changed the title
FrankHassanabad
added
v8.0.0
v8.1.0
Team:Security Solution Platform
|
@elasticmachine merge upstream |
💚 Build Succeeded
Metrics [docs]Public APIs missing comments
History
To update your PR or re-run it, just comment with: |
FrankHassanabad
added
the
Team:Detections and Resp
|
Pinging @elastic/security-detections-response (Team:Detections and Resp) |
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Dec 7, 2021
## Summary See: elastic#110903 This removes all the top level API `export *` spots from: * `metrics_entities` plugin within the server section This reduces the number of metrics and warning about undocumented functions. In the file `metrics_entites/server/index.ts` I now put the advice of: ``` // Careful of exporting anything from this file as any file(s) you export here will cause your functions to be exposed as public. // If you're using functions/types/etc... internally or within integration tests it's best to import directly from their paths // than expose the functions/types/etc... here. You should _only_ expose functions/types/etc... that need to be shared with other plugins here. // When you do have to add things here you might want to consider creating a package such to share with other plugins instead as packages // are easier to break down. // See: https://docs.elastic.dev/kibana-dev-docs/key-concepts/platform-intro#public-plugin-api ```
💚 Backport successful
This backport PR will be merged automatically after passing CI. |
kibanamachine
added a commit
that referenced
this pull request
Dec 7, 2021
) ## Summary See: #110903 This removes all the top level API `export *` spots from: * `metrics_entities` plugin within the server section This reduces the number of metrics and warning about undocumented functions. In the file `metrics_entites/server/index.ts` I now put the advice of: ``` // Careful of exporting anything from this file as any file(s) you export here will cause your functions to be exposed as public. // If you're using functions/types/etc... internally or within integration tests it's best to import directly from their paths // than expose the functions/types/etc... here. You should _only_ expose functions/types/etc... that need to be shared with other plugins here. // When you do have to add things here you might want to consider creating a package such to share with other plugins instead as packages // are easier to break down. // See: https://docs.elastic.dev/kibana-dev-docs/key-concepts/platform-intro#public-plugin-api ``` Co-authored-by: Frank Hassanabad <[email protected]>
TinLe
pushed a commit
to TinLe/kibana
that referenced
this pull request
Dec 22, 2021
## Summary See: elastic#110903 This removes all the top level API `export *` spots from: * `metrics_entities` plugin within the server section This reduces the number of metrics and warning about undocumented functions. In the file `metrics_entites/server/index.ts` I now put the advice of: ``` // Careful of exporting anything from this file as any file(s) you export here will cause your functions to be exposed as public. // If you're using functions/types/etc... internally or within integration tests it's best to import directly from their paths // than expose the functions/types/etc... here. You should _only_ expose functions/types/etc... that need to be shared with other plugins here. // When you do have to add things here you might want to consider creating a package such to share with other plugins instead as packages // are easier to break down. // See: https://docs.elastic.dev/kibana-dev-docs/key-concepts/platform-intro#public-plugin-api ```
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.
Summary
See: #110903
This removes all the top level API
export *spots from:metrics_entitiesplugin within the server sectionThis reduces the number of metrics and warning about undocumented functions.
In the file
metrics_entites/server/index.tsI now put the advice of: