xcstrings-cli 1.0.0

package/.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

package/.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@3.1.2/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "public",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

package/.github/workflows/release.yml

@@ -0,0 +1,56 @@
+name: Release
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+permissions:
+  contents: write
+  pull-requests: write
+  id-token: write
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 10
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: "pnpm"
+          registry-url: "https://registry.npmjs.org"
+
+      - name: Upgrade npm (for OIDC)
+        run: npm install -g npm@latest
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Build packages
+        run: pnpm build
+
+      - name: Create Release Pull Request or Publish
+        id: changesets
+        uses: changesets/action@v1
+        with:
+          version: pnpm changeset version
+          publish: pnpm release
+          title: "chore: version packages"
+          commit: "chore: version packages"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/.markdownlint.json

@@ -0,0 +1,3 @@
+{
+    "extends": "markdownlint/style/relaxed"
+}

package/.prettierrc

@@ -0,0 +1,7 @@
+{
+  "semi": true,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "printWidth": 80,
+  "tabWidth": 4,
+}

package/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2025 Manabu Nakazawa (https://github.com/mshibanami)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,120 @@
+# xcstrings-cli
+
+A command-line tool designed for working with **xcstrings** files.
+
+## Guiding Principles
+
+This tool is built with the following goals in mind:
+
+- **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. The tool’s purpose is to help you manage and manipulate the files.
+- **AI-friendly workflow**: It is designed to make it easy to import translations generated by AI services now and in the future.
+
+## 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).
+
+## Installation
+
+1. Install xcstrings-cli using npm:
+    ```bash
+    npm install -g xcstrings-cli
+    # or
+    yarn global add xcstrings-cli
+    # or
+    pnpm global add xcstrings-cli
+    ```
+
+2. Initialize xcstrings-cli
+
+    ```bash
+    xcstrings init
+    ```
+
+This will ask you some questions and create a `xcstrings-cli.json` file in the current directory.
+
+## Usage
+
+**Add a string:**
+
+```bash
+xcstrings add \
+    --key greeting \
+    --comment "Hello, World" \
+    --strings << EOF
+{
+    "ja": "こんにちは、世界.",
+    "en": "Hello, World.",
+    "zh-Hans": "你好，世界."
+}
+EOF
+```
+
+**Remove a string:**
+
+```bash
+xcstrings remove --key greeting
+```
+
+List supported languages:**
+
+This command lists all languages by checking xcstrings files and your Xcode project settings (`.pbxproj` specified in the config files as `xcodeprojPaths`).
+
+```bash
+xcstrings languages
+# en ja zh-Hans
+```
+
+You can use `xcstrings --help` or `xcstrings <sub-command> --help` to see the list of commands and options.
+
+## Command options
+
+- `--help, -h`: `boolean` (Optional)
+    - Show help.
+- `--version, -v`: `boolean` (Optional)
+    - Show version.
+- `--config`: `string` (Optional)
+    - 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.
+
+### `add` command options
+
+- `--strings, -s`: `string | string[] | { [key: string]: string }` (Required)
+    - The strings to add/remove.
+    - If only one string is provided, xcstrings-cli will use it as a default string.
+- `--comment, -c`: `string` (Optional)
+    - The comment of the string to add for translators.
+- `--extractionState, -e`: `string` (Optional, default: `manual`)
+    - The extraction state of the string to add. `translated` or `manual`.
+- `--help`: `boolean` (Optional)
+    - Show help.
+
+## Config file
+
+Put a `xcstrings-cli.json5` or `xcstrings-cli.json` file in the project root, then xcstrings-cli will use it as a config file.
+
+```json5
+{
+    "xcstringsPaths": [
+        "Shared/L10n/Localizable.xcstrings",
+        {
+          "alias": "utils",
+          "path": "packages/Utils/Sources/Utils/Resources/Localizable.xcstrings"
+        }
+    ],
+    "xcodeprojPaths": [
+        "path/to/your/Project.xcodeproj"
+    ]
+}
+```
+
+These are the options for the config file:
+
+- xcstringsPaths: `string[] | { alias: string, path: string }[]`
+    - The path to the xcstrings file.
+    - If only one path is provided, xcstrings-cli will use it as a default xcstrings file.
+    - If multiple paths are provided, xcstrings-cli will ask you to select a xcstrings file.
+
+## LICENSE
+
+MIT