[NP] add platform main principles #53866
Conversation
mshustov
added
chore
Team:Core
|
Pinging @elastic/kibana-platform (Team:Platform) |
mshustov
force-pushed
the
np-principles
branch
from
6ebb6c8 to
2a5ca5d
Compare
src/core/PRINCIPLES.md
Outdated
| - search | ||
| ``` | ||
| ### Explicit dependencies | ||
| Each plugin should declare dependencies on the other plugins explicitly. Plugins cannot have circular dependencies. Plugins shouldn't have hidden dependencies. |
There was a problem hiding this comment.
Plugins should also not have hard dependencies on registered values. For example, one plugin should handle the case where a specific visualization type has not been registered, unless it has declared an explicit dependency on that plugin.
There was a problem hiding this comment.
I see the point. This is a particular case of Plugins shouldn't have hidden dependencies. Don't know if we should provide a specific example of it. Otherwise, the file will grow to an unmanageable size quite soon. WDYT?
There was a problem hiding this comment.
I think this is a pretty common one that I've had to warn about before. Though TypeScript does help us out here now, I'm not sure all teams are going to be using TS everywhere.
There was a problem hiding this comment.
what if express it as Plugins shouldn't access runtime objects, HTTP endpoints, DOM nodes, etc. created by a third party plugin without declaring a dependency on this plugin.
Co-Authored-By: Josh Dover <[email protected]>
Co-Authored-By: Rudolf Meijering <[email protected]>
mshustov
changed the title
* add platform main principles * update docs * unify styles * remove guidelines. principles should cover this * Apply suggestions from code review Co-Authored-By: Josh Dover <[email protected]> * Apply suggestions from code review Co-Authored-By: Rudolf Meijering <[email protected]> * address comments Co-authored-by: Josh Dover <[email protected]> Co-authored-by: Rudolf Meijering <[email protected]>
* add platform main principles * update docs * unify styles * remove guidelines. principles should cover this * Apply suggestions from code review Co-Authored-By: Josh Dover <[email protected]> * Apply suggestions from code review Co-Authored-By: Rudolf Meijering <[email protected]> * address comments Co-authored-by: Josh Dover <[email protected]> Co-authored-by: Rudolf Meijering <[email protected]> Co-authored-by: Josh Dover <[email protected]> Co-authored-by: Rudolf Meijering <[email protected]>
mshustov
added
backported
and removed
backport:skip
Summary
This PR formalizes NP principles. It will be used as a guide to verify decisions in the future.
[skip-ci]