# etty-mockup

> Mocking JSON translations with template for Etty

Latest version **0.2.0** (published 2019-11-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install etty-mockup
pnpm add etty-mockup
yarn add etty-mockup
bun add etty-mockup
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2019-11-22 |
| First published | 2019-02-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 14.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Limbo |
| Maintainers | firelivecompany |
| Keywords | i18n, translation, json |

## Links

- npm: https://www.npmjs.com/package/etty-mockup
- Repository: https://github.com/firelivecompany/etty-mockup
- Homepage: https://github.com/firelivecompany/etty-mockup#readme
- Issues: https://github.com/firelivecompany/etty-mockup/issues
- npm.io page: https://npm.io/package/etty-mockup

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 0.2.0 (latest) — 2019-11-22
- 0.1.1 — 2019-02-13
- 0.1.0 — 2019-02-11

## README

# Mockup your `etty` translation templates easily :)

Basically, the [etty](https://github.com/firelivecompany/etty) is targeted to separate static translations from the client bundle. Strict typing will grant you a comfortable coding, but if you have an empty translation file delivered, it will cause errors like `Cannot read property X of undefined` in your application during render.

That is not a big problem! Here is `etty-mockup`!

## Usage
1. Install it
```
npm install etty-mockup
```

2. Use it  

- `template.json`:
```json
{
    "field_1": "",
    "field_2": {
        "sub_1": "",
        "sub_2": ["", ""]
    }
}
```

- Usage
```typescript
import mockup from "etty-mockup"
import * as template from "src/config/template.json"

["en", "de", "ru"].forEach(locale => {
    console.log(mockup(template, locale))
})
```

- The result (console output)
```
{
    field_1: "en:field_1",
    field_2: {
        sub_1: "en:field_2.sub_1",
        sub_2: ["en:field_2.sub_2_0", "en:field_2.sub_2_1"]
    }
}

{
    field_1: "de:field_1",
    field_2: {
        sub_1: "de:field_2.sub_1",
        sub_2: ["de:field_2.sub_2_0", "de:field_2.sub_2_1"]
    }
}

{
    field_1: "ru:field_1",
    field_2: {
        sub_1: "ru:field_2.sub_1",
        sub_2: ["ru:field_2.sub_2_0", "ru:field_2.sub_2_1"]
    }
}
```

## API
```typescript
import mockup from "etty-mockup"
```
`mockup<T>(template: T, locale: string, prefill?: any) => T`  
### `@params`
Name | Type | Required | Description
---- | ---- | -------- | -----------
`template` | `T` (defined by user) | yes | A template from which to create a translation JSON
`locale` | `string` | yes | A locale for which the translation JSON will be created.
`prefill` | `any` (but preferrable `T` to avoid losing data) | no | If you already filled your translation JSON with some real data, just pass it as the third parameter. `etty-mockup` will save filled translation JSON fields if it possible (if the scheme of JSON is pretty the same as in `template`). 

### `@returns`
A filled template with mockup data in format 
```
{locale}:{field path}_{index, if field is an array}
```

## Notes
For TypeScript users it is possible to make *typed call* of the function:
```typescript
import * as template from "src/config/template.json"
import mockup from "etty-mockup"

mockup<typeof template>(template, "en")
```

It is not necessary, because TypeScript will catch the type of `template` in first parameter, and you will see, that `mockup` will return the `typeof template` event without *typed call*:

```typescript
import * as template from "src/config/template.json"
import mockup from "etty-mockup"

mockup(template, "en") // mockup is anyway of type `typeof template` here
```

## Simple real life example
`etty-mockup` helps you with generating translation JSON files. Once you have a list of locales and the translation template JSON, you can easily create a translation file for each of it.

For example, you have a template stored in `src/config/template.json`
```json
{
    "Homepage": {
        "title": "",
        "description": ""
    }
}
```

and you have a list of locales in `src/config/locales.json`
```json
["en-US", "en-GB", "de", "ru"]
```

So, you want to create a translation JSON for each locale and place this files to `src/translations` folder.
Creating some `src/makeTranslations.js`
```javascript
var fs = require("fs")
var template = require("./config/template.json")
var locales = require("./config/locales.json")
var mockup = require("etty-mockup").default

locales.forEach(locale => {
    var path = `./translations/${locale}.json`
    var prefill = {}
    try {
        prefill = require(path)
    } catch (e) {}
    var translate = mockup(template, locale, prefill)
    fs.writeFile(path, JSON.stringify(translate, null, 2), (err, data) => {
        if (err)
            console.log(`Failed to write ${locale}.json`, err)
        else
            console.log(`Successfully created ${locale}.json`)
    })
})
```

Thats it! Now just run 
```
node makeTranslations
``` 
and voila! Mocked files are being appeared in your `src/translations` folder. Now you can place some real data to your generated JSON files - this data won't be lost after further generations **(if you will not change your exist template scheme)**. The only thing you have to do by yourself is to serve this files with some API to make XHR requests :)

Working example provided in the `example` folder of this repo. Feel free to make suggestions on how to improve it :)

## Contributing
Feel free to submit issues, feature and pull requests. Any improvement is highly appreciated!

---
_Source: https://npm.io/package/etty-mockup · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._