Skip to content

Remove support for bs-react-intl 1.x style message definition #65

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 9, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 4 additions & 60 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# bs-react-intl-extractor

Extracts messages for localization from [Reason] source files.
This assumes that you are using the [bs-react-intl] bindings for [react-intl].
This assumes that you are using the [bs-react-intl] 2.x bindings for [react-intl].

[![NPM](https://nodei.co/npm/bs-react-intl-extractor-bin.png?compact=true)](https://nodei.co/npm/bs-react-intl-extractor-bin/)
![Build Status](https://github.com/cknitt/bs-react-intl-extractor/workflows/CI/badge.svg)

## Installation

Binaries for macOS and Linux can be installed via npm or yarn. For global installation, run
Binaries for macOS, Linux and Windows can be installed via npm or yarn. For global installation, run

```sh
npm install -g bs-react-intl-extractor-bin
Expand Down Expand Up @@ -47,7 +47,7 @@ The output (a JSON array of all extracted messages sorted by id) is written to s
]
```

## Message Definition (bs-react-intl 2.x)
## Message Definition

Formatted messages may be defined in your source files in one of the following ways:

Expand Down Expand Up @@ -79,65 +79,9 @@ module Msg = {
```

You also can pass descriptions to the records with:
```reason
let foo = [@intl.description "Hello description"] {id: "message.hello", defaultMessage: "Hello"};
```

## Message Definition (bs-react-intl 1.x)

Formatted messages may be defined in your source files in one of the following ways:

1. inline in `FormattedMessage` (see above)

2. using `ReactIntl.defineMessages`:

```reason
let messages =
ReactIntl.defineMessages(. {
"hello": {
"id": "message.hello",
"defaultMessage": "Hello",
},
"world": {
"id": "message.world",
"defaultMessage": "World",
},
});
```

or

```reason
open ReactIntl;
...
let messages =
defineMessages(. {
"hello": {
"id": "message.hello",
"defaultMessage": "Hello",
},
"world": {
"id": "message.world",
"defaultMessage": "World",
},
});
```

3. using the attribute `[@intl.messages]`:

```reason
let messages =
[@intl.messages]
{
"hello": {
"id": "message.hello",
"defaultMessage": "Hello",
},
"world": {
"id": "message.world",
"defaultMessage": "World",
},
};
let foo = [@intl.description "Hello description"] {id: "message.hello", defaultMessage: "Hello"};
```

## Building and Testing
Expand Down
59 changes: 0 additions & 59 deletions lib/ExtractionIterator.re
Original file line number Diff line number Diff line change
Expand Up @@ -38,25 +38,6 @@ let extractMessageFromRecord = (~description=?, callback, fields) => {
Message.fromStringMap(~description?, map) |> Option.iter(callback);
};

let extractMessagesFromRecords = (callback, records) =>
records
|> List.iter(field =>
switch (field) {
| (
{txt: Lident(_)},
{
pexp_desc:
Pexp_extension((
{txt: "bs.obj"},
PStr([{pstr_desc: Pstr_eval({pexp_desc: Pexp_record(fields, _)}, _), pstr_loc: _}]),
)),
},
) =>
extractMessageFromRecord(callback, fields)
| _ => ()
}
);

let hasIntlAttribute = (items: structure) =>
items
|> List.exists(item =>
Expand Down Expand Up @@ -114,13 +95,6 @@ let matchesFormattedMessage = ident =>
| _ => false
};

let matchesDefineMessages = ident =>
switch (ident) {
| Ldot(Lident("ReactIntl"), "defineMessages")
| Lident("defineMessages") => true
| _ => false
};

let getIterator = callback => {
...default_iterator,

Expand All @@ -137,39 +111,6 @@ let getIterator = callback => {
| {pexp_desc: Pexp_apply({pexp_desc: Pexp_ident({txt, _})}, labels)} when matchesFormattedMessage(txt) =>
extractMessageFromLabels(callback, labels)

// Match (ReactIntl.)defineMessages
| {
pexp_desc:
Pexp_apply(
{pexp_desc: Pexp_ident({txt, _})},
[
(
Asttypes.Nolabel,
{
pexp_desc:
Pexp_extension((
{txt: "bs.obj"},
PStr([{pstr_desc: Pstr_eval({pexp_desc: Pexp_record(fields, _)}, _), pstr_loc: _}]),
)),
},
),
],
),
}
when matchesDefineMessages(txt) =>
extractMessagesFromRecords(callback, fields)

// Match [@intl.messages] on objects
| {
pexp_desc:
Pexp_extension((
{txt: "bs.obj"},
PStr([{pstr_desc: Pstr_eval({pexp_desc: Pexp_record(fields, _)}, _), pstr_loc: _}]),
)),
pexp_attributes: [({txt: "intl.messages"}, _)],
} =>
extractMessagesFromRecords(callback, fields)

| _ => ()
};

Expand Down
10 changes: 1 addition & 9 deletions test/__snapshots__/Extract.372ae0d1.0.snapshot
Original file line number Diff line number Diff line change
@@ -1,10 +1,2 @@
Extract › partial
[
{ \"id\": \"test1.msg2.1\", \"defaultMessage\": \"This is message 2.1\" },
{
\"id\": \"test1.msg2.2\",
\"defaultMessage\": \"This is message 2.2\",
\"description\": \"Description for message 2.2\"
},
{ \"id\": \"test2.msg1.1\", \"defaultMessage\": \"This is message 2.1.1\" }
]
[ { \"id\": \"test1.msg3.1\", \"defaultMessage\": \"This is message 3.1\" } ]
15 changes: 1 addition & 14 deletions test/__snapshots__/Extract.a27e9fd5.0.snapshot
Original file line number Diff line number Diff line change
Expand Up @@ -9,24 +9,11 @@ Extract › full
},
{ \"id\": \"test1.msg1.4\", \"defaultMessage\": \"This is message 1.4\" },
{ \"id\": \"test1.msg1.5\", \"defaultMessage\": \"This is message 1.5\" },
{ \"id\": \"test1.msg1.6\", \"defaultMessage\": \"This is message 1.6\" },
{
\"id\": \"test1.msg1.7\",
\"defaultMessage\": \"This is message 1.7\",
\"description\": \"Description for message 1.7\"
},
{ \"id\": \"test1.msg1.8\", \"defaultMessage\": \"This is message 1.8\" },
{
\"id\": \"test1.msg1.9\",
\"defaultMessage\": \"This is message 1.9\",
\"description\": \"Description for message 1.9\"
},
{ \"id\": \"test1.msg2.1\", \"defaultMessage\": \"This is message 2.1\" },
{
\"id\": \"test1.msg2.2\",
\"defaultMessage\": \"This is message 2.2\",
\"description\": \"Description for message 2.2\"
},
{ \"id\": \"test1.msg3.1\", \"defaultMessage\": \"This is message 3.1\" },
{ \"id\": \"test2.msg1.1\", \"defaultMessage\": \"This is message 2.1.1\" }
{ \"id\": \"test1.msg3.1\", \"defaultMessage\": \"This is message 3.1\" }
]
12 changes: 0 additions & 12 deletions test/__snapshots__/ReScript.18d405ea.0.snapshot
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,11 @@ ReScript › full
},
{ \"id\": \"test4.msg1.4\", \"defaultMessage\": \"This is message 1.4\" },
{ \"id\": \"test4.msg1.5\", \"defaultMessage\": \"This is message 1.5\" },
{ \"id\": \"test4.msg1.6\", \"defaultMessage\": \"This is message 1.6\" },
{
\"id\": \"test4.msg1.7\",
\"defaultMessage\": \"This is message 1.7\",
\"description\": \"Description for message 1.7\"
},
{ \"id\": \"test4.msg1.8\", \"defaultMessage\": \"This is message 1.8\" },
{
\"id\": \"test4.msg1.9\",
\"defaultMessage\": \"This is message 1.9\",
\"description\": \"Description for message 1.9\"
},
{ \"id\": \"test4.msg2.1\", \"defaultMessage\": \"This is message 2.1\" },
{
\"id\": \"test4.msg2.2\",
\"defaultMessage\": \"This is message 2.2\",
\"description\": \"Description for message 2.2\"
},
{ \"id\": \"test4.msg3.1\", \"defaultMessage\": \"This is message 3.1\" }
]
4 changes: 2 additions & 2 deletions test/lib/Tests.re
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ let extractAndGetJson = (~duplicatesAllowed=?, paths) => {

describe("Extract", ({test}) => {
test("full", ({expect}) => {
let json = extractAndGetJson(["testData/test1", "testData/test2"]);
let json = extractAndGetJson(["testData/test1"]);
expect.string(json).toMatchSnapshot();
});

test("partial", ({expect}) => {
let json = extractAndGetJson(["testData/test1/subdir/Test_1_2.re", "testData/test2"]);
let json = extractAndGetJson(["testData/test1/subdir/Test_1_3.re"]);
expect.string(json).toMatchSnapshot();
});
});
Expand Down
21 changes: 0 additions & 21 deletions testData/test1/Test_1_1.re
Original file line number Diff line number Diff line change
Expand Up @@ -22,27 +22,6 @@ let theseShouldBeIgnored = () =>
<FormattedMessage id="ignored1.2" description="This is a description" />
</div>;

let _ =
ReactIntl.defineMessages({
"test1.msg1.6": {
"id": "test1.msg1.6",
"defaultMessage": "This is message 1.6",
},
"ignored1.3": {
"idd": "test1.msg1.8", /* This will not be extracted. */
"defaultMessage": "This is message 1.8",
},
});

let _ =
defineMessages({
"test1.msg1.7": {
"id": "test1.msg1.7",
"defaultMessage": "This is message 1.7",
"description": "Description for message 1.7",
},
});

module Msg = {
open ReactIntl;

Expand Down
30 changes: 0 additions & 30 deletions testData/test1/subdir/Test_1_2.re

This file was deleted.

File renamed without changes.
6 changes: 0 additions & 6 deletions testData/test2/Test_2_1.re

This file was deleted.

19 changes: 0 additions & 19 deletions testData/test4/Test_4_1.res
Original file line number Diff line number Diff line change
Expand Up @@ -23,25 +23,6 @@ let theseShouldBeIgnored = () =>
<FormattedMessage id="ignored1.2" description="This is a description" />
</div>

let _ = ReactIntl.defineMessages({
"test4.msg1.6": {
"id": "test4.msg1.6",
"defaultMessage": "This is message 1.6",
},
"ignored1.3": {
"idd": "test4.msg1.8" /* This will not be extracted. */,
"defaultMessage": "This is message 1.8",
},
})

let _ = defineMessages({
"test4.msg1.7": {
"id": "test4.msg1.7",
"defaultMessage": "This is message 1.7",
"description": "Description for message 1.7",
},
})

module Msg = {
open ReactIntl

Expand Down
30 changes: 0 additions & 30 deletions testData/test4/subdir/Test_4_2.res

This file was deleted.

File renamed without changes.