https://github.com/fedesky25/json-translation-tool
Client-side editor to translate JSON files with texts in other languages
https://github.com/fedesky25/json-translation-tool
json translation
Last synced: 3 months ago
JSON representation
Client-side editor to translate JSON files with texts in other languages
- Host: GitHub
- URL: https://github.com/fedesky25/json-translation-tool
- Owner: Fedesky25
- Created: 2022-08-08T12:58:03.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-09-18T21:20:37.000Z (almost 4 years ago)
- Last Synced: 2025-02-16T18:44:00.268Z (over 1 year ago)
- Topics: json, translation
- Language: JavaScript
- Homepage: https://federicoguglielmi.it/tools/json-translation
- Size: 19.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# JSON translation tool
Client-side static page that acts as a tool to translate JSON files with texts in other languages through a simple editor. There are two version: the recommended one uses the new experimental File System Access API ([caniuse](https://caniuse.com/native-filesystem-api)) while the second simply uses an input file (with webkitfolder).
## Expected file structure
The tool opens a folder project that contains:
- a `manifest.json` file which specifies the languages of the projects
- any number of subfolders containing `.json` files
## Project manifest
The manifest inside a folder project specifies the language of reference and all the "foreign" ones. For each of them, the locale code and name must be provided. The `.//.json` file is taken as reference texts (and won't be changed in the file system access version).
Typescript type definition:
```ts
interface LanguageLocale {
code: string;
name: string;
}
interface Manifest {
reference: LanguageLocale;
foreign: LanguageLocale[];
}
```
Example:
```json
{
"reference": {
"code": "en",
"name": "English"
},
"foreign": [
{
"code": "it",
"name": "Italiano"
},
{
"code": "fr",
"name": "Français"
}
]
}
```
## Texts JSON files
They are the `.json` files inside the subfolders of the project folder, and their typescript interface description would be the following one.
```ts
type Texts = string | Texts[] | Record;
```
Example:
```json
{
"title": "Welcome back!",
"profile": {
"see": "See your profile",
"edit": "Edit your profile",
"posts": "Your posts"
},
"aboutus": {
"title": "About us",
"description": "lorem ipsum ...",
"geo": {
"nation": "United Kingdom",
"city": "London"
}
}
}
```
The only mandatory file inside each subfolder is the one related to the reference language (`.json`).
Please note that arrays are currently supported only in the File System Access API version.