Skip to content

Commit 093c31f

Browse files
committed
feat(translation): add help texts to i18n
1 parent f973ab6 commit 093c31f

File tree

5 files changed

+74
-27
lines changed

5 files changed

+74
-27
lines changed

.vscode/launch.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@
99
"type": "node",
1010
"request": "launch",
1111
"name": "Launch Program",
12-
"program": "${workspaceFolder}/dist/cli.js"
12+
"program": "${workspaceFolder}/dist/cli.js",
13+
"args": ["g"]
1314
},
1415
{
1516
"type": "node",

cli.ts

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -21,91 +21,91 @@ program.name('tl').usage('[command] [options]');
2121
program
2222
.command('archive')
2323
.alias('a')
24-
.description('Display archived items')
24+
.description(Localization.instance.get('help.archive'))
2525
.action(() => {
2626
taskline.displayArchive().catch(() => {});
2727
});
2828

2929
program
3030
.command('begin <ids>')
3131
.alias('b')
32-
.description('Start/pause task')
32+
.description(Localization.instance.get('help.begin'))
3333
.action(ids => {
3434
taskline.beginTasks(ids).catch(() => {});
3535
});
3636

3737
program
3838
.command('cancel <ids>')
39-
.description('Cancel/revive task')
39+
.description(Localization.instance.get('help.cancel'))
4040
.action(ids => {
4141
taskline.cancelTasks(ids).catch(() => {});
4242
});
4343

4444
program
4545
.command('check <ids>')
4646
.alias('c')
47-
.description('Check/uncheck task')
47+
.description(Localization.instance.get('help.check'))
4848
.action(ids => {
4949
taskline.checkTasks(ids).catch(() => {});
5050
});
5151

5252
program
5353
.command('clear')
54-
.description('Delete all checked items')
54+
.description(Localization.instance.get('help.clear'))
5555
.action(() => {
5656
taskline.clear().catch(() => {});
5757
});
5858

5959
program
6060
.command('config')
61-
.description('Display active config')
61+
.description(Localization.instance.get('help.config'))
6262
.action(() => {
6363
taskline.displayConfig();
6464
});
6565

6666
program
6767
.command('copy <ids>')
6868
.alias('y')
69-
.description('Copy description to clipboard')
69+
.description(Localization.instance.get('help.copy'))
7070
.action(ids => {
7171
taskline.copyToClipboard(ids).catch(() => {});
7272
});
7373

7474
program
7575
.command('delete <ids>')
7676
.alias('d')
77-
.description('Delete item')
77+
.description(Localization.instance.get('help.delete'))
7878
.action(ids => {
7979
taskline.deleteItems(ids).catch(() => {});
8080
});
8181

8282
program
8383
.command('due <ids> <dueDate>')
84-
.description('Update duedateof task')
84+
.description(Localization.instance.get('help.due'))
8585
.action((ids, dueDate) => {
8686
taskline.updateDueDate(ids, dueDate).catch(() => {});
8787
});
8888

8989
program
9090
.command('edit <id> <description>')
9191
.alias('e')
92-
.description('Edit item description')
92+
.description(Localization.instance.get('help.edit'))
9393
.action((id, description) => {
9494
taskline.editDescription(id, description).catch(() => {});
9595
});
9696

9797
program
9898
.command('find <terms>')
9999
.alias('f')
100-
.description('Search for items')
100+
.description(Localization.instance.get('help.find'))
101101
.action(query => {
102102
taskline.findItems(query).catch(() => {});
103103
});
104104

105105
program
106106
.command('list <terms>')
107107
.alias('l')
108-
.description('List items by attributes')
108+
.description(Localization.instance.get('help.list'))
109109
.action(terms => {
110110
taskline.listByAttributes(terms).then(grouped => {
111111
taskline.displayStats(grouped);
@@ -115,15 +115,15 @@ program
115115
program
116116
.command('move <ids> <boards')
117117
.alias('m')
118-
.description('Move item between boards')
118+
.description(Localization.instance.get('help.move'))
119119
.action((ids, boards) => {
120120
taskline.moveBoards(ids, boards).catch(() => {});
121121
});
122122

123123
program
124124
.command('note <description>')
125125
.alias('n')
126-
.description('Create note')
126+
.description(Localization.instance.get('help.note'))
127127
.option('-b, --board <board>', 'Board')
128128
.action((description, opts) => {
129129
taskline.createNote(description, opts.board).catch(() => {});
@@ -132,7 +132,7 @@ program
132132
program
133133
.command('priority <id> <priority>')
134134
.alias('p')
135-
.description('Update priority of task')
135+
.description(Localization.instance.get('help.priority'))
136136
.action((id, priority) => {
137137
taskline.updatePriority(id, priority).catch(() => {});
138138
});
@@ -141,23 +141,23 @@ program
141141
.command('restore <ids>')
142142

143143
.alias('r')
144-
.description('Restore items from archive')
144+
.description(Localization.instance.get('help.restore'))
145145
.action(ids => {
146146
taskline.restoreItems(ids).catch(() => {});
147147
});
148148

149149
program
150150
.command('star <ids>')
151151
.alias('s')
152-
.description('Star/unstar item')
152+
.description(Localization.instance.get('help.star'))
153153
.action(ids => {
154154
taskline.starItems(ids).catch(() => {});
155155
});
156156

157157
program
158158
.command('task <description>') // Sub-command name
159159
.alias('t') // Alternative sub-command is `al`
160-
.description('Create task') // Command description
160+
.description(Localization.instance.get('help.task')) // Command description
161161
.option('-b, --board <board>', 'Board')
162162
.option('-p, --priority <priority>', 'Priority')
163163
.option('-d, --due <date>', 'Due date')
@@ -172,7 +172,7 @@ program
172172
program
173173
.command('timeline')
174174
.alias('i')
175-
.description('Display timeline view')
175+
.description(Localization.instance.get('help.timeline'))
176176
.action(() => {
177177
taskline.displayByDate().then(grouped => {
178178
taskline.displayStats(grouped);
@@ -181,7 +181,7 @@ program
181181

182182
program
183183
.command('refactor')
184-
.description('Rearrange the IDs of all items')
184+
.description(Localization.instance.get('help.refactor'))
185185
.action(() => {
186186
taskline.refactorIDs().catch(() => {});
187187
});
@@ -198,7 +198,7 @@ if (process.argv.length === 2) {
198198
}
199199

200200
program.on('command:*', function() {
201-
console.error('Invalid command: %s\nSee --help for a list of available commands.', program.args.join(' '));
201+
console.error(Localization.instance.getf('errors.invalidCommand', { params: program.args }));
202202
process.exit(1);
203203
});
204204

i18n/de.json

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,27 @@
11
{
2-
"help": "Tippe `tl --help` um anzufangen!",
2+
"help": {
3+
"archive": "Archivierte Items anzeigen",
4+
"begin": "Aufgabe starten/pausieren",
5+
"cancel": "Aufgabe abbrechen/wiederaufnehmen",
6+
"check": "Aufgabe abhaken/unabhaken",
7+
"clear": "Alle abgeschlossenen Aufgaben archivieren",
8+
"config": "Konfiguration anzeigen",
9+
"copy": "Item in die Zwischenablage kopieren",
10+
"delete": "Item löschen",
11+
"due": "Fälligkeitsdatum ändern",
12+
"edit": "Itembeschreibung ändern",
13+
"find": "Nach Items suchen",
14+
"list": "List items by attributes",
15+
"move": "Items zwischen Tafeln verschieben",
16+
"note": "Notiz erstellen",
17+
"priority": "Priorität von Aufgabe/n updaten",
18+
"restore": "Items wiederherstellen",
19+
"star": "Item mit Stern markieren/unmarkieren",
20+
"task": "Aufgabe erstellen",
21+
"timeline": "Zeitleistenansicht",
22+
"refactor": "ID Bereich aller Items zurücksetzen",
23+
"footer": "Detaillierte Beschreibung auf: https://github.com/perryrh0dan/taskline#flight-manual"
24+
},
325
"config": {
426
"path": "Konfiguration geladen aus {0}",
527
"title": "Konfiguration"
@@ -28,7 +50,7 @@
2850
}
2951
},
3052
"errors": {
31-
53+
"invalidCommand": "Ungültiger Befehl: {0}\nÖffne --help für eine detaillierte Liste aller Befehle."
3254
},
3355
"stats": {
3456
"allDone": "Alles erledigt!",

i18n/en.json

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,27 @@
11
{
2-
"help": "Type `tl --help` to get started!",
2+
"help": {
3+
"archive": "Display archived items",
4+
"begin": "Start/pause task",
5+
"cancel": "Cancel/revive task",
6+
"check": "Check/uncheck task",
7+
"clear": "Delete all checked items",
8+
"config": "Display active config",
9+
"copy": "Copy description to clipboard",
10+
"delete": "Delete item",
11+
"due": "Update duedate of task",
12+
"edit": "Edit item description",
13+
"find": "Search for items",
14+
"list": "List items by attributes",
15+
"move": "Move item between boards",
16+
"note": "Create note",
17+
"priority": "Update priority of task",
18+
"restore": "Restore items from archive",
19+
"star": "Star/unstar item",
20+
"task": "Create task",
21+
"timeline": "Display timeline view",
22+
"refactor": "Rearrange the IDs of all items",
23+
"footer": "Detailed description under: https://github.com/perryrh0dan/taskline#flight-manual"
24+
},
325
"config": {
426
"path": "Config loaded from {0}",
527
"title": "Configuration"
@@ -28,7 +50,7 @@
2850
}
2951
},
3052
"errors": {
31-
53+
"invalidCommand": "Invalid command: {0}\nSee --help for a list of available commands."
3254
},
3355
"stats": {
3456
"allDone": "All done!",

i18n/es.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
{
2-
"help": "Escriba `tl --help` para comenzar.",
2+
"help": {
3+
4+
},
35
"config": {
46
"path": "Configuracion cargada de {0}",
57
"title": "Configuracion"

0 commit comments

Comments
 (0)