feat: add export formats Apple SDK and Android SDK

[Anty0]

Requires tolgee/tolgee-platform#3186

Summary by CodeRabbit

• New Features

  • Added support for "APPLE_SDK" and "ANDROID_SDK" localization file formats for export operations.
  • These new formats are now available as options in the command-line interface.

• Bug Fixes

  • Improved error handling by providing clear messages when attempting to import unsupported "APPLE_SDK" or "ANDROID_SDK" formats.

• Documentation

  • Clarified the behavior of options related to removing unused or other keys within specified namespaces.

[coderabbitai]

Important

Review skipped

Review was skipped as selected files did not have any reviewable changes.

💤 Files selected but had no reviewable changes (1)

• src/client/internal/schema.generated.ts

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

Two new localization file formats, "APPLE_SDK" and "ANDROID_SDK", were added to the supported formats across the schema, type definitions, and command-line options. The mapping utilities were updated: export mapping now supports these formats, while import mapping explicitly rejects them with clear errors. Documentation comments were clarified regarding namespace scope for certain options.

Changes

Cohort / File(s)	Change Summary
Schema Format Additions schema.json	Added "APPLE_SDK" and "ANDROID_SDK" to the supported format enum in the schema definition.
Command-Line Option Updates src/options.ts	Extended the --format CLI option choices to include "APPLE_SDK" and "ANDROID_SDK".
Type and Documentation Updates src/schema.d.ts	Added "APPLE_SDK" and "ANDROID_SDK" to the Format type union; clarified documentation for push.removeOtherKeys and sync.removeUnused regarding their namespace-limited scope.
Export Format Mapping Logic src/utils/mapExportFormat.ts	Added handling for "APPLE_SDK" and "ANDROID_SDK" in the export format mapping, associating them with their respective message formats.
Import Format Mapping and Error Handling src/utils/mapImportFormat.ts	Added explicit error handling for "APPLE_SDK" and "ANDROID_SDK" formats in import mapping, throwing an error when these are used for import, as importing is not supported for these formats.

Sequence Diagram(s)

sequenceDiagram
    participant CLI
    participant mapImportFormat
    participant Error

    CLI->>mapImportFormat: import(format)
    alt format is "APPLE_SDK" or "ANDROID_SDK"
        mapImportFormat->>Error: throw InvalidArgumentError("Import not supported")
    else other formats
        mapImportFormat-->>CLI: return mapped format
    end

Loading

sequenceDiagram
    participant CLI
    participant mapExportFormat

    CLI->>mapExportFormat: export(format)
    alt format is "APPLE_SDK"
        mapExportFormat-->>CLI: { format: "APPLE_SDK", messageFormat: "APPLE_SPRINTF" }
    else format is "ANDROID_SDK"
        mapExportFormat-->>CLI: { format: "ANDROID_SDK", messageFormat: "JAVA_STRING_FORMAT" }
    else other formats
        mapExportFormat-->>CLI: mapped format object
    end

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

Two new formats hop into the scene,
Apple and Android, shiny and clean.
Export with style, but import? Not quite—
A bunny throws errors to keep things right!
With docs now clearer, and mappings in tune,
This patch is a carrot—review it soon! 🥕

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch jirikuchynka/export-format-android-apple-sdk

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.