@lingui/format-json

@lingui/format-json

Read and write message catalogs in JSON

@lingui/format-json is part of LinguiJS. See the documentation for all information, tutorials and examples.

Installation

npm install --save-dev @lingui/format-json
# yarn add --dev @lingui/format-json

Usage

// lingui.config.{js,ts}
import {formatter} from "@lingui/format-json"

export default {
  [...]
  format: formatter({style: "lingui"}),
}

Possible options:

export type JsonFormatterOptions = {
  /**
   * Print places where message is used
   *
   * @default true
   */
  origins?: boolean

  /**
   * Print line numbers in origins
   *
   * @default true
   */
  lineNumbers?: boolean

  /**
   * Different styles of how information could be printed
   *
   * @default "lingui"
   */
  style?: "lingui" | "minimal"

  /**
  * Indentation of output JSON
  *
  * @default 2
  */
  indentation?: number
}

Style: minimal

Simple JSON with message ID -> translation mapping. All metadata (default message, comments for translators, message origin, etc) are stripped:

{
"MessageID": "Translated Message"
}

Style: lingui

Raw catalog data serialized to JSON:

{
"MessageID": {
  "translation": "Translated Message",
  "message": "Default string (from source code)",
  "origin": [
    ["path/to/src.js", 42]
  ]
}
}

License

This package is licensed under MIT license.