mudhorn/n8n
1
0
Fork 0
mirror of https://github.com/n8n-io/n8n.git synced 2025-01-11 12:57:29 -08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

✏️ Update TS with JSON

Browse source
This commit is contained in:
Iván Ovejero 2021-11-24 12:33:48 +01:00
parent ed68ae8055
commit 5f3759b3a7
1 changed files with 151 additions and 155 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

306
packages/editor-ui/src/i18n/README.md
View file

@ -31,16 +31,14 @@ Base text is directly rendered with no dependencies. Base text is supplied by th
### Locating base text ### Locating base text
Each base text file is located at `/packages/editor-ui/src/i18n/locales/{localeIdentifier}.ts` and exports an object where keys are Vue component names (and their containing dirs if any) and references to parts of those Vue components. Each base text file is located at `/packages/editor-ui/src/i18n/locales/{localeIdentifier}.json` and exports an object where keys are Vue component names (and their containing dirs if any) and references to parts of those Vue components.
```js ```json
export default { "nodeCreator": {
nodeCreator: { "categoryNames": {
categoryNames: { "analytics": "🇩🇪 Analytics",
coreNodes: '🇩🇪 Core Nodes', "communication": "🇩🇪 Communication",
analytics: '🇩🇪 Analytics', "coreNodes": "🇩🇪 Core Nodes",
communication: '🇩🇪 Communication',
},
``` ```
### Translating base text ### Translating base text
@ -48,7 +46,7 @@ export default {
1. For the new locale identifier, e.g. `de`, copy the `en` base text and rename it: 1. For the new locale identifier, e.g. `de`, copy the `en` base text and rename it:
```sh ```sh
cp ./packages/editor-ui/src/i18n/locales/en.ts ./packages/editor-ui/src/i18n/locales/de.ts cp ./packages/editor-ui/src/i18n/locales/en.json ./packages/editor-ui/src/i18n/locales/de.json
``` ```
2. Check in the UI for a base text string to translate, and find it in the newly created base text file. 2. Check in the UI for a base text string to translate, and find it in the newly created base text file.
@ -63,29 +61,29 @@ Optionally, remove any untranslated strings from the new base text file. Untrans
As a convenience, the base text file may contain the special key `reusableBaseText` to share strings between translations. For more information, refer to Vue i18n's [linked locale messages](https://kazupon.github.io/vue-i18n/guide/messages.html#linked-locale-messages). As a convenience, the base text file may contain the special key `reusableBaseText` to share strings between translations. For more information, refer to Vue i18n's [linked locale messages](https://kazupon.github.io/vue-i18n/guide/messages.html#linked-locale-messages).
```js ```json
export default { {
reusableBaseText: { "reusableBaseText": {
save: '🇩🇪 Save', "save": "🇩🇪 Save",
}, },
duplicateWorkflowDialog: { "duplicateWorkflowDialog": {
enterWorkflowName: '🇩🇪 Enter workflow name', "enterWorkflowName": "🇩🇪 Enter workflow name",
save: '@:reusableBaseText.save', "save": "@:reusableBaseText.save",
}, },
saveButton: { "saveButton": {
save: '@:reusableBaseText.save', "save": "@:reusableBaseText.save",
saving: '🇩🇪 Saving', "saving": "🇩🇪 Saving",
saved: '🇩🇪 Saved', "saved": "🇩🇪 Saved",
}, },
``` ```
As a convenience, the base text file may also contain the special key `numberFormats` to localize numbers. For more information, refer to Vue i18n's [number localization](https://kazupon.github.io/vue-i18n/guide/number.html#number-localization). As a convenience, the base text file may also contain the special key `numberFormats` to localize numbers. For more information, refer to Vue i18n's [number localization](https://kazupon.github.io/vue-i18n/guide/number.html#number-localization).
```js ```json
export default { {
numberFormats: { "numberFormats": {
decimal: { "decimal": {
style: 'decimal', "style": "decimal",
}, },
}, },
} }
@ -108,9 +106,9 @@ GitHub
├── GitHub.node.ts ├── GitHub.node.ts
├── GitHubTrigger.node.ts ├── GitHubTrigger.node.ts
└── translations └── translations
├── de.ts ├── de.json
├── es.ts ├── es.json
└── ja.ts └── ja.json
``` ```
Each node translation file may contain the translations for one or both (regular and trigger) nodes. Each node translation file may contain the translations for one or both (regular and trigger) nodes.
@ -122,9 +120,9 @@ Google
└── Drive └── Drive
├── GoogleDrive.node.ts ├── GoogleDrive.node.ts
└── translations └── translations
├── de.js ├── de.json
├── es.ts ├── es.json
└── ja.ts └── ja.json
``` ```
For nodes in versioned dirs, locate the `/translations` dir alongside the versioned `*.node.ts` file: For nodes in versioned dirs, locate the `/translations` dir alongside the versioned `*.node.ts` file:
@ -138,18 +136,18 @@ Mattermost
├── methods ├── methods
├── transport ├── transport
└── translations └── translations
├── de.js ├── de.json
├── es.ts ├── es.json
└── ja.ts └── ja.json
``` ```
### Translating dynamic text ### Translating dynamic text
> **Note**: In the examples below, the node source is located at `/packages/nodes-base/nodes/Github/GitHub.node.ts` and the node translation is located at `/packages/nodes-base/nodes/Github/translations/de.ts`. > **Note**: In the examples below, the node source is located at `/packages/nodes-base/nodes/Github/GitHub.node.ts` and the node translation is located at `/packages/nodes-base/nodes/Github/translations/de.json`.
Each node translation is an object with a key that matches the node's `description.name`: Each node translation is an object with a key that matches the node's `description.name`:
```js ```ts
export class Github implements INodeType { export class Github implements INodeType {
description: INodeTypeDescription = { description: INodeTypeDescription = {
displayName: 'GitHub', displayName: 'GitHub',
@ -160,26 +158,26 @@ export class Github implements INodeType {
version: 1, version: 1,
``` ```
```js ```json
module.exports = { {
github: {}, // key from node's description.name "github": {}, // key from node's description.name
githubTrigger: {}, // key from node's description.name "githubTrigger": {}, // key from node's description.name
}; };
``` ```
The object inside allows for three keys: `header`, `credentialsModal` and `nodeView`. These are the _sections_ of each node translation: The object inside allows for three keys: `header`, `credentialsModal` and `nodeView`. These are the _sections_ of each node translation:
```js ```json
module.exports = { {
github: { "github": {
header: {}, "header": {},
credentialsModal: {}, "credentialsModal": {},
nodeView: {}, "nodeView": {},
}, },
githubTrigger: { "githubTrigger": {
header: {}, "header": {},
credentialsModal: {}, "credentialsModal": {},
nodeView: {}, "nodeView": {},
}, },
}; };
``` ```
@ -190,7 +188,7 @@ module.exports = {
The `header` section points to an object that may contain only two keys, `displayName` and `description`, matching the node's `description.displayName` and `description.description`. These are used in the nodes panel, in the node view and in the node credentials modal. The `header` section points to an object that may contain only two keys, `displayName` and `description`, matching the node's `description.displayName` and `description.description`. These are used in the nodes panel, in the node view and in the node credentials modal.
```js ```ts
export class Github implements INodeType { export class Github implements INodeType {
description: INodeTypeDescription = { description: INodeTypeDescription = {
displayName: 'GitHub', // key to use in translation displayName: 'GitHub', // key to use in translation
@ -201,12 +199,12 @@ export class Github implements INodeType {
version: 1, version: 1,
``` ```
```js ```json
module.exports = { {
github: { "github": {
header: { "header": {
displayName: '🇩🇪 GitHub', "displayName": "🇩🇪 GitHub",
description: '🇩🇪 Consume GitHub API', "description": "🇩🇪 Consume GitHub API",
}, },
}, },
}; };
@ -231,7 +229,7 @@ Header text is used wherever the node's display name and description are needed:
The `credentialsModal` section points to an object containing a key that matches the node credential `name`. The `credentialsModal` section points to an object containing a key that matches the node credential `name`.
```js ```ts
export class GithubApi implements ICredentialType { export class GithubApi implements ICredentialType {
name = 'githubApi'; // key to use in translation name = 'githubApi'; // key to use in translation
displayName = 'Github API'; displayName = 'Github API';
@ -239,21 +237,21 @@ export class GithubApi implements ICredentialType {
properties: INodeProperties[] = [ properties: INodeProperties[] = [
``` ```
```js ```json
module.exports = { {
github: { "github": {
header: {}, "header": {},
credentialsModal: { "credentialsModal": {
githubApi: {} // key from node credential name "githubApi": {} // key from node credential name
}, },
nodeView: {}, "nodeView": {},
}, },
}; };
``` ```
The node credential `name` key points to an object containing translation keys that match the node's credential parameter names: The node credential `name` key points to an object containing translation keys that match the node's credential parameter names:
```js ```ts
export class GithubApi implements ICredentialType { export class GithubApi implements ICredentialType {
name = 'githubApi'; name = 'githubApi';
displayName = 'Github API'; displayName = 'Github API';
@ -282,43 +280,43 @@ export class GithubApi implements ICredentialType {
} }
``` ```
```js ```json
module.exports = { {
github: { "github": {
header: {}, "header": {},
credentialsModal: { "credentialsModal": {
githubApi: { "githubApi": {
server: {} // key from node credential parameter name "server": {} // key from node credential parameter name
user: {} // key from node credential parameter name "user": {} // key from node credential parameter name
accessToken: {} // key from node credential parameter name "accessToken": {} // key from node credential parameter name
}, },
}, },
nodeView: {}, "nodeView": {},
}, },
}; };
``` ```
The object for each node credential parameter allows for the keys `displayName`, `description`, and `placeholder`. The object for each node credential parameter allows for the keys `displayName`, `description`, and `placeholder`.
```js ```json
module.exports = { {
github: { "github": {
header: {}, "header": {},
credentialsModal: { "credentialsModal": {
githubApi: { "githubApi": {
server: { "server": {
displayName: '🇩🇪 Github Server', "displayName": "🇩🇪 Github Server",
description: '🇩🇪 The server to connect to. Only has to be set if Github Enterprise is used.', "description": "🇩🇪 The server to connect to. Only has to be set if Github Enterprise is used.",
}, },
user: { "user": {
placeholder: '🇩🇪 Hans', "placeholder": "🇩🇪 Hans",
}, },
accessToken: { "accessToken": {
placeholder: '🇩🇪 123', "placeholder": "🇩🇪 123",
}, },
}, },
}, },
nodeView: {}, "nodeView": {},
}, },
}; };
``` ```
@ -331,7 +329,7 @@ module.exports = {
The `nodeView` section points to an object containing translation keys that match the node's operational parameters. The `nodeView` section points to an object containing translation keys that match the node's operational parameters.
```js ```ts
export class Github implements INodeType { export class Github implements INodeType {
description: INodeTypeDescription = { description: INodeTypeDescription = {
displayName: 'GitHub', displayName: 'GitHub',
@ -347,13 +345,13 @@ export class Github implements INodeType {
}, },
``` ```
```js ```json
module.exports = { {
github: { "github": {
header: {}, "header": {},
credentialsModal: {}, "credentialsModal": {},
nodeView: { "nodeView": {
resource: {}, // key from node parameter name "resource": {}, // key from node parameter name
}, },
}, },
}; };
@ -367,7 +365,7 @@ A node parameter allows for different translation keys depending on parameter ty
Allowed keys: `displayName`, `description`, and `placeholder`. Allowed keys: `displayName`, `description`, and `placeholder`.
```js ```ts
{ {
displayName: 'Repository Owner', displayName: 'Repository Owner',
name: 'owner', // key to use in translation name: 'owner', // key to use in translation
@ -378,16 +376,16 @@ Allowed keys: `displayName`, `description`, and `placeholder`.
}, },
``` ```
```js ```json
module.exports = { {
github: { "github": {
header: {}, "header": {},
credentialsModal: {}, "credentialsModal": {},
nodeView: { "nodeView": {
owner: { // key from node parameter name "owner": { // key from node parameter name
displayName: '🇩🇪 Repository Owner', "displayName": "🇩🇪 Repository Owner",
placeholder: '🇩🇪 n8n-io', "placeholder": "🇩🇪 n8n-io",
description: '🇩🇪 Owner of the repository.', "description": "🇩🇪 Owner of the repository.",
}, },
}, },
}, },
@ -404,7 +402,7 @@ Allowed keys: `displayName`, `description`, and `placeholder`.
Allowed subkeys: `options.{optionName}.displayName` and `options.{optionName}.description`. Allowed subkeys: `options.{optionName}.displayName` and `options.{optionName}.description`.
```js ```ts
{ {
displayName: 'Resource', displayName: 'Resource',
name: 'resource', name: 'resource',
@ -424,21 +422,21 @@ Allowed subkeys: `options.{optionName}.displayName` and `options.{optionName}.de
}, },
``` ```
```js ```json
module.exports = { {
github: { "github": {
header: {}, "header": {},
credentialsModal: {}, "credentialsModal": {},
nodeView: { "nodeView": {
resource: { "resource": {
displayName: '🇩🇪 Resource', "displayName": "🇩🇪 Resource",
description: '🇩🇪 The resource to operate on.', "description": "🇩🇪 The resource to operate on.",
options: { "options": {
file: { // key from node parameter options name "file": { // key from node parameter options name
displayName: '🇩🇪 File', "displayName": "🇩🇪 File",
}, },
issue: { // key from node parameter options name "issue": { // key from node parameter options name
displayName: '🇩🇪 Issue', "displayName": "🇩🇪 Issue",
}, },
}, },
}, },
@ -455,7 +453,7 @@ module.exports = {
Allowed keys: `displayName`, `description`, `placeholder`, and `multipleValueButtonText`. Allowed keys: `displayName`, `description`, `placeholder`, and `multipleValueButtonText`.
```js ```ts
{ {
displayName: 'Labels', displayName: 'Labels',
name: 'labels', // key to use in translation name: 'labels', // key to use in translation
@ -489,35 +487,35 @@ Allowed keys: `displayName`, `description`, `placeholder`, and `multipleValueBut
To reduce nesting and to share translations, a parameter inside a collection's or fixed collection's `options` parameter sits at the same level of nesting as the containing collection in the `nodeView` section: To reduce nesting and to share translations, a parameter inside a collection's or fixed collection's `options` parameter sits at the same level of nesting as the containing collection in the `nodeView` section:
```js ```json
module.exports = { {
github: { "github": {
header: {}, "header": {},
credentialsModal: {}, "credentialsModal": {},
nodeView: { "nodeView": {
// collection // collection
labels: { "labels": {
displayName: '🇩🇪 Labels', "displayName": "🇩🇪 Labels",
multipleValueButtonText: '🇩🇪 Add Label', "multipleValueButtonText": "🇩🇪 Add Label",
}, },
// collection item - same level of nesting // collection item - same level of nesting
label: { "label": {
displayName: '🇩🇪 Label', "displayName": "🇩🇪 Label",
description: '🇩🇪 Label to add to issue.', "description": "🇩🇪 Label to add to issue.",
}, },
// fixed collection // fixed collection
additionalParameters: { "additionalParameters": {
displayName: '🇩🇪 Additional Fields', "displayName": "🇩🇪 Additional Fields",
options: { "options": {
author: { "author": {
displayName: '🇩🇪 Author', "displayName": "🇩🇪 Author",
}, },
}, },
}, },
// fixed collection item - same level of nesting // fixed collection item - same level of nesting
author: { "author": {
displayName: '🇩🇪 Author', "displayName": "🇩🇪 Author",
}, },
}, },
}, },
@ -536,21 +534,19 @@ The base text file may contain the special key `reusableDynamicText`, allowing f
Currently only the keys `oauth.clientId` and `oauth.clientSecret` are supported as a PoC - these two translations will be reused in all node credential parameters. Currently only the keys `oauth.clientId` and `oauth.clientSecret` are supported as a PoC - these two translations will be reused in all node credential parameters.
```js ```json
export default { {
reusableDynamicText: { "reusableDynamicText": {
oauth2: { "oauth2": {
clientId: '🇩🇪 Client ID', "clientId": "🇩🇪 Client ID",
clientSecret: '🇩🇪 Client Secret', "clientSecret": "🇩🇪 Client Secret",
},
},
``` ```
# Building translations # Building translations
## Base text ## Base text
When translating a base text file at `/packages/editor-ui/src/i18n/locales/{localeIdentifier}.ts`: When translating a base text file at `/packages/editor-ui/src/i18n/locales/{localeIdentifier}.json`:
1. Open a terminal: 1. Open a terminal:
@ -571,7 +567,7 @@ Changing the base text file will trigger a rebuild of the client at `http://loca
## Dynamic text ## Dynamic text
When translating a dynamic text file at `/packages/nodes-base/nodes/{node}/translations/{localeIdentifier}.ts`, When translating a dynamic text file at `/packages/nodes-base/nodes/{node}/translations/{localeIdentifier}.json`,
1. Open a terminal: 1. Open a terminal: