Skip to content

Commit 670bd31

Browse files
committed
format
1 parent f987afc commit 670bd31

13 files changed

Lines changed: 95 additions & 69 deletions

File tree

‎CODE_OF_CONDUCT.md‎

Lines changed: 27 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -5,30 +5,30 @@
55
In the interest of fostering an open and welcoming environment, we as
66
contributors and maintainers pledge to making participation in our project and
77
our community a harassment-free experience for everyone, regardless of age, body
8-
size, disability, ethnicity, gender identity and expression, level of experience,
9-
nationality, personal appearance, race, religion, or sexual identity and
10-
orientation.
8+
size, disability, ethnicity, gender identity and expression, level of
9+
experience, nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
1111

1212
## Our Standards
1313

1414
Examples of behavior that contributes to creating a positive environment
1515
include:
1616

17-
* Using welcoming and inclusive language
18-
* Being respectful of differing viewpoints and experiences
19-
* Gracefully accepting constructive criticism
20-
* Focusing on what is best for the community
21-
* Showing empathy towards other community members
17+
- Using welcoming and inclusive language
18+
- Being respectful of differing viewpoints and experiences
19+
- Gracefully accepting constructive criticism
20+
- Focusing on what is best for the community
21+
- Showing empathy towards other community members
2222

2323
Examples of unacceptable behavior by participants include:
2424

25-
* The use of sexualized language or imagery and unwelcome sexual attention or
25+
- The use of sexualized language or imagery and unwelcome sexual attention or
2626
advances
27-
* Trolling, insulting/derogatory comments, and personal or political attacks
28-
* Public or private harassmentthe
29-
* Publishing others' private information, such as a physical or electronic
27+
- Trolling, insulting/derogatory comments, and personal or political attacks
28+
- Public or private harassmentthe
29+
- Publishing others' private information, such as a physical or electronic
3030
address, without explicit permission
31-
* Other conduct which could reasonably be considered inappropriate in a
31+
- Other conduct which could reasonably be considered inappropriate in a
3232
professional setting
3333

3434
## Our Responsibilities
@@ -37,11 +37,11 @@ Project maintainers are responsible for clarifying the standards of acceptable
3737
behavior and are expected to take appropriate and fair corrective action in
3838
response to any instances of unacceptable behavior.
3939

40-
Project maintainers have the right and responsibility to remove, edit, or
41-
reject comments, commits, code, wiki edits, issues, and other contributions
42-
that are not aligned to this Code of Conduct, or to ban temporarily or
43-
permanently any contributor for other behaviors that they deem inappropriate,
44-
threatening, offensive, or harmful.
40+
Project maintainers have the right and responsibility to remove, edit, or reject
41+
comments, commits, code, wiki edits, issues, and other contributions that are
42+
not aligned to this Code of Conduct, or to ban temporarily or permanently any
43+
contributor for other behaviors that they deem inappropriate, threatening,
44+
offensive, or harmful.
4545

4646
## Scope
4747

@@ -55,19 +55,21 @@ further defined and clarified by project maintainers.
5555
## Enforcement
5656

5757
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58-
reported by contacting Mike Grabowski [grabbou@gmail.com](mailto:grabbou@gmail.com). All
59-
complaints will be reviewed and investigated and will result in a response that
60-
is deemed necessary and appropriate to the circumstances. The project team is
61-
obligated to maintain confidentiality with regard to the reporter of an incident.
62-
Further details of specific enforcement policies may be posted separately.
58+
reported by contacting Mike Grabowski
59+
[grabbou@gmail.com](mailto:grabbou@gmail.com). All complaints will be reviewed
60+
and investigated and will result in a response that is deemed necessary and
61+
appropriate to the circumstances. The project team is obligated to maintain
62+
confidentiality with regard to the reporter of an incident. Further details of
63+
specific enforcement policies may be posted separately.
6364

6465
Project maintainers who do not follow or enforce the Code of Conduct in good
6566
faith may face temporary or permanent repercussions as determined by other
6667
members of the project's leadership.
6768

6869
## Attribution
6970

70-
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71-
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct/
71+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
72+
version 1.4, available at
73+
https://www.contributor-covenant.org/version/1/4/code-of-conduct/
7274

7375
[homepage]: https://www.contributor-covenant.org

‎CONTRIBUTING.md‎

Lines changed: 41 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,37 @@
11
# Contributing guide
22

3-
It's great of you to consider contributing to the BuckleScript bindings for React Native. **Every contribution is greatly appreciated!**
4-
There are many ways to contribute. Besides implementing new features and fixing bugs, you can give advice in issues, create and improve documentation, etc.
3+
It's great of you to consider contributing to the BuckleScript bindings for
4+
React Native. **Every contribution is greatly appreciated!** There are many ways
5+
to contribute. Besides implementing new features and fixing bugs, you can give
6+
advice in issues, create and improve documentation, etc.
57

68
## I want to contribute a missing component or API
79

8-
That's awesome!. If you have a specific one in mind go for it, otherwise just pick one of your choice.
9-
If you expect that it would take you a while (which is no problem) you can open a PR with your working progress to let everybody know you are working on it.
10-
To add component (or API) you should do the following steps:
10+
That's awesome!. If you have a specific one in mind go for it, otherwise just
11+
pick one of your choice. If you expect that it would take you a while (which is
12+
no problem) you can open a PR with your working progress to let everybody know
13+
you are working on it. To add component (or API) you should do the following
14+
steps:
1115

1216
- Implement your component in a file `myComponentRe.re`
13-
- Add an interface `myComponentRe.rei` and think about which things should be exposed.
14-
- Add your new component to `reactNative.re` following the existing components / APIs.
17+
- Add an interface `myComponentRe.rei` and think about which things should be
18+
exposed.
19+
- Add your new component to `reactNative.re` following the existing components /
20+
APIs.
1521

1622
Some things to keep in mind:
1723

18-
- We strive for more heavy bindings, i.e. we try to hide things like `Js.t` objects, but sometimes this is not possible.
19-
- String enums, which are an argument to a function, are represented through polymorphic variants.
24+
- We strive for more heavy bindings, i.e. we try to hide things like `Js.t`
25+
objects, but sometimes this is not possible.
26+
- String enums, which are an argument to a function, are represented through
27+
polymorphic variants.
2028
- You should format your code with `refmt`.
2129

2230
## I got stuck
2331

24-
Well, that happens. But don't give up! Just join the [Discord Server](https://discord.gg/reasonml) and ask your questions in #react or #bucklescript. Everybody is really welcoming and helpful!
32+
Well, that happens. But don't give up! Just join the
33+
[Discord Server](https://discord.gg/reasonml) and ask your questions in #react
34+
or #bucklescript. Everybody is really welcoming and helpful!
2535

2636
## Setup Development
2737

@@ -35,7 +45,8 @@ Then build with `yarn start`.
3545

3646
## Running example
3747

38-
Example app is written in Expo. Please check their documentation for any additional details. Before running the app, make sure to build the Reason code.
48+
Example app is written in Expo. Please check their documentation for any
49+
additional details. Before running the app, make sure to build the Reason code.
3950

4051
```sh
4152
cd ./example
@@ -50,16 +61,22 @@ yarn start
5061

5162
## Running docs
5263

53-
Documentation is generated from the Reason interface and comments that are included there.
64+
Documentation is generated from the Reason interface and comments that are
65+
included there.
5466

5567
To start working with documentation:
5668

57-
- Ensure that have [opam](http://opam.ocaml.org/doc/Install.html) & use `opam switch create 4.02.3+buckle-master`.
69+
- Ensure that have [opam](http://opam.ocaml.org/doc/Install.html) & use
70+
`opam switch create 4.02.3+buckle-master`.
5871
- Ensure that have [odoc](https://github.com/ocaml/odoc) installed.
59-
> if you have a problem during installing the odoc with OCaml dependencies, try: `opam pin add odoc.dev git+https://github.com/ocaml/odoc`
60-
- build code with: `yarn build` or if you want to build with watch then use: `yarn start`
61-
- start docs server using: `yarn docs:start`. Script will run the HTTP server and reload after something changes.
62-
- To build documentation from ReasonMl interfaces to HTML file run: `yarn docs:build`
72+
> if you have a problem during installing the odoc with OCaml dependencies,
73+
> try: `opam pin add odoc.dev git+https://github.com/ocaml/odoc`
74+
- build code with: `yarn build` or if you want to build with watch then use:
75+
`yarn start`
76+
- start docs server using: `yarn docs:start`. Script will run the HTTP server
77+
and reload after something changes.
78+
- To build documentation from ReasonMl interfaces to HTML file run:
79+
`yarn docs:build`
6380

6481
### Tips and Tricks
6582

@@ -71,7 +88,10 @@ You can generate an interface file (`.rei`) with
7188
./node_modules/bs-platform/bin/bsc.exe -pp 'refmt --print binary' -i -I lib/bs/src/ -I lib/bs/src/components -I ./node_modules/reason-react/lib/bs/src/ -impl /path/to/your/file.re
7289
```
7390

74-
This generates the OCaml variant of the interface file. To obtain a reason interface you can copy it into [Reason Tools](https://reasonml.github.io/reason-tools/popup.html) or pipe it to `refmt` with
91+
This generates the OCaml variant of the interface file. To obtain a reason
92+
interface you can copy it into
93+
[Reason Tools](https://reasonml.github.io/reason-tools/popup.html) or pipe it to
94+
`refmt` with
7595

7696
```sh
7797
refmt --parse ml --interface true
@@ -81,4 +101,6 @@ refmt --parse ml --interface true
81101

82102
- [Bucklescript Manual](https://bucklescript.github.io/docs/en/installation)
83103
- The [React Native docs](https://facebook.github.io/react-native/)
84-
- The [TypeScript definitions](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/react-native/index.d.ts) are really useful if the docs aren't that clear about the signature of an API.
104+
- The
105+
[TypeScript definitions](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/react-native/index.d.ts)
106+
are really useful if the docs aren't that clear about the signature of an API.

‎CONTRIBUTORS.md‎

Lines changed: 5 additions & 2 deletions
Large diffs are not rendered by default.

‎bs-react-native-next/src/apis/ImageEditor.re‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,4 @@ external cropImage:
3535
unit
3636
) =>
3737
unit =
38-
"cropImage";
38+
"cropImage";

‎bs-react-native-next/src/components/FlatList.re‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -222,4 +222,4 @@ external scrollToOffset: scrollToOffsetParams => unit = "scrollToOffset";
222222

223223
[@bs.send] external recordInteraction: ref => unit = "";
224224

225-
[@bs.send] external flashScrollIndicators: ref => unit = "";
225+
[@bs.send] external flashScrollIndicators: ref => unit = "";

‎bs-react-native-next/src/components/ScrollView.re‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,4 +148,4 @@ external scrollToEndOptions:
148148
external scrollToEndWithOptions: (ref, scrollToEndOptions) => unit =
149149
"scrollToEnd";
150150

151-
[@bs.send] external flashScrollIndicators: ref => unit = "";
151+
[@bs.send] external flashScrollIndicators: ref => unit = "";

‎bs-react-native-next/src/components/Switch.re‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
type trackColor;
2-
[@bs.obj] external trackColor: (
3-
~_true: Style.color=?,
4-
~_false: Style.color=?,
5-
unit
6-
) => trackColor = "";
2+
[@bs.obj]
3+
external trackColor:
4+
(~_true: Style.color=?, ~_false: Style.color=?, unit) => trackColor =
5+
"";
76

87
[@react.component] [@bs.module "react-native"]
98
external make:

‎bs-react-native-next/src/components/TouchableOpacity.re‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,4 +54,4 @@ external make:
5454

5555
[@bs.send]
5656
external setOpacityTo: (ref, ~value: float, ~duration: float) => unit =
57-
"setOpacityTo";
57+
"setOpacityTo";

‎bs-react-native-next/src/components/VirtualizedList.re‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -275,4 +275,4 @@ external scrollToOffset: scrollToOffsetParams => unit = "scrollToOffset";
275275

276276
[@bs.send] external recordInteraction: ref => unit = "";
277277

278-
[@bs.send] external flashScrollIndicators: ref => unit = "";
278+
[@bs.send] external flashScrollIndicators: ref => unit = "";

‎bs-react-native-next/src/components/VirtualizedSectionList.re‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -238,4 +238,4 @@ external scrollToOffset: scrollToOffsetParams => unit = "scrollToOffset";
238238

239239
[@bs.send] external recordInteraction: ref => unit = "";
240240

241-
[@bs.send] external flashScrollIndicators: ref => unit = "";
241+
[@bs.send] external flashScrollIndicators: ref => unit = "";

0 commit comments

Comments
 (0)