xcstrings-cli 1.3.0 → 1.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +52 -32
- package/dist/index.js +1912 -477
- package/package.json +4 -1
package/README.md
CHANGED
|
@@ -1,14 +1,12 @@
|
|
|
1
1
|
# xcstrings-cli
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[](https://github.com/mshibanami/Docsloth/actions/workflows/test.yml) [](https://badge.fury.io/js/xcstrings-cli) [](https://opensource.org/licenses/MIT)
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
This tool is built with the following goals in mind:
|
|
5
|
+
This is a command-line tool designed for working with **xcstrings** files, we follow these principles:
|
|
8
6
|
|
|
9
7
|
- **Preserve Xcode’s formatting**: It avoids making unnecessary changes to `xcstrings` files generated by Xcode, including indentation, spacing, and ordering.
|
|
10
|
-
- **No automatic translation**: It does not translate any content in your existing `xcstrings` files.
|
|
11
|
-
- **AI-friendly workflow**: It
|
|
8
|
+
- **No automatic translation**: It does not translate any content in your existing `xcstrings` files.
|
|
9
|
+
- **AI-friendly workflow**: It makes it easy to import translations generated by AI services, such as ChatGPT, into your `xcstrings` files.
|
|
12
10
|
|
|
13
11
|
## AI Translation Support
|
|
14
12
|
|
|
@@ -34,16 +32,23 @@ This will ask you some questions and create an `xcstrings-cli.json` file in the
|
|
|
34
32
|
**Add a string:**
|
|
35
33
|
|
|
36
34
|
```bash
|
|
35
|
+
# Add with key, comment, and default language string
|
|
36
|
+
xcstrings add --key greeting --comment "A greeting message." --string "Hello, World."
|
|
37
|
+
|
|
38
|
+
# Add with key, comment, and translations JSON
|
|
37
39
|
xcstrings add \
|
|
38
40
|
--key greeting \
|
|
39
|
-
--comment "
|
|
41
|
+
--comment "A greeting message." \
|
|
40
42
|
--strings << EOF
|
|
41
43
|
{
|
|
42
|
-
"ja": "こんにちは、世界。",
|
|
43
44
|
"en": "Hello, World.",
|
|
45
|
+
"ja": "こんにちは、世界。",
|
|
44
46
|
"zh-Hans": "你好，世界。"
|
|
45
47
|
}
|
|
46
48
|
EOF
|
|
49
|
+
|
|
50
|
+
# Add with only key and comment
|
|
51
|
+
xcstrings add --key greeting --comment "A greeting message."
|
|
47
52
|
```
|
|
48
53
|
|
|
49
54
|
**Remove a string:**
|
|
@@ -60,7 +65,7 @@ xcstrings remove --languages ja zh-Hans
|
|
|
60
65
|
|
|
61
66
|
**List supported languages:**
|
|
62
67
|
|
|
63
|
-
|
|
68
|
+
If `xcodeprojPaths` is configured, this command lists languages from your Xcode project (knownRegions) and excludes `Base`. If `xcodeprojPaths` is not configured, it lists languages observed in the xcstrings file.
|
|
64
69
|
|
|
65
70
|
```bash
|
|
66
71
|
xcstrings languages
|
|
@@ -72,30 +77,45 @@ You can use `xcstrings --help` or `xcstrings <sub-command> --help` to see the li
|
|
|
72
77
|
## Command options
|
|
73
78
|
|
|
74
79
|
* `--help, -h`: `boolean` (Optional)
|
|
75
|
-
|
|
80
|
+
* Show help.
|
|
76
81
|
* `--version, -v`: `boolean` (Optional)
|
|
77
|
-
|
|
82
|
+
* Show version.
|
|
78
83
|
* `--config`: `string` (Optional)
|
|
79
|
-
|
|
84
|
+
* The custom config file path. If not specified, xcstrings-cli will look for `xcstrings-cli.json` or `xcstrings-cli.json5` in the current folder or its parent folders until the root.
|
|
85
|
+
* `--path`: `string` (Optional)
|
|
86
|
+
* The xcstrings file path. Defaults to `Localizable.xcstrings` in the current directory, or to the first `xcstringsPaths` entry in the config when present.
|
|
87
|
+
* You can also specify the alias you set in the config file. (`xcstringsPaths` entry with `alias` field)
|
|
80
88
|
|
|
81
89
|
### `add` command options
|
|
82
90
|
|
|
83
|
-
* `--
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
*
|
|
87
|
-
|
|
88
|
-
*
|
|
89
|
-
|
|
91
|
+
* `--key, -k`: `string` (Required)
|
|
92
|
+
* The key of the string to add.
|
|
93
|
+
* `--language, -l`: `string` (Optional)
|
|
94
|
+
* The language of the string provided with `--text`.
|
|
95
|
+
* Ignored if `--text` is not provided.
|
|
96
|
+
* If not specified, it uses the source language defined as `sourceLanguage` in the xcstrings file.
|
|
97
|
+
* Validation follows `missingLanguagePolicy`: `skip` requires the language to be supported; `include` allows any language.
|
|
98
|
+
* `--text`: `string` (Optional)
|
|
99
|
+
* The string value for the language. If omitted, the key is created without a localization for the default language.
|
|
100
|
+
* `--strings`: `string` (Optional)
|
|
101
|
+
* Translation-including JSON or YAML for the key. Pass inline JSON, or provide the flag without a value to read it from stdin (heredoc/pipe).
|
|
102
|
+
* The format is determined by `--strings-format`.
|
|
103
|
+
* `--strings-format`: `string` (Optional, default: `auto`)
|
|
104
|
+
* The format of the data provided with `--strings`. Options are:
|
|
105
|
+
* `auto`: Auto-detect format based on content.
|
|
106
|
+
* `json`: JSON format. (It uses `json5` internally.)
|
|
107
|
+
* `yaml`: YAML format. (It uses `js-yaml` internally.)
|
|
108
|
+
* `--comment`: `string` (Optional)
|
|
109
|
+
* The comment for the string to add, intended for translators.
|
|
90
110
|
|
|
91
111
|
### `remove` command options
|
|
92
112
|
|
|
93
113
|
* `--key, -k`: `string` (Optional if `languages` is specified)
|
|
94
|
-
|
|
114
|
+
* The key of the string to remove. If not specified, xcstrings-cli will remove all strings for the specified languages.
|
|
95
115
|
* `--languages, -l`: `string[]` (Optional if `key` is specified)
|
|
96
|
-
|
|
97
|
-
* `--dry-run`: `boolean` (Optional, default: `false`)
|
|
98
|
-
|
|
116
|
+
* The languages to remove. If not specified, xcstrings-cli will remove the string for all languages.
|
|
117
|
+
* `--dry-run, -n`: `boolean` (Optional, default: `false`)
|
|
118
|
+
* If set to `true`, xcstrings-cli will only show what would be removed without actually removing anything.
|
|
99
119
|
|
|
100
120
|
## Config file
|
|
101
121
|
|
|
@@ -106,8 +126,8 @@ Put an `xcstrings-cli.json5` or `xcstrings-cli.json` file in the project root, a
|
|
|
106
126
|
"xcstringsPaths": [
|
|
107
127
|
"Shared/L10n/Localizable.xcstrings",
|
|
108
128
|
{
|
|
109
|
-
|
|
110
|
-
|
|
129
|
+
"alias": "utils",
|
|
130
|
+
"path": "packages/Utils/Sources/Utils/Resources/Localizable.xcstrings"
|
|
111
131
|
}
|
|
112
132
|
],
|
|
113
133
|
"xcodeprojPaths": [
|
|
@@ -119,15 +139,15 @@ Put an `xcstrings-cli.json5` or `xcstrings-cli.json` file in the project root, a
|
|
|
119
139
|
These are the options for the config file:
|
|
120
140
|
|
|
121
141
|
* **xcstringsPaths**: `string[] | { alias: string, path: string }[]`
|
|
122
|
-
|
|
123
|
-
|
|
142
|
+
* If only one path is provided, xcstrings-cli will use it as the default xcstrings file.
|
|
143
|
+
* If multiple paths are provided, xcstrings-cli will ask you to select an xcstrings file.
|
|
124
144
|
* **xcodeprojPaths**: `string[]` (Optional)
|
|
125
|
-
|
|
126
|
-
|
|
145
|
+
* Paths to Xcode project files used to detect supported languages.
|
|
146
|
+
* If not specified, xcstrings-cli will not check the supported languages in your Xcode project.
|
|
127
147
|
* **missingLanguagePolicy**: `string` (Optional, default: `skip`)
|
|
128
|
-
|
|
129
|
-
* `skip`: Only add translations for languages included in the `xcstrings languages` output.
|
|
130
|
-
* `include`: Add translations
|
|
148
|
+
* How to handle translations for languages that are not included in the `xcstrings languages` output when adding strings. Options are:
|
|
149
|
+
* `skip`: Only add translations for languages included in the `xcstrings languages` output. (Default)
|
|
150
|
+
* `include`: Add translations even when they are not recognized by the Xcode project or xcstrings language list.
|
|
131
151
|
|
|
132
152
|
## LICENSE
|
|
133
153
|
|