Merge pull request #20 from TheSpyder/records-as-objects

Use ReScript 10 record types in most places

Author: TheSpyder

.changes/header.tpl.md

@@ -0,0 +1,6 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html),
+and is generated by [Changie](https://github.com/miniscruff/changie).

.changes/unreleased/.gitkeep

@@ -0,0 +1,5 @@
+kind: Changed
+body: 'BREAKING: Record types are now used where possible. Requires ReScript 10.'
+time: 2023-12-10T06:31:31.479826+11:00
+custom:
+  Github Issue: "12"

.changes/unreleased/Changed-20231210-063131.yaml

@@ -0,0 +1,32 @@
+changesDir: .changes
+unreleasedDir: unreleased
+headerPath: header.tpl.md
+changelogPath: CHANGELOG.md
+versionExt: md
+versionFormat: '## {{.Version}} - {{.Time.Format "2006-01-02"}}'
+kindFormat: "### {{.Kind}}"
+changeFormat: "* [#{{.Custom.Issue}}](https://github.com/miniscruff/changie/issues/{{.Custom.Issue}}) {{.Body}}"
+kinds:
+  - label: Added
+    auto: minor
+  - label: Changed
+    auto: major
+  - label: Deprecated
+    auto: minor
+  - label: Removed
+    auto: major
+  - label: Fixed
+    auto: patch
+newlines:
+  afterChangelogHeader: 1
+  beforeChangelogVersion: 1
+  endOfVersion: 1
+envPrefix: CHANGIE_
+custom:
+  - key: Github Issue
+    type: int
+    minInt: 1
+replacements:
+  - path: package.json
+    find: '  "version": ".*",'
+    replace: '  "version": "{{.VersionNoPrefix}}",'

.changie.yaml

@@ -16,7 +16,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 20
           cache: yarn
       - run: yarn install
       - run: yarn test

.github/workflows/ci.yml

@@ -0,0 +1,9 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html),
+and is generated by [Changie](https://github.com/miniscruff/changie).
+
+
+No releases yet, this file will be updated when generating your first release.

CHANGELOG.md

@@ -9,11 +9,15 @@ Node.js bindings for ReScript
 ```shell
 npm install rescript-nodejs
 ```
+
 or
+
 ```shell
 yarn add rescript-nodejs
 ```
+
 Then add rescript-nodejs to `bsconfig.json`:
+
 ```
   "bs-dependencies": [
     "rescript-nodejs"
@@ -59,6 +63,7 @@ We welcome and encourage anyone to contribute! In order to minimize confusion an
 - If you want to request a feature/improvement, it's best to create an issue first and start a discussion. Don't spend a lot of valuable time and energy creating a pull request when it might not fit in with the project goals. Your PR may still be merged if it isn't based on an issue but expect to have a discussion first.
 - If you notice gaps in the documentation and want to help fill them in, feel free to go straight to PR. Or create an issue and provide a draft of the docs you want to add.
 - If you have concerns about implementation style or design decisions (e.g. type soundness, complexity, ergonomics, edge cases, etc.), please submit an issue voicing your concerns. Critique from the community is welcome. This library is only useful so long as it works for everyone!
+- A changelog has finally been added, managed by [changie](https://changie.dev). Please use this tool (available via `yarn changie new`) to add changelog entries.
 
 ## License and Credits
 

README.md

@@ -1,9 +1,7 @@
 open NodeJs
 
 // example from the NodeJS docs
-let rl = Readline.make(
-  Readline.interfaceOptions(~input=Fs.createReadStream("sample.txt"), ~crlfDelay=infinity, ()),
-)
+let rl = Readline.make({input: Fs.createReadStream("sample.txt"), crlfDelay: infinity})
 
 rl
 ->Readline.Interface.on(Event.fromString("line"), line => {