Allow custom paths in plugin generator #57766

lizozom · 2020-02-16T16:34:16Z

Summary

Follow up for #55281
Partially resolves #56652

Allow setting custom paths for plugins, to support creating plugins in src/plugins and x-pack/plugins (or elsewhere).
Removes the -i argument (as it is now redundant)
Adds translation support

Checklist

Delete any items that are not applicable to this PR.

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios
This was checked for keyboard-only and screenreader accessibility
This renders correctly on smaller devices using a responsive layout. (You can test this in your browser
This was checked for cross-browser compatibility, including a check against IE11

For maintainers

This was checked for breaking API changes and was labeled appropriately

…n-gen-paths

elasticmachine · 2020-02-17T11:09:39Z

Pinging @elastic/kibana-app-arch (Team:AppArch)

lizozom · 2020-02-17T11:13:08Z

@elasticmachine merge upstream

lizozom · 2020-02-17T11:18:02Z

@elasticmachine merge upstream

Content of translation jsons

…ana into newplatform/plugin-gen-paths

Bamieh

Left some minor comments for i18n to work in the generated plugin. To ensure that the plugin i18n is working you can run the following commands:

Extract i18n labels from the plugin:

node scripts/i18n_extract --output-dir ./plugins/myPlugin --include-config ./plugins/myPlugin/.i18nrc.json

This should generate an en.json in kibana root with the i18n.translate labels in the plugin.

Checking valid i18n usage

node scripts/i18n_check --fix --include-config ./plugins/myPlugin/.i18nrc.json

This should fix any fixable i18n issues in the plugin and error our on unfixable errors (similar to eslint behavior)

Both scripts are ran from kibana root. We also need to update our docs https://www.elastic.co/guide/en/kibana/current/development-plugin-localization.html to start referring to ./plugins/ instead of ../kibana-extra/.

packages/kbn-plugin-generator/sao_template/template/i18nrc.json

packages/kbn-plugin-generator/sao_template/template/translations/ja-JP.json

packages/kbn-plugin-generator/sao_template/template/i18nrc.json

lizozom · 2020-02-17T12:22:08Z

@Bamieh I addressed the fixes
However,
node scripts/i18n_extract --output-dir ./plugins/myPlugin --include-config ./plugins/myPlugin/.i18nrc.json
Runs on the entire project, making it very slow. Is there a way to run it on the plugin only?

Bamieh · 2020-02-17T13:24:58Z

@lizozom You are correct, the path flag must be added to get the desired result we're after.

node scripts/i18n_extract --output-dir ./plugins/myPlugin --include-config ./plugins/myPlugin/.i18nrc.json --path=./plugins/myPlugin/

Bamieh

i18n stuff LGTM. thanks!

Dosant

Tried to create plugin in examples folder. It worked 👍

Minor issue I bumped into:
I answered /examples for the path question and it errored saying folder doesn't exist. examples worked. But I think /examples should also work.

…lugin-gen-paths

lizozom · 2020-02-19T17:05:49Z

@elasticmachine merge upstream

joshdover

Can we add a test to the existing integration_tests for this?

kibanamachine · 2020-02-19T19:09:46Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 1e77b84

History

💚 Build #27184 succeeded 52eac92
💚 Build #27163 succeeded 8c9ba4a
💚 Build #27147 succeeded f6f7d1e
💚 Build #27143 succeeded 5e55302
💔 Build #27145 failed e939358

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

joshdover · 2020-02-19T19:15:29Z

Can we add a test to the existing integration_tests for this?

@lizozom Is this going to be done in a follow up?

* master: (136 commits) [Visualize] Remove legacy appState in visualize (elastic#57330) Use static time for tsvb rollup test (elastic#57701) [SIEM] Fix ResizeObserver polyfill (elastic#58046) [SIEM][Detection Engine] Fixes return codes where some were rule_id instead of id skip flaky suite (elastic#56816) skip flaky suite (elastic#58059) skip flaky suite (elastic#45348) migrates notification server routes to NP (elastic#57906) Moved all of the show/hide toggles outside of ordered lists. (elastic#57163) [APM] NP Migration - Moves plugin server files out of legacy (elastic#57532) [Maps][Telemetry] Migrate Maps telemetry to NP (elastic#55055) Embeddable add panel examples (elastic#57319) Fix useRequest to support query change (elastic#57723) Allow custom paths in plugin generator (elastic#57766) [SIEM][Case] Merge header components (elastic#57816) [ML] New Platform server shim: update job audit messages routes (elastic#57925) [kbn/optimizer] emit success event from reducer when all bundles cached (elastic#57945) [APM] Don’t include UI filters when fetching a specific transaction (elastic#57934) Upgrade yargs (elastic#57720) skip flaky suite (elastic#57762) (elastic#57997) (elastic#57998) ... # Conflicts: # src/plugins/advanced_settings/public/management_app/components/field/__snapshots__/field.test.tsx.snap # src/plugins/advanced_settings/public/management_app/components/field/field.tsx # x-pack/plugins/translations/translations/ja-JP.json # x-pack/plugins/translations/translations/zh-CN.json

* Allow custom paths * Add translation file * Fix jest test * Added more tests * Update docs Content of translation jsons * Leave only one translation file * generate default translations file * Simplify i18n setup * Code review changes Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

* Allow custom paths * Add translation file * Fix jest test * Added more tests * Update docs Content of translation jsons * Leave only one translation file * generate default translations file * Simplify i18n setup * Code review changes Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

Allow custom paths

2de8d5a

lizozom added v8.0.0 v7.7.0 labels Feb 16, 2020

lizozom self-assigned this Feb 16, 2020

Liza K added 4 commits February 17, 2020 07:43

Add translation file

3cc7a48

Fix jest test

9d846ba

Added more tests

7f1c4a9

Merge remote-tracking branch 'upstream/master' into newplatform/plugi…

5e55302

…n-gen-paths

lizozom mentioned this pull request Feb 17, 2020

Update plugin generator to generate NP plugins #55281

Merged

7 tasks

lizozom marked this pull request as ready for review February 17, 2020 11:08

lizozom added Feature:New Platform release_note:skip Skip the PR/issue when compiling release notes Team:AppArch labels Feb 17, 2020

Merge branch 'master' into newplatform/plugin-gen-paths

e939358

Merge branch 'master' into newplatform/plugin-gen-paths

f6f7d1e

lizozom mentioned this pull request Feb 17, 2020

Plugin generator translations and external deps #56652

Closed

3 tasks

lizozom requested review from lukeelmers, joshdover and Bamieh February 17, 2020 11:21

Liza K added 2 commits February 17, 2020 14:08

Update docs

529fcdf

Content of translation jsons

Merge branch 'newplatform/plugin-gen-paths' of github.com:lizozom/kib…

79a901c

…ana into newplatform/plugin-gen-paths

Bamieh requested changes Feb 17, 2020

View reviewed changes

packages/kbn-plugin-generator/sao_template/template/i18nrc.json Show resolved Hide resolved

packages/kbn-plugin-generator/sao_template/template/translations/ja-JP.json Outdated Show resolved Hide resolved

packages/kbn-plugin-generator/sao_template/template/i18nrc.json Show resolved Hide resolved

Leave only one translation file

8c9ba4a

Liza K added 2 commits February 17, 2020 15:55

generate default translations file

c6a784c

Simplify i18n setup

52eac92

Bamieh approved these changes Feb 17, 2020

View reviewed changes

Dosant approved these changes Feb 18, 2020

View reviewed changes

Liza K added 3 commits February 19, 2020 16:37

Merge branch 'master' of github.com:elastic/kibana into newplatform/p…

6bd5d45

…lugin-gen-paths

Code review changes

c679c66

Merge branch 'master' of github.com:elastic/kibana into newplatform/p…

8ef6f05

…lugin-gen-paths

Merge branch 'master' into newplatform/plugin-gen-paths

1e77b84

joshdover reviewed Feb 19, 2020

View reviewed changes

lizozom merged commit e1fa139 into elastic:master Feb 19, 2020

lizozom mentioned this pull request Feb 24, 2020

[7.x] Allow custom paths in plugin generator (#57766) #58342

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow custom paths in plugin generator #57766

Allow custom paths in plugin generator #57766

lizozom commented Feb 16, 2020 •

edited

Loading

elasticmachine commented Feb 17, 2020

lizozom commented Feb 17, 2020

lizozom commented Feb 17, 2020

Bamieh left a comment

lizozom commented Feb 17, 2020

Bamieh commented Feb 17, 2020

Bamieh left a comment •

edited

Loading

Dosant left a comment

lizozom commented Feb 19, 2020

joshdover left a comment

kibanamachine commented Feb 19, 2020

joshdover commented Feb 19, 2020

Allow custom paths in plugin generator #57766

Allow custom paths in plugin generator #57766

Conversation

lizozom commented Feb 16, 2020 • edited Loading

Summary

Checklist

For maintainers

elasticmachine commented Feb 17, 2020

lizozom commented Feb 17, 2020

lizozom commented Feb 17, 2020

Bamieh left a comment

Choose a reason for hiding this comment

Extract i18n labels from the plugin:

Checking valid i18n usage

lizozom commented Feb 17, 2020

Bamieh commented Feb 17, 2020

Bamieh left a comment • edited Loading

Choose a reason for hiding this comment

Dosant left a comment

Choose a reason for hiding this comment

lizozom commented Feb 19, 2020

joshdover left a comment

Choose a reason for hiding this comment

kibanamachine commented Feb 19, 2020

💚 Build Succeeded

History

joshdover commented Feb 19, 2020

lizozom commented Feb 16, 2020 •

edited

Loading

Bamieh left a comment •

edited

Loading