feat(i18n): translation key autocomplete #231

adamdehaven · 2023-03-09T20:19:40Z

Summary

Provide type-safety and auto-completion for translation keys when utilizing the t(), te(), and tm() functions.

Todo:

update usage in khcp-ui https://github.com/Kong/khcp-ui/pull/4512
update usage throughout shared-ui-components https://github.com/Kong/shared-ui-components/pull/743
update usage throughout kadmin-ui https://github.com/Kong/kadmin-ui/pull/647
update usage in konnect-ui-apps https://github.com/Kong/konnect-ui-apps/pull/198

Translation Component types

I can't get auto-completion to work with the keypath prop of the i18n-t (Translation.ts) component as I get an error when setting the String as PropType<PathToDotNotation<MessageSource, string>>:

The inferred type of X references a type with a cyclic structure which cannot be trivially serialized.

It appears to be an issue related to the recursion necessary to parse the JSON object.

PR Checklist

Naming & Structure: the files and package structure use the conventions outlined in the Creating a Package docs.
Tests pass: check the output of all package unit and/or component tests.
- If this PR is the result of a bug, test coverage was added accordingly.
Functional: all changes do not break existing APIs, but if so, a BREAKING CHANGE commit is in place to bump the major version.
Conventional Commits all commits follow the conventional commit standards outlined in the main README.
Docs: includes a technically accurate README, and the docs have been updated accordingly based on the changes in this PR.

packages/core/i18n/sandbox/locales/en.json

packages/portal/document-viewer/src/components/DocumentViewer.vue

- @kong-ui-public/spec-renderer@0.7.10

- @kong-ui-public/spec-renderer@0.7.11 - @kong-ui-public/swagger-ui-web-component@0.4.13

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

- @kong-ui-public/metric-cards@0.1.15 - @kong-ui-public/app-layout@0.13.25 - @kong-ui-public/copy-uuid@0.2.22 - @kong-ui-public/misc-widgets@0.2.24 - @kong-ui-public/document-viewer@0.5.24 - @kong-ui-public/spec-renderer@0.7.12 - @kong-ui-public/swagger-ui-web-component@0.4.14

- @kong-ui-public/spec-renderer@0.7.13 - @kong-ui-public/swagger-ui-web-component@0.4.15

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

- @kong-ui-public/metric-cards@0.1.16 - @kong-ui-public/app-layout@0.13.26 - @kong-ui-public/copy-uuid@0.2.23 - @kong-ui-public/misc-widgets@0.2.25 - @kong-ui-public/document-viewer@0.5.25 - @kong-ui-public/spec-renderer@0.7.14

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

- @kong-ui-public/metric-cards@0.1.17 - @kong-ui-public/app-layout@0.13.27 - @kong-ui-public/copy-uuid@0.2.24 - @kong-ui-public/misc-widgets@0.2.26 - @kong-ui-public/document-viewer@0.5.26 - @kong-ui-public/spec-renderer@0.7.15

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

- @kong-ui-public/metric-cards@0.1.18 - @kong-ui-public/app-layout@0.13.28 - @kong-ui-public/copy-uuid@0.2.25 - @kong-ui-public/misc-widgets@0.2.27 - @kong-ui-public/document-viewer@0.5.27 - @kong-ui-public/spec-renderer@0.7.16

adamdehaven added 2 commits March 9, 2023 12:53

feat(i18n): translation key autocomplete

17117a5

fix(i18n): interfaces

745def2

adamdehaven requested review from ValeryG and jillztom as code owners March 9, 2023 20:19

adamdehaven self-assigned this Mar 9, 2023

fix(document-viewer): translation reference

276ad83

adamdehaven requested a review from a team as a code owner March 9, 2023 20:26

zekth reviewed Mar 9, 2023

View reviewed changes

packages/core/i18n/sandbox/locales/en.json Outdated Show resolved Hide resolved

adamdehaven added 2 commits March 9, 2023 16:11

fix: add broken type

f2b92ff

chore: comment

db1a6c0

ValeryG requested changes Mar 9, 2023

View reviewed changes

packages/portal/document-viewer/src/components/DocumentViewer.vue Show resolved Hide resolved

ValeryG previously approved these changes Mar 9, 2023

View reviewed changes

refactor: change any type to record

93211e9

adamdehaven dismissed ValeryG’s stale review via 93211e9 March 9, 2023 21:24

adamdehaven added 2 commits March 9, 2023 16:24

chore: formatting

5cbb2de

chore: test file

e330568

adamdehaven marked this pull request as draft March 9, 2023 22:17

adamdehaven and others added 13 commits March 12, 2023 15:57

fix(i18n): allow ending on a partial path

61cbd08

fix(spec-operations): update badge colors [khcp-5779] (#232)

09aee5f

chore(release): publish [skip ci]

7541c14

- @kong-ui-public/spec-renderer@0.7.10

fix(web-component): bump swagger ui kong theme universal pkg (#233)

624cf4b

chore(release): publish [skip ci]

8f67856

- @kong-ui-public/spec-renderer@0.7.11 - @kong-ui-public/swagger-ui-web-component@0.4.13

chore(deps): update dependency @kong/kongponents to ^8.34.1 (#234)

8f89149

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

fix(deps): update dependency swagger-ui to ^4.16.0 (#235)

0ba4276

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

fix(swagger-ui-web-component): bump package version (#236)

d37480c

chore(release): publish [skip ci]

aad680a

- @kong-ui-public/spec-renderer@0.7.13 - @kong-ui-public/swagger-ui-web-component@0.4.15

chore(deps): update dependency @kong/kongponents to ^8.34.2 (#237)

d809c6c

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

chore(release): publish [skip ci]

4d3743f

- @kong-ui-public/metric-cards@0.1.16 - @kong-ui-public/app-layout@0.13.26 - @kong-ui-public/copy-uuid@0.2.23 - @kong-ui-public/misc-widgets@0.2.25 - @kong-ui-public/document-viewer@0.5.25 - @kong-ui-public/spec-renderer@0.7.14

chore(deps): update dependency @kong/kongponents to ^8.36.0 (#238)

93b6502

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

kongponents-bot and others added 11 commits March 12, 2023 16:24

chore(release): publish [skip ci]

03ed9a4

- @kong-ui-public/metric-cards@0.1.17 - @kong-ui-public/app-layout@0.13.27 - @kong-ui-public/copy-uuid@0.2.24 - @kong-ui-public/misc-widgets@0.2.26 - @kong-ui-public/document-viewer@0.5.26 - @kong-ui-public/spec-renderer@0.7.15

chore(deps): update dependency @kong/kongponents to ^8.37.0 (#239)

62d0b4c

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

chore(deps): update dependency cypress to ^12.7.0 (#240)

65f19e5

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

chore(release): publish [skip ci]

d617f00

- @kong-ui-public/metric-cards@0.1.18 - @kong-ui-public/app-layout@0.13.28 - @kong-ui-public/copy-uuid@0.2.25 - @kong-ui-public/misc-widgets@0.2.27 - @kong-ui-public/document-viewer@0.5.27 - @kong-ui-public/spec-renderer@0.7.16

fix(types): use proper interface

a506685

chore(i18n): update interface

e95cb6a

test(i18n): update unit tests

42cc3b9

docs(i18n): update examples

32148ff

Merge branch 'main' into feat/i18n-translation-key-autocomplete

9d7cef4

chore: lockfile

d61ae69

feat(i18n): add interface

ad42a5e

adamdehaven marked this pull request as ready for review March 14, 2023 15:03

adamdehaven requested review from kongponents-bot and a team as code owners March 14, 2023 15:03

ValeryG approved these changes Mar 14, 2023

View reviewed changes

adamdehaven merged commit bdc237d into main Mar 14, 2023

adamdehaven deleted the feat/i18n-translation-key-autocomplete branch March 14, 2023 15:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(i18n): translation key autocomplete #231

feat(i18n): translation key autocomplete #231

adamdehaven commented Mar 9, 2023 •

edited

Loading

feat(i18n): translation key autocomplete #231

feat(i18n): translation key autocomplete #231

Conversation

adamdehaven commented Mar 9, 2023 • edited Loading

Summary

Translation Component types

PR Checklist

adamdehaven commented Mar 9, 2023 •

edited

Loading