Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cca-io/rescript-react-intl-extractor
Extracts messages for localization from ReScript source files.
https://github.com/cca-io/rescript-react-intl-extractor
react-intl rescript
Last synced: about 2 months ago
JSON representation
Extracts messages for localization from ReScript source files.
- Host: GitHub
- URL: https://github.com/cca-io/rescript-react-intl-extractor
- Owner: cca-io
- License: mit
- Created: 2018-05-13T13:17:53.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-02-08T14:30:49.000Z (7 months ago)
- Last Synced: 2024-05-11T23:34:24.828Z (4 months ago)
- Topics: react-intl, rescript
- Language: OCaml
- Homepage:
- Size: 338 KB
- Stars: 33
- Watchers: 4
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - rescript-react-intl-extractor - io | 27 | (Reason)
README
# rescript-react-intl-extractor
Extracts messages for localization from [ReScript] source files.
This assumes that you are using the [rescript-react-intl] bindings for [react-intl].
[](https://nodei.co/npm/rescript-react-intl-extractor-bin/)
## Installation
Binaries for macOS, Linux and Windows can be installed via npm or yarn. For global installation, run
```sh
npm install -g rescript-react-intl-extractor-bin
```
Alternatively, the binaries are also available for download on the [releases page].
## Usage
```sh
rescript-react-intl-extractor [--allow-duplicates] [path...]
```
where `path` is a ReScript (`*.res`) source file or a directory containing such source files. Multiple files/directories may be specified.
The `--allow-duplicates` option allows messages with identical `id` props if the `defaultMessage` props are identical as well.
## Output
The output (a JSON array of all extracted messages sorted by id) is written to stdout. It will look like this:
```json
[
{
"id": "message.hello",
"defaultMessage": "Hello"
},
{
"id": "message.world",
"defaultMessage": "World"
},
{
"id": "some.message.id",
"defaultMessage": "Some message"
}
]
```
## Message Definition (ReScript Syntax)
Formatted messages may be defined in your source files in one of the following ways:
1. inline in `FormattedMessage`:
```rescript
```
or
```rescript
open ReactIntl
...
```
2. within a module with the `[@intl.messages]` attribute:
```rescript
open ReactIntl
module Msg = {
@@intl.messages
let hello = {id: "message.hello", defaultMessage: "Hello"}
let world = {id: "message.world", defaultMessage: "World"}
}
```
You also can pass descriptions to the records with:
```rescript
let foo = @intl.description("Hello description") {id: "message.hello", defaultMessage: "Hello"}
```
## Building and Testing
The ReScript parser is included as a git submodule. Therefore, after checking out the sources, first run
git submodule update --init --recursive
Install OCaml and OPAM, and create an OPAM switch with OCaml version 4.14.1.
Then run
opam pin add rescript-react-intl-extractor.dev . --no-action
opam install . --deps-only --with-doc --with-test
To build the project, run
opam exec -- dune build
To run the tests, do
opam exec -- dune runtest
[rescript]: https://rescript-lang.org/
[rescript-react-intl]: https://github.com/cca-io/rescript-react-intl
[bs-react-intl-ppx]: https://github.com/ahrefs/bs-react-intl-ppx
[react-intl]: https://github.com/yahoo/react-intl
[releases page]: https://github.com/cca-io/rescript-react-intl-extractor/releases
[esy]: https://esy.sh