forked from maximilien/i18n4go
/
verify_strings.go
300 lines (249 loc) · 10.3 KB
/
verify_strings.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
// Copyright © 2015-2023 The Knative Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package cmds
import (
"fmt"
"path/filepath"
"strings"
"github.com/CharukaK/i18n4go/i18n4go/common"
"github.com/spf13/cobra"
)
type verifyStrings struct {
options common.Options
InputFilename string
OutputDirname string
SourceLanguage string
LanguageFilenames []string
Languages []string
}
func NewVerifyStrings(options *common.Options) *verifyStrings {
languageFilenames := common.ParseStringList(options.LanguageFilesFlag, ",")
languages := common.ParseStringList(options.LanguagesFlag, ",")
return &verifyStrings{options: *options,
InputFilename: options.FilenameFlag,
OutputDirname: options.OutputDirFlag,
LanguageFilenames: languageFilenames,
Languages: languages,
SourceLanguage: options.SourceLanguageFlag,
}
}
// NewVerifyStringsCommand implements 'i18n4go verify-strings' command
func NewVerifyStringsCommand(options *common.Options) *cobra.Command {
verifyStringsCmd := &cobra.Command{
Use: "verify-strings",
Short: "Verify strings in translations",
RunE: func(cmd *cobra.Command, args []string) error {
return NewVerifyStrings(options).Run()
},
}
verifyStringsCmd.Flags().StringVarP(&options.SourceLanguageFlag, "source-language", "s", "en", "the source language of the file, typically also part of the file name, e.g., \"en_US\"")
verifyStringsCmd.Flags().StringVar(&options.LanguagesFlag, "languages", "", "a comma separated list of valid languages with optional territory, e.g., \"en, en_US, fr_FR, es\"")
verifyStringsCmd.Flags().StringVar(&options.LanguageFilesFlag, "language-files", "", `a comma separated list of target files for different languages to compare, e.g., \"en, en_US, fr_FR, es\" if not specified then the languages flag is used to find target files in same directory as source`)
verifyStringsCmd.Flags().StringVarP(&options.OutputDirFlag, "output", "o", "", "the output directory where the missing translation keys will be placed")
verifyStringsCmd.Flags().StringVarP(&options.FilenameFlag, "file", "f", "", "the source translation file")
return verifyStringsCmd
}
func (vs *verifyStrings) Options() common.Options {
return vs.options
}
func (vs *verifyStrings) Println(a ...interface{}) (int, error) {
if vs.options.VerboseFlag {
return fmt.Println(a...)
}
return 0, nil
}
func (vs *verifyStrings) Printf(msg string, a ...interface{}) (int, error) {
if vs.options.VerboseFlag {
return fmt.Printf(msg, a...)
}
return 0, nil
}
func (vs *verifyStrings) Run() error {
fileName, filePath, err := common.CheckFile(vs.InputFilename)
if err != nil {
vs.Println("i18n4go: Error checking input filename: ", vs.InputFilename)
return err
}
targetFilenames := vs.determineTargetFilenames(fileName, filePath)
vs.Println("targetFilenames:", targetFilenames)
for _, targetFilename := range targetFilenames {
err = vs.verify(vs.InputFilename, targetFilename)
if err != nil {
vs.Println("i18n4go: Error verifying target filename: ", targetFilename)
}
}
return err
}
func (vs *verifyStrings) determineTargetFilenames(inputFilename string, inputFilePath string) []string {
if len(vs.LanguageFilenames) != 0 {
return vs.LanguageFilenames
}
var targetFilename string
targetFilenames := make([]string, len(vs.Languages))
for i, lang := range vs.Languages {
targetFilename = strings.Replace(inputFilename, vs.SourceLanguage, lang, -1)
targetFilenames[i] = filepath.Join(inputFilePath, targetFilename)
}
return targetFilenames
}
func (vs *verifyStrings) verify(inputFilename string, targetFilename string) error {
common.CheckFile(targetFilename)
inputI18nStringInfos, err := common.LoadI18nStringInfos(inputFilename)
if err != nil {
vs.Println("i18n4go: Error loading the i18n strings from input filename:", inputFilename)
return err
}
if len(inputI18nStringInfos) == 0 {
return fmt.Errorf("i18n4go: Error input file: %s is empty", inputFilename)
}
inputMap, err := common.CreateI18nStringInfoMap(inputI18nStringInfos)
if err != nil {
return fmt.Errorf("File has duplicated key: %s\n%s", inputFilename, err)
}
targetI18nStringInfos, err := common.LoadI18nStringInfos(targetFilename)
if err != nil {
vs.Println("i18n4go: Error loading the i18n strings from target filename:", targetFilename)
return err
}
var targetExtraStringInfos, targetInvalidStringInfos []common.I18nStringInfo
for _, stringInfo := range targetI18nStringInfos {
if _, ok := inputMap[stringInfo.ID]; ok {
if common.IsTemplatedString(stringInfo.ID) && vs.isTemplatedStringTranslationInvalid(stringInfo) {
vs.Println("i18n4go: WARNING target file has invalid templated translations with key ID: ", stringInfo.ID)
targetInvalidStringInfos = append(targetInvalidStringInfos, stringInfo)
}
delete(inputMap, stringInfo.ID)
} else {
vs.Println("i18n4go: WARNING target file has extra key with ID: ", stringInfo.ID)
targetExtraStringInfos = append(targetExtraStringInfos, stringInfo)
}
}
var verficationError error
if len(targetExtraStringInfos) > 0 {
vs.Println("i18n4go: WARNING target file contains total of extra keys:", len(targetExtraStringInfos))
diffFilename, err := vs.generateExtraKeysDiffFile(targetExtraStringInfos, targetFilename)
if err != nil {
vs.Println("i18n4go: ERROR could not create the diff file:", err)
return err
}
vs.Println("i18n4go: generated diff file:", diffFilename)
verficationError = fmt.Errorf("i18n4go: target file has extra i18n strings with IDs: %s", strings.Join(keysForI18nStringInfos(targetExtraStringInfos), ","))
}
if len(targetInvalidStringInfos) > 0 {
vs.Println("i18n4go: WARNING target file contains total of invalid translations:", len(targetInvalidStringInfos))
diffFilename, err := vs.generateInvalidTranslationDiffFile(targetInvalidStringInfos, targetFilename)
if err != nil {
vs.Println("i18n4go: ERROR could not create the diff file:", err)
return err
}
vs.Println("i18n4go: generated diff file:", diffFilename)
verficationError = fmt.Errorf("i18n4go: target file has invalid i18n strings with IDs: %s", strings.Join(keysForI18nStringInfos(targetInvalidStringInfos), ","))
}
if len(inputMap) > 0 {
vs.Println("i18n4go: ERROR input file does not match target file:", targetFilename)
diffFilename, err := vs.generateMissingKeysDiffFile(valuesForI18nStringInfoMap(inputMap), targetFilename)
if err != nil {
vs.Println("i18n4go: ERROR could not create the diff file:", err)
return err
}
vs.Println("i18n4go: generated diff file:", diffFilename)
verficationError = fmt.Errorf("i18n4go: target file is missing i18n strings with IDs: %s", strings.Join(keysForI18nStringInfoMap(inputMap), ","))
}
return verficationError
}
func (vs *verifyStrings) isTemplatedStringTranslationInvalid(stringInfo common.I18nStringInfo) bool {
if !common.IsTemplatedString(stringInfo.ID) || !common.IsTemplatedString(stringInfo.Translation) {
return false
}
translationArgs := common.GetTemplatedStringArgs(stringInfo.Translation)
argsMap := make(map[string]string)
for _, translationArg := range translationArgs {
argsMap[translationArg] = translationArg
}
var missingArgs []string
idArgs := common.GetTemplatedStringArgs(stringInfo.ID)
for _, idArg := range idArgs {
if _, ok := argsMap[idArg]; !ok {
missingArgs = append(missingArgs, idArg)
}
}
if len(missingArgs) > 0 {
vs.Println("i18n4go: templated string is invalid, missing args in translation:", strings.Join(missingArgs, ","))
return true
}
return false
}
func keysForI18nStringInfos(in18nStringInfos []common.I18nStringInfo) []string {
var keys []string
for _, stringInfo := range in18nStringInfos {
keys = append(keys, stringInfo.ID)
}
return keys
}
func keysForI18nStringInfoMap(inputMap map[string]common.I18nStringInfo) []string {
var keys []string
for k, _ := range inputMap {
keys = append(keys, k)
}
return keys
}
func valuesForI18nStringInfoMap(inputMap map[string]common.I18nStringInfo) []common.I18nStringInfo {
var values []common.I18nStringInfo
for _, v := range inputMap {
values = append(values, v)
}
return values
}
func (vs *verifyStrings) generateMissingKeysDiffFile(missingStringInfos []common.I18nStringInfo, fileName string) (string, error) {
name, pathName, err := common.CheckFile(fileName)
if err != nil {
return "", err
}
diffFilename := name + ".missing.diff.json"
if vs.OutputDirname != "" {
common.CreateOutputDirsIfNeeded(vs.OutputDirname)
diffFilename = filepath.Join(vs.OutputDirname, diffFilename)
} else {
diffFilename = filepath.Join(pathName, diffFilename)
}
return diffFilename, common.SaveI18nStringInfos(vs, vs.Options(), missingStringInfos, diffFilename)
}
func (vs *verifyStrings) generateExtraKeysDiffFile(extraStringInfos []common.I18nStringInfo, fileName string) (string, error) {
name, pathName, err := common.CheckFile(fileName)
if err != nil {
return "", err
}
diffFilename := name + ".extra.diff.json"
if vs.OutputDirname != "" {
common.CreateOutputDirsIfNeeded(vs.OutputDirname)
diffFilename = filepath.Join(vs.OutputDirname, diffFilename)
} else {
diffFilename = filepath.Join(pathName, diffFilename)
}
return diffFilename, common.SaveI18nStringInfos(vs, vs.Options(), extraStringInfos, diffFilename)
}
func (vs *verifyStrings) generateInvalidTranslationDiffFile(invalidStringInfos []common.I18nStringInfo, fileName string) (string, error) {
name, pathName, err := common.CheckFile(fileName)
if err != nil {
return "", err
}
diffFilename := name + ".invalid.diff.json"
if vs.OutputDirname != "" {
common.CreateOutputDirsIfNeeded(vs.OutputDirname)
diffFilename = filepath.Join(vs.OutputDirname, diffFilename)
} else {
diffFilename = filepath.Join(pathName, diffFilename)
}
return diffFilename, common.SaveI18nStringInfos(vs, vs.Options(), invalidStringInfos, diffFilename)
}