xcstrings-cli 1.5.0 → 1.6.1

package/README.md

@@ -2,16 +2,9 @@
 
 [![Test](https://github.com/mshibanami/Docsloth/actions/workflows/test.yml/badge.svg)](https://github.com/mshibanami/Docsloth/actions/workflows/test.yml) [![npm version](https://badge.fury.io/js/xcstrings-cli.svg)](https://badge.fury.io/js/xcstrings-cli) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-This is a command-line tool designed for working with **xcstrings** files, we follow these principles:
+This is a command-line tool designed for working with **xcstrings** files, such as adding and removing localized strings. It supports JSON5 and YAML formats for inputting translations.
 
-- **Preserve Xcode’s formatting**: It avoids making unnecessary changes to `xcstrings` files generated by Xcode, including indentation, spacing, and ordering.
-- **No automatic translation**: It does not translate any content in your existing `xcstrings` files.
-- **AI-friendly workflow**: It makes it easy to import translations generated by AI services, such as ChatGPT, into your `xcstrings` files.
-
-## AI Translation Support
-
-We also provide a Custom GPT that can help you generate translations and output them in the form of an `xcstrings` command.  
-Check it out here: [xcstrings-cli Helper](https://chatgpt.com/g/g-69365945f8bc8191be3146f880238957-xcstrings-cli-helper).
+We also provide a Custom GPT that can help you generate translations and output them in the form of an `xcstrings` command. Check it out here: [xcstrings-cli Helper](https://chatgpt.com/g/g-69365945f8bc8191be3146f880238957-xcstrings-cli-helper). (The configuration is in [helpers/helper-config.md](./helpers/helper-config.md).)
 
 ## Installation
 
@@ -35,7 +28,17 @@ This will ask you some questions and create an `xcstrings-cli.json` file in the
 # Add with key, comment, and default language string
 xcstrings add --key greeting --comment "A greeting message." --string "Hello, World."
 
-# Add with key, comment, and translations JSON
+# Add with key, comment, and translations YAML via heredoc
+xcstrings add \
+    --key greeting \
+    --comment "A greeting message." \
+    --strings << EOF
+en: Hello, World.
+ja: こんにちは、世界。
+zh-Hans: 你好，世界。
+EOF
+
+# Or add translations JSON
 xcstrings add \
     --key greeting \
     --comment "A greeting message." \
@@ -47,6 +50,13 @@ xcstrings add \
 }
 EOF
 
+# Add translations via file
+xcstrings add \
+    --key greeting \
+    --comment "A greeting message." \
+    --strings-format yaml \
+    --strings < translations.yaml
+
 # Add with only key and comment
 xcstrings add --key greeting --comment "A greeting message."
 ```
@@ -103,8 +113,8 @@ You can use `xcstrings --help` or `xcstrings <sub-command> --help` to see the li
 * `--strings-format`: `string` (Optional, default: `auto`)
     * The format of the data provided with `--strings`. Options are:
         * `auto`: Auto-detect format based on content.
-        * `json`: JSON format. (It uses `json5` internally.)
         * `yaml`: YAML format. (It uses `js-yaml` internally.)
+        * `json`: JSON format. (It uses `json5` internally.)
 * `--comment`: `string` (Optional)
     * The comment for the string to add, intended for translators.
 

package/dist/index.js

@@ -1963,16 +1963,16 @@ const ue = (e, n) => {
     }
   const r = [];
   try {
-    return ue(Le.parse(i), "json");
+    return ue(mn.load(i), "yaml");
   } catch (o) {
-    r.push(`json error: ${fe(o)}`);
+    r.push(`yaml error: ${fe(o)}`);
   }
   try {
-    return ue(mn.load(i), "yaml");
+    return ue(Le.parse(i), "json");
   } catch (o) {
-    r.push(`yaml error: ${fe(o)}`);
+    r.push(`json error: ${fe(o)}`);
   }
-  throw new Error(`Failed to parse --strings input. Provide valid JSON or YAML, or specify --strings-format. ${r.join(" | ")}`);
+  throw new Error(`Failed to parse --strings input. Provide valid YAML or JSON, or specify --strings-format. ${r.join(" | ")}`);
 };
 async function si() {
   return new Promise((e) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xcstrings-cli",
-  "version": "1.5.0",
+  "version": "1.6.1",
   "description": "A command line tool for handling xcstrings files.",
   "type": "module",
   "bin": {