Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/quipper/i18n-dts

A d.ts file generator for i18n-js.
https://github.com/quipper/i18n-dts

i18n-js react-native typescript

Last synced: 4 days ago
JSON representation

A d.ts file generator for i18n-js.

Host: GitHub
URL: https://github.com/quipper/i18n-dts
Owner: quipper
License: apache-2.0
Created: 2018-05-03T12:02:58.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2022-10-11T01:49:53.000Z (about 2 years ago)
Last Synced: 2024-10-20T05:48:19.741Z (27 days ago)
Topics: i18n-js, react-native, typescript
Language: TypeScript
Homepage:
Size: 1.08 MB
Stars: 48
Watchers: 161
Forks: 6
Open Issues: 2
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

# i18n-dts [![CircleCI](https://circleci.com/gh/quipper/i18n-dts.svg?style=svg)](https://circleci.com/gh/quipper/i18n-dts) [![npm version](https://badge.fury.io/js/i18n-dts.svg)](https://badge.fury.io/js/i18n-dts)

`i18n-dts` is a `d.ts` file generator for [i18n-js](https://github.com/fnando/i18n-js).

With generated `d.ts` file you can treat `I18n` object type-safely!

![demo](https://raw.githubusercontent.com/quipper/i18n-dts/master/doc/demo.gif)

## Installation

#### NPM

```sh
npm install -D i18n-dts
```

#### Yarn

```sh
yarn add -D i18n-dts
```

## Configuration

First of all specify the following settings in root `package.json`.

- `model`: file extension type can be either `.json`, `.ts` or `.js`
- `outputDir`: `d.ts` file will be emitted in specified directory

```json
"i18n-dts": {
"model": "./src/locale/languages/en.json",
"outputDir": "./typings"
}
```

Note that when you specify `.ts` or `.js` file type as a model, use `module.exports` to export an object.

```ts
module.exports = {
platform: {
ios: 'Press Cmd+R to reload,\nCmd+D or shake for dev menu',
},
};
```

And add `outputDir` dir into `filesGlob` option in `tsconfig.json`.

```json
"filesGlob": [
"typings/*.d.ts",
],
```

That's it! Now you can use `i18n-dts` command which generates corresponding `d.ts` file.

We recommend to add scripts below into `package.json`.

```json
"scripts": {
"i18n-dts": "i18n-dts",
"i18n-dts:watch": "i18n-dts -w"
},
```

## Options

### Watch mode

You can enable watch mode by adding `--watch` (shorthand `-w`) flag.

In the watch mode, i18n-dts watches update of model file and generates d.ts file when the model is updated.

```sh
i18n-dts --watch
```

### Custom pluralization keys

The [i18n-js](https://github.com/fnando/i18n-js) library supports defining your own pluralization rules. If you've added or changed the rules, you might need to override the default keys (zero, one, other) that i18n-dts looks for to determine if a string should be treated as a pluralized definition. To do this, use the `--pluralization-keys ` (shorthand `-k`) flag with a list of comma-separated keys.

```sh
i18n-dts --pluralization-keys zero,one,other,many
```

## Licence

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```