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.

Sign up for GitHub

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

Improved typings #3302

Merged
merged 5 commits into from
Mar 9, 2023
Merged

Improved typings #3302

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8396f9d
Improved typings
djindjic Jan 22, 2023
ec989f6
Merge branch 'main' into patch-1
joshuarrrr Feb 7, 2023
8d75351
Merge branch 'main' into patch-1
joshuarrrr Feb 17, 2023
ce719f0
Merge branch 'main' into patch-1
AMoo-Miki Mar 8, 2023
a29a03b
Nit - rename example deps prop
joshuarrrr Mar 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions src/core/CONVENTIONS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ import { MyAppRoot } from './components/app.ts';
*/
export const renderApp = (
core: CoreStart,
deps: MyPluginDepsStart,
deps: MyPluginStartDeps,
{ element, history }: AppMountParameters
) => {
ReactDOM.render(<MyAppRoot core={core} deps={deps} routerHistory={history} />, element);
Expand All @@ -182,10 +182,10 @@ export const renderApp = (
```ts
// my_plugin/public/plugin.ts

import { Plugin } from '../../src/core/public';
import { Plugin, CoreSetup } from '../../src/core/public';

export class MyPlugin implements Plugin {
public setup(core) {
public setup(core: CoreSetup<MyPluginStartDeps>) {
core.application.register({
id: 'my-app',
async mount(params) {
Expand All @@ -200,14 +200,14 @@ export class MyPlugin implements Plugin {
}
```

Prefer the pattern shown above, using `core.getStartServices()`, rather than store local references retrieved from `start`.
Prefer the pattern shown above, using `core.getStartServices()`, rather than store local references retrieved from `start`.

**Bad:**
```ts
export class MyPlugin implements Plugin {
// Anti pattern
private coreStart?: CoreStart;
private depsStart?: DepsStart;
private depsStart?: DepsStart;

public setup(core) {
core.application.register({
Expand All @@ -218,7 +218,7 @@ export class MyPlugin implements Plugin {
return renderApp(this.coreStart, this.depsStart, params);
}
});
}
}

public start(core, deps) {
// Anti pattern
Expand Down Expand Up @@ -359,5 +359,5 @@ Migration example from the legacy format is available in `src/core/MIGRATION_EXA

### Naming conventions

Export start and setup contracts as `MyPluginStart` and `MyPluginSetup`.
Export start and setup contracts as `MyPluginStart` and `MyPluginSetup`.
This avoids naming clashes, if everyone exported them simply as `Start` and `Setup`.