resjson

Resjson is a JSON-based resource description format designed to describe software resources such as localized strings, images, and configuration values in a single, machine-readable file. It aims to improve portability and automation in resource pipelines by providing a uniform structure that can be consumed by build systems, localization workflows, and runtime loaders.

Syntax and structure: A resjson document is a JSON object typically containing a top-level resources mapping. Each key identifies a resource; the value is an object with fields such as value (the actual string or data), type, comments or notes, tags, and metadata. For pluralized strings, a plural object may map plural forms like one and other to strings. References to other resources can be expressed with a $ref field to enable reuse and composition.

Example:

{

"resources": {

"greeting": {

"value": "Hello",

"comment": "Common greeting",

"type": "string"

},

"farewell": {

"value": "Goodbye",

"type": "string"

},

"items_count": {

"plural": {

"one": "You have one item",

"other": "You have {count} items"

}

}

}

}

Usage and tooling: Resjson files are intended for use in localization pipelines and to drive resource lookups at runtime or during build. Tools commonly provide validation, merging, and conversion to and from other formats such as platform-specific resource files or conventional localization formats. The format supports metadata and simple inter-resource references to facilitate reuse and consistency across locales.

Limitations: JSON’s lack of native comments means comments are represented as explicit fields, which can be verbose. Some localization features (contexts, inline formatting, or complex plural rules) may require conventions beyond the core specification. See also related resource formats and localization workflows.