kibana/examples/esql_ast_inspector/public/plugin.ts
Gerard Soldevila da80d01ab5
[8.x] Sustainable Kibana Architecture: Move modules owned by @elastic/kibana-esql (#202722) (#203390)
# Backport

This will backport the following commits from `main` to `8.x`:
- [Sustainable Kibana Architecture: Move modules owned by
`@elastic/kibana-esql`
(#202722)](https://github.com/elastic/kibana/pull/202722)

<!--- Backport version: 8.9.8 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Gerard
Soldevila","email":"gerard.soldevila@elastic.co"},"sourceCommit":{"committedDate":"2024-12-09T10:33:55Z","message":"Sustainable
Kibana Architecture: Move modules owned by `@elastic/kibana-esql`
(#202722)\n\n## Summary\r\n\r\nThis PR aims at relocating some of the
Kibana modules (plugins and\r\npackages) into a new folder structure,
according to the _Sustainable\r\nKibana Architecture_
initiative.\r\n\r\n> [!IMPORTANT]\r\n> * We kindly ask you to:\r\n> *
Manually fix the errors in the error section below (if there
are\r\nany).\r\n> * Search for the `packages[\\/\\\\]` and
`plugins[\\/\\\\]` patterns in the\r\nsource code (Babel and Eslint
config files), and update them\r\nappropriately.\r\n> * Manually
review\r\n`.buildkite/scripts/pipelines/pull_request/pipeline.ts` to
ensure that\r\nany CI pipeline customizations continue to be correctly
applied after\r\nthe changed path names\r\n> * Review all of the updated
files, specially the `.ts` and `.js` files\r\nlisted in the sections
below, as some of them contain relative paths\r\nthat have been
updated.\r\n> * Think of potential impact of the move, including tooling
and\r\nconfiguration files that can be pointing to the relocated
modules. E.g.:\r\n> * customised eslint rules\r\n> * docs pointing to
source code\r\n\r\n> [!NOTE]\r\n> This PR has been auto-generated.\r\n>
Do not attempt to push any changes unless you know what you are
doing.\r\n> Please
use\r\n[#sustainable_kibana_architecture](https://elastic.slack.com/archives/C07TCKTA22E)\r\nSlack
channel for feedback.\r\n\r\n\r\n\r\n\r\n#### 2 plugin(s) are going to
be relocated:\r\n\r\n| Id | Target folder |\r\n| -- | -------------
|\r\n| `@kbn/esql` | `src/platform/plugins/shared/esql` |\r\n|
`@kbn/esql-datagrid` | `src/platform/plugins/shared/esql_datagrid`
|\r\n\r\n\r\n#### 5 package(s) are going to be relocated:\r\n\r\n | Id |
Target folder |\r\n | -- | ------------- |\r\n | `@kbn/esql-ast` |
`src/platform/packages/shared/kbn-esql-ast` |\r\n| `@kbn/esql-editor` |
`src/platform/packages/private/kbn-esql-editor` |\r\n| `@kbn/esql-utils`
| `src/platform/packages/shared/kbn-esql-utils` |\r\n|
`@kbn/esql-validation-autocomplete`
|\r\n`src/platform/packages/shared/kbn-esql-validation-autocomplete`
|\r\n| `@kbn/language-documentation`
|\r\n`src/platform/packages/private/kbn-language-documentation`
|\r\n\r\n\r\n<details>\r\n<summary>Updated
references</summary>\r\n\r\n```\r\n./.buildkite/scripts/steps/esql_generate_function_metadata.sh\r\n./.buildkite/scripts/steps/esql_grammar_sync.sh\r\n./.eslintignore\r\n./.eslintrc.js\r\n./.i18nrc.json\r\n./docs/developer/plugin-list.asciidoc\r\n./examples/esql_ast_inspector/public/plugin.ts\r\n./examples/esql_validation_example/public/plugin.ts\r\n./package.json\r\n./packages/kbn-esql-validation-autocomplete/src/validation/validation.test.ts\r\n./packages/kbn-monaco/BUILD.bazel\r\n./packages/kbn-repo-packages/package-map.json\r\n./packages/kbn-ts-projects/config-paths.json\r\n./packages/kbn-ui-shared-deps-src/BUILD.bazel\r\n./src/dev/storybook/aliases.ts\r\n./src/platform/packages/private/kbn-esql-editor/jest.config.js\r\n./src/platform/packages/private/kbn-language-documentation/jest.config.js\r\n./src/platform/packages/private/kbn-language-documentation/package.json\r\n./src/platform/packages/shared/kbn-esql-ast/jest.config.js\r\n./src/platform/packages/shared/kbn-esql-utils/jest.config.js\r\n./src/platform/packages/shared/kbn-esql-validation-autocomplete/README.md\r\n./src/platform/packages/shared/kbn-esql-validation-autocomplete/jest.config.js\r\n./src/platform/packages/shared/kbn-esql-validation-autocomplete/jest.integration.config.js\r\n./src/platform/packages/shared/kbn-esql-validation-autocomplete/package.json\r\n./src/platform/packages/shared/kbn-esql-validation-autocomplete/src/autocomplete/helper.ts\r\n./src/platform/plugins/shared/esql/jest.config.js\r\n./src/platform/plugins/shared/esql_datagrid/jest.config.js\r\n./tsconfig.base.json\r\n./yarn.lock\r\n```\r\n</details>\r\n<details>\r\n<summary>Updated
relative
paths</summary>\r\n\r\n```\r\nsrc/platform/packages/private/kbn-esql-editor/jest.config.js:12\r\nsrc/platform/packages/private/kbn-esql-editor/tsconfig.json:2\r\nsrc/platform/packages/private/kbn-language-documentation/jest.config.js:12\r\nsrc/platform/packages/private/kbn-language-documentation/package.json:12\r\nsrc/platform/packages/private/kbn-language-documentation/tsconfig.json:2\r\nsrc/platform/packages/shared/kbn-esql-ast/jest.config.js:12\r\nsrc/platform/packages/shared/kbn-esql-ast/tsconfig.json:2\r\nsrc/platform/packages/shared/kbn-esql-utils/jest.config.js:12\r\nsrc/platform/packages/shared/kbn-esql-utils/tsconfig.json:2\r\nsrc/platform/packages/shared/kbn-esql-validation-autocomplete/jest.config.js:12\r\nsrc/platform/packages/shared/kbn-esql-validation-autocomplete/jest.integration.config.js:12\r\nsrc/platform/packages/shared/kbn-esql-validation-autocomplete/package.json:10\r\nsrc/platform/packages/shared/kbn-esql-validation-autocomplete/package.json:11\r\nsrc/platform/packages/shared/kbn-esql-validation-autocomplete/scripts/generate_function_definitions.ts:389\r\nsrc/platform/packages/shared/kbn-esql-validation-autocomplete/tsconfig.json:2\r\nsrc/platform/plugins/shared/esql/jest.config.js:12\r\nsrc/platform/plugins/shared/esql/tsconfig.json:2\r\nsrc/platform/plugins/shared/esql/tsconfig.json:7\r\nsrc/platform/plugins/shared/esql_datagrid/jest.config.js:12\r\nsrc/platform/plugins/shared/esql_datagrid/tsconfig.json:2\r\nsrc/platform/plugins/shared/esql_datagrid/tsconfig.json:7\r\n```\r\n</details>\r\n<details>\r\n<summary>Script
errors</summary>\r\n\r\n```\r\n\r\n```\r\n</details>\r\n\r\n---------\r\n\r\nCo-authored-by:
kibanamachine
<42973632+kibanamachine@users.noreply.github.com>\r\nCo-authored-by:
Rudolf Meijering
<skaapgif@gmail.com>","sha":"313f973aecac80f7eb6340ba517870999e0da1a3","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Core","release_note:skip","v9.0.0","backport:prev-minor","Team:ESQL"],"number":202722,"url":"https://github.com/elastic/kibana/pull/202722","mergeCommit":{"message":"Sustainable
Kibana Architecture: Move modules owned by `@elastic/kibana-esql`
(#202722)\n\n## Summary\r\n\r\nThis PR aims at relocating some of the
Kibana modules (plugins and\r\npackages) into a new folder structure,
according to the _Sustainable\r\nKibana Architecture_
initiative.\r\n\r\n> [!IMPORTANT]\r\n> * We kindly ask you to:\r\n> *
Manually fix the errors in the error section below (if there
are\r\nany).\r\n> * Search for the `packages[\\/\\\\]` and
`plugins[\\/\\\\]` patterns in the\r\nsource code (Babel and Eslint
config files), and update them\r\nappropriately.\r\n> * Manually
review\r\n`.buildkite/scripts/pipelines/pull_request/pipeline.ts` to
ensure that\r\nany CI pipeline customizations continue to be correctly
applied after\r\nthe changed path names\r\n> * Review all of the updated
files, specially the `.ts` and `.js` files\r\nlisted in the sections
below, as some of them contain relative paths\r\nthat have been
updated.\r\n> * Think of potential impact of the move, including tooling
and\r\nconfiguration files that can be pointing to the relocated
modules. E.g.:\r\n> * customised eslint rules\r\n> * docs pointing to
source code\r\n\r\n> [!NOTE]\r\n> This PR has been auto-generated.\r\n>
Do not attempt to push any changes unless you know what you are
doing.\r\n> Please
use\r\n[#sustainable_kibana_architecture](https://elastic.slack.com/archives/C07TCKTA22E)\r\nSlack
channel for feedback.\r\n\r\n\r\n\r\n\r\n#### 2 plugin(s) are going to
be relocated:\r\n\r\n| Id | Target folder |\r\n| -- | -------------
|\r\n| `@kbn/esql` | `src/platform/plugins/shared/esql` |\r\n|
`@kbn/esql-datagrid` | `src/platform/plugins/shared/esql_datagrid`
|\r\n\r\n\r\n#### 5 package(s) are going to be relocated:\r\n\r\n | Id |
Target folder |\r\n | -- | ------------- |\r\n | `@kbn/esql-ast` |
`src/platform/packages/shared/kbn-esql-ast` |\r\n| `@kbn/esql-editor` |
`src/platform/packages/private/kbn-esql-editor` |\r\n| `@kbn/esql-utils`
| `src/platform/packages/shared/kbn-esql-utils` |\r\n|
`@kbn/esql-validation-autocomplete`
|\r\n`src/platform/packages/shared/kbn-esql-validation-autocomplete`
|\r\n| `@kbn/language-documentation`
|\r\n`src/platform/packages/private/kbn-language-documentation`
|\r\n\r\n\r\n<details>\r\n<summary>Updated
references</summary>\r\n\r\n```\r\n./.buildkite/scripts/steps/esql_generate_function_metadata.sh\r\n./.buildkite/scripts/steps/esql_grammar_sync.sh\r\n./.eslintignore\r\n./.eslintrc.js\r\n./.i18nrc.json\r\n./docs/developer/plugin-list.asciidoc\r\n./examples/esql_ast_inspector/public/plugin.ts\r\n./examples/esql_validation_example/public/plugin.ts\r\n./package.json\r\n./packages/kbn-esql-validation-autocomplete/src/validation/validation.test.ts\r\n./packages/kbn-monaco/BUILD.bazel\r\n./packages/kbn-repo-packages/package-map.json\r\n./packages/kbn-ts-projects/config-paths.json\r\n./packages/kbn-ui-shared-deps-src/BUILD.bazel\r\n./src/dev/storybook/aliases.ts\r\n./src/platform/packages/private/kbn-esql-editor/jest.config.js\r\n./src/platform/packages/private/kbn-language-documentation/jest.config.js\r\n./src/platform/packages/private/kbn-language-documentation/package.json\r\n./src/platform/packages/shared/kbn-esql-ast/jest.config.js\r\n./src/platform/packages/shared/kbn-esql-utils/jest.config.js\r\n./src/platform/packages/shared/kbn-esql-validation-autocomplete/README.md\r\n./src/platform/packages/shared/kbn-esql-validation-autocomplete/jest.config.js\r\n./src/platform/packages/shared/kbn-esql-validation-autocomplete/jest.integration.config.js\r\n./src/platform/packages/shared/kbn-esql-validation-autocomplete/package.json\r\n./src/platform/packages/shared/kbn-esql-validation-autocomplete/src/autocomplete/helper.ts\r\n./src/platform/plugins/shared/esql/jest.config.js\r\n./src/platform/plugins/shared/esql_datagrid/jest.config.js\r\n./tsconfig.base.json\r\n./yarn.lock\r\n```\r\n</details>\r\n<details>\r\n<summary>Updated
relative
paths</summary>\r\n\r\n```\r\nsrc/platform/packages/private/kbn-esql-editor/jest.config.js:12\r\nsrc/platform/packages/private/kbn-esql-editor/tsconfig.json:2\r\nsrc/platform/packages/private/kbn-language-documentation/jest.config.js:12\r\nsrc/platform/packages/private/kbn-language-documentation/package.json:12\r\nsrc/platform/packages/private/kbn-language-documentation/tsconfig.json:2\r\nsrc/platform/packages/shared/kbn-esql-ast/jest.config.js:12\r\nsrc/platform/packages/shared/kbn-esql-ast/tsconfig.json:2\r\nsrc/platform/packages/shared/kbn-esql-utils/jest.config.js:12\r\nsrc/platform/packages/shared/kbn-esql-utils/tsconfig.json:2\r\nsrc/platform/packages/shared/kbn-esql-validation-autocomplete/jest.config.js:12\r\nsrc/platform/packages/shared/kbn-esql-validation-autocomplete/jest.integration.config.js:12\r\nsrc/platform/packages/shared/kbn-esql-validation-autocomplete/package.json:10\r\nsrc/platform/packages/shared/kbn-esql-validation-autocomplete/package.json:11\r\nsrc/platform/packages/shared/kbn-esql-validation-autocomplete/scripts/generate_function_definitions.ts:389\r\nsrc/platform/packages/shared/kbn-esql-validation-autocomplete/tsconfig.json:2\r\nsrc/platform/plugins/shared/esql/jest.config.js:12\r\nsrc/platform/plugins/shared/esql/tsconfig.json:2\r\nsrc/platform/plugins/shared/esql/tsconfig.json:7\r\nsrc/platform/plugins/shared/esql_datagrid/jest.config.js:12\r\nsrc/platform/plugins/shared/esql_datagrid/tsconfig.json:2\r\nsrc/platform/plugins/shared/esql_datagrid/tsconfig.json:7\r\n```\r\n</details>\r\n<details>\r\n<summary>Script
errors</summary>\r\n\r\n```\r\n\r\n```\r\n</details>\r\n\r\n---------\r\n\r\nCo-authored-by:
kibanamachine
<42973632+kibanamachine@users.noreply.github.com>\r\nCo-authored-by:
Rudolf Meijering
<skaapgif@gmail.com>","sha":"313f973aecac80f7eb6340ba517870999e0da1a3"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","labelRegex":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/202722","number":202722,"mergeCommit":{"message":"Sustainable
Kibana Architecture: Move modules owned by `@elastic/kibana-esql`
(#202722)\n\n## Summary\r\n\r\nThis PR aims at relocating some of the
Kibana modules (plugins and\r\npackages) into a new folder structure,
according to the _Sustainable\r\nKibana Architecture_
initiative.\r\n\r\n> [!IMPORTANT]\r\n> * We kindly ask you to:\r\n> *
Manually fix the errors in the error section below (if there
are\r\nany).\r\n> * Search for the `packages[\\/\\\\]` and
`plugins[\\/\\\\]` patterns in the\r\nsource code (Babel and Eslint
config files), and update them\r\nappropriately.\r\n> * Manually
review\r\n`.buildkite/scripts/pipelines/pull_request/pipeline.ts` to
ensure that\r\nany CI pipeline customizations continue to be correctly
applied after\r\nthe changed path names\r\n> * Review all of the updated
files, specially the `.ts` and `.js` files\r\nlisted in the sections
below, as some of them contain relative paths\r\nthat have been
updated.\r\n> * Think of potential impact of the move, including tooling
and\r\nconfiguration files that can be pointing to the relocated
modules. E.g.:\r\n> * customised eslint rules\r\n> * docs pointing to
source code\r\n\r\n> [!NOTE]\r\n> This PR has been auto-generated.\r\n>
Do not attempt to push any changes unless you know what you are
doing.\r\n> Please
use\r\n[#sustainable_kibana_architecture](https://elastic.slack.com/archives/C07TCKTA22E)\r\nSlack
channel for feedback.\r\n\r\n\r\n\r\n\r\n#### 2 plugin(s) are going to
be relocated:\r\n\r\n| Id | Target folder |\r\n| -- | -------------
|\r\n| `@kbn/esql` | `src/platform/plugins/shared/esql` |\r\n|
`@kbn/esql-datagrid` | `src/platform/plugins/shared/esql_datagrid`
|\r\n\r\n\r\n#### 5 package(s) are going to be relocated:\r\n\r\n | Id |
Target folder |\r\n | -- | ------------- |\r\n | `@kbn/esql-ast` |
`src/platform/packages/shared/kbn-esql-ast` |\r\n| `@kbn/esql-editor` |
`src/platform/packages/private/kbn-esql-editor` |\r\n| `@kbn/esql-utils`
| `src/platform/packages/shared/kbn-esql-utils` |\r\n|
`@kbn/esql-validation-autocomplete`
|\r\n`src/platform/packages/shared/kbn-esql-validation-autocomplete`
|\r\n| `@kbn/language-documentation`
|\r\n`src/platform/packages/private/kbn-language-documentation`
|\r\n\r\n\r\n<details>\r\n<summary>Updated
references</summary>\r\n\r\n```\r\n./.buildkite/scripts/steps/esql_generate_function_metadata.sh\r\n./.buildkite/scripts/steps/esql_grammar_sync.sh\r\n./.eslintignore\r\n./.eslintrc.js\r\n./.i18nrc.json\r\n./docs/developer/plugin-list.asciidoc\r\n./examples/esql_ast_inspector/public/plugin.ts\r\n./examples/esql_validation_example/public/plugin.ts\r\n./package.json\r\n./packages/kbn-esql-validation-autocomplete/src/validation/validation.test.ts\r\n./packages/kbn-monaco/BUILD.bazel\r\n./packages/kbn-repo-packages/package-map.json\r\n./packages/kbn-ts-projects/config-paths.json\r\n./packages/kbn-ui-shared-deps-src/BUILD.bazel\r\n./src/dev/storybook/aliases.ts\r\n./src/platform/packages/private/kbn-esql-editor/jest.config.js\r\n./src/platform/packages/private/kbn-language-documentation/jest.config.js\r\n./src/platform/packages/private/kbn-language-documentation/package.json\r\n./src/platform/packages/shared/kbn-esql-ast/jest.config.js\r\n./src/platform/packages/shared/kbn-esql-utils/jest.config.js\r\n./src/platform/packages/shared/kbn-esql-validation-autocomplete/README.md\r\n./src/platform/packages/shared/kbn-esql-validation-autocomplete/jest.config.js\r\n./src/platform/packages/shared/kbn-esql-validation-autocomplete/jest.integration.config.js\r\n./src/platform/packages/shared/kbn-esql-validation-autocomplete/package.json\r\n./src/platform/packages/shared/kbn-esql-validation-autocomplete/src/autocomplete/helper.ts\r\n./src/platform/plugins/shared/esql/jest.config.js\r\n./src/platform/plugins/shared/esql_datagrid/jest.config.js\r\n./tsconfig.base.json\r\n./yarn.lock\r\n```\r\n</details>\r\n<details>\r\n<summary>Updated
relative
paths</summary>\r\n\r\n```\r\nsrc/platform/packages/private/kbn-esql-editor/jest.config.js:12\r\nsrc/platform/packages/private/kbn-esql-editor/tsconfig.json:2\r\nsrc/platform/packages/private/kbn-language-documentation/jest.config.js:12\r\nsrc/platform/packages/private/kbn-language-documentation/package.json:12\r\nsrc/platform/packages/private/kbn-language-documentation/tsconfig.json:2\r\nsrc/platform/packages/shared/kbn-esql-ast/jest.config.js:12\r\nsrc/platform/packages/shared/kbn-esql-ast/tsconfig.json:2\r\nsrc/platform/packages/shared/kbn-esql-utils/jest.config.js:12\r\nsrc/platform/packages/shared/kbn-esql-utils/tsconfig.json:2\r\nsrc/platform/packages/shared/kbn-esql-validation-autocomplete/jest.config.js:12\r\nsrc/platform/packages/shared/kbn-esql-validation-autocomplete/jest.integration.config.js:12\r\nsrc/platform/packages/shared/kbn-esql-validation-autocomplete/package.json:10\r\nsrc/platform/packages/shared/kbn-esql-validation-autocomplete/package.json:11\r\nsrc/platform/packages/shared/kbn-esql-validation-autocomplete/scripts/generate_function_definitions.ts:389\r\nsrc/platform/packages/shared/kbn-esql-validation-autocomplete/tsconfig.json:2\r\nsrc/platform/plugins/shared/esql/jest.config.js:12\r\nsrc/platform/plugins/shared/esql/tsconfig.json:2\r\nsrc/platform/plugins/shared/esql/tsconfig.json:7\r\nsrc/platform/plugins/shared/esql_datagrid/jest.config.js:12\r\nsrc/platform/plugins/shared/esql_datagrid/tsconfig.json:2\r\nsrc/platform/plugins/shared/esql_datagrid/tsconfig.json:7\r\n```\r\n</details>\r\n<details>\r\n<summary>Script
errors</summary>\r\n\r\n```\r\n\r\n```\r\n</details>\r\n\r\n---------\r\n\r\nCo-authored-by:
kibanamachine
<42973632+kibanamachine@users.noreply.github.com>\r\nCo-authored-by:
Rudolf Meijering
<skaapgif@gmail.com>","sha":"313f973aecac80f7eb6340ba517870999e0da1a3"}}]}]
BACKPORT-->

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
2024-12-09 10:20:46 -06:00

57 lines
1.8 KiB
TypeScript

/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the "Elastic License
* 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
* Public License v 1"; you may not use this file except in compliance with, at
* your election, the "Elastic License 2.0", the "GNU Affero General Public
* License v3.0 only", or the "Server Side Public License, v 1".
*/
import { Plugin, CoreSetup } from '@kbn/core/public';
import { DataPublicPluginStart } from '@kbn/data-plugin/public';
import { DataViewsPublicPluginStart } from '@kbn/data-views-plugin/public';
import { DeveloperExamplesSetup } from '@kbn/developer-examples-plugin/public';
import { mount } from './mount';
import image from './esql_ast_inspector.png';
export interface SetupDependencies {
developerExamples: DeveloperExamplesSetup;
}
export interface StartDependencies {
data: DataPublicPluginStart;
dataViews: DataViewsPublicPluginStart;
}
export class ESQLASTInspectorPlugin
implements Plugin<void, void, SetupDependencies, StartDependencies>
{
public setup(core: CoreSetup<StartDependencies>, { developerExamples }: SetupDependencies) {
core.application.register({
id: 'esql_ast_inspector',
title: 'ES|QL AST Inspector',
visibleIn: [],
mount: mount(core),
});
developerExamples.register({
appId: 'esql_ast_inspector',
title: 'ES|QL AST Inspector',
description: 'Inspect the ES|QL AST.',
image,
links: [
{
label: 'README',
href: 'https://github.com/elastic/kibana/tree/main/src/platform/packages/shared/kbn-esql-validation-autocomplete/README.md',
iconType: 'logoGithub',
size: 's',
target: '_blank',
},
],
});
}
public start() {}
public stop() {}
}