[DIT-11970] iOS Strings Format Support

[bparrish17]

Overview

• Adds IOSStringsFormatter to handle outputs where format: ios-strings
  • Unit tested as well
• Updates BaseFormatter class with shared format functionality
  • Also adds additional unit tests for BaseFormatter class
• Adds GET /v2/textItems/export and GET /v2/components/export endpoint support
• Adds GET /v2/variants http
• Adds GET /v2/projects http
• Adds additional E2E pull command tests for ios-strings format config

Context

DIT-11970: [CLI] IOS Strings Format

Test Plan

Setup

• Make sure your local .env looks like the following

DEBUG=true
DITTO_API_HOST=http://localhost:3001

• Make sure your local Ditto has a couple good test projects you can work off of. You should have some variables, variants with related text, and some components with attached text items
• For organizational sake, I recommend setting up your config.yml in the ./cli repository to organize formats into outDirs. This is what mine looks like

projects: []
variants:
  - id: base
  - id: spanish
components:
  folders:
    - id: root
outputs:
  - format: json
    outDir: "./ditto/json"
    projects:
      - id: cli-testing-project

  - format: json
    outDir: "./ditto/json-i18next"
    framework: i18next
    projects:
      - id: cli-testing-project

  - format: ios-strings
    outDir: "./ditto/dittopay-es"
    projects:
      - id: dittopay-v2-qa-file-bp-copy

  - format: ios-strings
    outDir: "./ditto/dittopay-en"
    projects:
      - id: dittopay-v2-qa-file-bp-copy

Assertions

• Default JSON Format Works as Expected (with I18N Frameworks)
  • Have an output configured to format: json with no framework
    • Should have a variables.json file at the root of the configured outDir with your WS's variables
  • Have an output configured to format: json with framework i18next
    • Should have an index.js file at the root of the configured outDir with files exported as expected
  • Written files should match as described in the CLI Documentation
• ios-strings Format works as expected
  • Have an output configured to format: ios-strings
  • Files should be outputted in the configured outDir (either at the project root config or in the output config)
  • There should be a components___{variant}.strings file for each configured variant
  • There should be a {project}___{variant}.strings file for each configured project/variant, e.g.

    - format: ios-strings
       outDir: "./ditto/dittopay-es"
       variants:
          - id: base
          - id: japanese
       projects:
          - id: my-project-a
          - id: my-project-b
  

  my-project-a___base.strings
  my-project-a___japanese.strings
  my-project-b___base.strings
  my-project-b___japanese.strings
  
  

  • There should NOT be an outputted variables.json file. This is for typescript typing and not iOS stuff*
    *im like 95% sure on this

[joustrich]

Do we use this anywhere? I see we have a variable output file but am not seeing how that gets populated. In the base class maybe?

[bparrish17]

Yeah good question, the variables are a big ? for me too. Gonna dig into those now and will report back

[joustrich]

A little weird to call these "formatters" now that the export endpoint will do all of the formatting and all this is doing is saving to a file. Maybe worth renaming when you do the refactor work later.

[joustrich]

What was the purpose of the wrapper function here instead of just putting the switch statement directly in the try block here?

[joustrich]

Couple minor comments, but otherwise looks good!