@greenlabs/ppx-spice 0.1.8 → 0.1.9-rc1

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+# 0.1.9-rc1
+
+- Clean up npm publish files
+
 # 0.1.8
 
 - Fix type error where using tuple constructor type, such as `array<int>` for optional field in the record. https://github.com/green-labs/ppx_spice/pull/32

package/README.md

@@ -118,6 +118,10 @@ let encoded = sampleRecord->Records.t_encode // sampleJson
 let decoded = sampleJson->Records.t_decode // Belt.Result.Ok(sampleRecord)
 ```
 
+## Getting Started
+
+Read our [Guide with examples](docs/GUIDE.md)
+
 ## Install
 
 ```sh

package/docs/GUIDE.md

@@ -0,0 +1,139 @@
+# Ppx_spice Guide
+
+This document walks you through the basics of using ppx_spice. You can try with examples in the [`/examples` directory](../examples).
+
+## Guide Index
+
+- [Basic Usage](#basic-usage)
+- [Variants](#variants)
+- [Advanced Usage](#advanced-usage)
+
+### Basic Usage
+
+The following example shows how to use ppx_spice to encode and decode a JSON value.
+
+```rescript
+let data = %raw(`
+  {
+    "id": 1,
+    "nickname": "bob"
+  }
+`)
+
+@spice
+type user = {
+  id: int,
+  nickname?: string,
+}
+
+let user: Belt.Result.t<user, Spice.decodeError> = data->user_decode // user_decode is generated by ppx_spice
+
+let json: Js.Json.t = user->Belt.Result.getExn->user_encode // user_encode is generated by ppx_spice
+```
+
+### Variants
+
+The following example shows how to use ppx_spice to encode and decode a variant.
+
+```rescript
+let data = %raw(`
+  {
+    "id": 1,
+    "nickname": "bob",
+    "language": "ReScript"
+  }
+`)
+
+@spice
+type language =
+  | @spice.as("ReScript") ReScript
+  | @spice.as("OCaml") OCaml
+  | @spice.as("TypeScript") TypeScript
+  | @spice.as("JavaScript") JavaScript
+
+@spice
+type user = {
+  id: int,
+  nickname?: string,
+  language: language,
+}
+
+let user: Belt.Result.t<user, Spice.decodeError> = json->user_decode
+
+let json: Js.Json.t = user->Result.getExn->user_encode
+```
+
+`@spice.as("...")` is used to specify the JSON value of the variant. Without it, the variant name is also used as the JSON value, but the JSON value should be formed as an array to be parsed as a variant. The second example shows how to use it for the case of variant with argument.
+
+```rescript
+@spice
+type language =
+  | ReScript(string) // <- with the argument
+  | OCaml
+  | TypeScript
+  | JavaScript
+
+@spice
+type user = {
+  id: int,
+  nickname?: string,
+  language: language,
+}
+
+let data = %raw(`
+  {
+    "id": 1,
+    "nickname": "bob",
+    "language": ["ReScript", "awesome"] // <- This is the array
+  }
+`)
+```
+
+### Advanced Usage
+
+The following example shows how to use ppx_spice to encode and decode a JSON value with a custom codec.
+
+```rescript
+@spice
+type status = WAITING | PROCESSING | SUCCESS | FAIL
+
+let encoderStatus = v =>
+  switch v {
+  | WAITING => "waiting"
+  | PROCESSING => "processing"
+  | SUCCESS => "success"
+  | FAIL => "fail"
+  }->Js.Json.string
+
+let decoderStatus = json => {
+  switch json |> Js.Json.classify {
+  | Js.Json.JSONString(str) =>
+    switch str {
+    | "waiting" => WAITING->Ok
+    | "processing" => PROCESSING->Ok
+    | "success" => SUCCESS->Ok
+    | "fail" => FAIL->Ok
+    | _ => Error({Spice.path: "", message: "Expected JSONString", value: json})
+    }
+  | _ => Error({Spice.path: "", message: "Expected JSONString", value: json})
+  }
+}
+
+let codecStatus: Spice.codec<status> = (encoderStatus, decoderStatus)
+
+
+@spice
+type data = {
+  status: @spice.codec(codecStatus) status,
+}
+
+let data = %raw(`
+  {
+    "status": "success"
+  }
+`)
+
+let data = data->data_decode
+
+let json = data->Result.getExn->data_encode
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@greenlabs/ppx-spice",
-  "version": "0.1.8",
+  "version": "0.1.9-rc1",
   "description": "ReScript PPX which generate JSON (de)serializer",
   "license": "MIT",
   "author": "Greenlabs Dev <developer@greenlabs.co.kr>",

package/.github/workflows/build_linux.yml

@@ -1,41 +0,0 @@
-name: ppx_spice build linux
-
-on: [workflow_dispatch]
-
-jobs:
-  build_linux:
-    name: ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
-    defaults:
-      run:
-        working-directory: src
-    strategy:
-      matrix:
-        os: [ubuntu-latest]
-        ocaml-compiler:
-          - 4.12.1
-
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Use OCaml ${{ matrix.ocaml-compiler}}
-        uses: ocaml/setup-ocaml@v2
-        with:
-          ocaml-compiler: ${{ matrix.ocaml-compiler }}
-
-      - name: Install deps
-        run: opam install . --deps-only --with-test
-
-      - name: Build
-        run: opam exec -- dune build
-
-      - name: Copy built PPX file
-        run: |
-          mv ./_build/default/bin/bin.exe ppx.exe
-
-      - name: (only on release) Upload artifacts ${{ matrix.os }}
-        uses: actions/upload-artifact@master
-        with:
-          name: ${{ matrix.os }}
-          path: src/ppx.exe
-          if-no-files-found: error

package/.github/workflows/build_macos.yml

@@ -1,41 +0,0 @@
-name: ppx_spice build macOS
-
-on: [workflow_dispatch]
-
-jobs:
-  build_macos:
-    name: ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
-    defaults:
-      run:
-        working-directory: src
-    strategy:
-      matrix:
-        os: [macOS-latest]
-        ocaml-compiler:
-          - 4.12.1
-
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Use OCaml ${{ matrix.ocaml-compiler}}
-        uses: ocaml/setup-ocaml@v2
-        with:
-          ocaml-compiler: ${{ matrix.ocaml-compiler }}
-
-      - name: Install deps
-        run: opam install . --deps-only --with-test
-
-      - name: Build
-        run: opam exec -- dune build
-
-      - name: Copy built PPX file
-        run: |
-          mv ./_build/default/bin/bin.exe ppx.exe
-
-      - name: (only on release) Upload artifacts ${{ matrix.os }}
-        uses: actions/upload-artifact@master
-        with:
-          name: ${{ matrix.os }}
-          path: src/ppx.exe
-          if-no-files-found: error

package/.github/workflows/build_windows.yml

@@ -1,41 +0,0 @@
-name: ppx_spice build windows
-
-on: [workflow_dispatch]
-
-jobs:
-  build_windows:
-    name: ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
-    defaults:
-      run:
-        working-directory: src
-    strategy:
-      matrix:
-        os: [windows-latest]
-        ocaml-compiler:
-          - 4.12.1
-
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Use OCaml ${{ matrix.ocaml-compiler}}
-        uses: ocaml/setup-ocaml@v2
-        with:
-          ocaml-compiler: ${{ matrix.ocaml-compiler }}
-
-      - name: Install deps
-        run: opam install . --deps-only --with-test
-
-      - name: Build
-        run: opam exec -- dune build
-
-      - name: Copy built PPX file
-        run: |
-          mv ./_build/default/bin/bin.exe ppx.exe
-
-      - name: (only on release) Upload artifacts ${{ matrix.os }}
-        uses: actions/upload-artifact@master
-        with:
-          name: ${{ matrix.os }}
-          path: src/ppx.exe
-          if-no-files-found: error

package/.github/workflows/print_esy_cache.js

@@ -1,13 +0,0 @@
-const fs = require("fs");
-const os = require("os");
-const path = require("path");
-
-const ESY_FOLDER = process.env.ESY__PREFIX
-  ? process.env.ESY__PREFIX
-  : path.join(os.homedir(), ".esy");
-const esy3 = fs
-  .readdirSync(ESY_FOLDER)
-  .filter((name) => name.length > 0 && name[0] === "3")
-  .sort()
-  .pop();
-console.log(`::set-output name=esy_cache::${path.join(ESY_FOLDER, esy3, "i")}`);

package/.github/workflows/publish.yml

@@ -1,161 +0,0 @@
-name: ppx_spice publish
-
-on: [workflow_dispatch]
-
-jobs:
-  build_linux:
-    name: ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
-    defaults:
-      run:
-        working-directory: src
-    strategy:
-      matrix:
-        os: [ubuntu-latest]
-        ocaml-compiler:
-          - 4.12.1
-
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Use OCaml ${{ matrix.ocaml-compiler}}
-        uses: ocaml/setup-ocaml@v2
-        with:
-          ocaml-compiler: ${{ matrix.ocaml-compiler }}
-
-      - name: Install deps
-        run: opam install . --deps-only --with-test
-
-      - name: Build
-        run: opam exec -- dune build
-
-      - name: Copy built PPX file
-        run: |
-          mv ./_build/default/bin/bin.exe ppx.exe
-
-      - name: (only on release) Upload artifacts ${{ matrix.os }}
-        uses: actions/upload-artifact@master
-        with:
-          name: ${{ matrix.os }}
-          path: src/ppx.exe
-          if-no-files-found: error
-
-  build_macos:
-    name: ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
-    defaults:
-      run:
-        working-directory: src
-    strategy:
-      matrix:
-        os: [macOS-latest]
-        ocaml-compiler:
-          - 4.12.1
-
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Use OCaml ${{ matrix.ocaml-compiler}}
-        uses: ocaml/setup-ocaml@v2
-        with:
-          ocaml-compiler: ${{ matrix.ocaml-compiler }}
-
-      - name: Install deps
-        run: opam install . --deps-only --with-test
-
-      - name: Build
-        run: opam exec -- dune build
-
-      - name: Copy built PPX file
-        run: |
-          mv ./_build/default/bin/bin.exe ppx.exe
-
-      - name: (only on release) Upload artifacts ${{ matrix.os }}
-        uses: actions/upload-artifact@master
-        with:
-          name: ${{ matrix.os }}
-          path: src/ppx.exe
-          if-no-files-found: error
-
-  build_windows:
-    name: ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
-    defaults:
-      run:
-        working-directory: src
-    strategy:
-      matrix:
-        os: [windows-latest]
-        ocaml-compiler:
-          - 4.12.1
-
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Use OCaml ${{ matrix.ocaml-compiler}}
-        uses: ocaml/setup-ocaml@v2
-        with:
-          ocaml-compiler: ${{ matrix.ocaml-compiler }}
-
-      - name: Install deps
-        run: opam install . --deps-only --with-test
-
-      - name: Build
-        run: opam exec -- dune build
-
-      - name: Copy built PPX file
-        run: |
-          mv ./_build/default/bin/bin.exe ppx.exe
-
-      - name: (only on release) Upload artifacts ${{ matrix.os }}
-        uses: actions/upload-artifact@master
-        with:
-          name: ${{ matrix.os }}
-          path: src/ppx.exe
-          if-no-files-found: error
-
-  publish:
-    needs: [build_linux, build_macos, build_windows]
-    name: (only on release) Publish
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16
-          registry-url: "https://registry.npmjs.org"
-
-      - name: Download linux artifacts
-        if: success()
-        uses: actions/download-artifact@master
-        with:
-          name: ubuntu-latest
-          path: binaries/linux
-
-      - name: Download macOS artifacts
-        if: success()
-        uses: actions/download-artifact@master
-        with:
-          name: macOS-latest
-          path: binaries/darwin
-
-      - name: Download windows artifacts
-        if: success()
-        uses: actions/download-artifact@master
-        with:
-          name: windows-latest
-          path: binaries/windows
-
-      - name: Move artifacts
-        if: success()
-        run: |
-          mkdir -p bin
-          mv binaries/linux/ppx.exe ppx-linux.exe
-          mv binaries/darwin/ppx.exe ppx-osx.exe
-          mv binaries/windows/ppx.exe ppx-windows.exe
-
-      - name: Publish
-        if: success()
-        run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}

package/.github/workflows/publish_prerelease.yml

@@ -1,177 +0,0 @@
-name: ppx_spice publish prerelease
-
-on:
-  workflow_dispatch:
-    inputs:
-      release_version:
-        description: "change npm release version"
-        required: true
-        default: ""
-
-jobs:
-  build_linux:
-    name: ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
-    defaults:
-      run:
-        working-directory: src
-    strategy:
-      matrix:
-        os: [ubuntu-latest]
-        ocaml-compiler:
-          - 4.12.1
-
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Use OCaml ${{ matrix.ocaml-compiler}}
-        uses: ocaml/setup-ocaml@v2
-        with:
-          ocaml-compiler: ${{ matrix.ocaml-compiler }}
-
-      - name: Install deps
-        run: opam install . --deps-only --with-test
-
-      - name: Build
-        run: opam exec -- dune build
-
-      - name: Copy built PPX file
-        run: |
-          mv ./_build/default/bin/bin.exe ppx.exe
-
-      - name: (only on release) Upload artifacts ${{ matrix.os }}
-        uses: actions/upload-artifact@master
-        with:
-          name: ${{ matrix.os }}
-          path: src/ppx.exe
-          if-no-files-found: error
-
-  build_macos:
-    name: ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
-    defaults:
-      run:
-        working-directory: src
-    strategy:
-      matrix:
-        os: [macOS-latest]
-        ocaml-compiler:
-          - 4.12.1
-
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Use OCaml ${{ matrix.ocaml-compiler}}
-        uses: ocaml/setup-ocaml@v2
-        with:
-          ocaml-compiler: ${{ matrix.ocaml-compiler }}
-
-      - name: Install deps
-        run: opam install . --deps-only --with-test
-
-      - name: Build
-        run: opam exec -- dune build
-
-      - name: Copy built PPX file
-        run: |
-          mv ./_build/default/bin/bin.exe ppx.exe
-
-      - name: (only on release) Upload artifacts ${{ matrix.os }}
-        uses: actions/upload-artifact@master
-        with:
-          name: ${{ matrix.os }}
-          path: src/ppx.exe
-          if-no-files-found: error
-
-  build_windows:
-    name: ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
-    defaults:
-      run:
-        working-directory: src
-    strategy:
-      matrix:
-        os: [windows-latest]
-        ocaml-compiler:
-          - 4.12.1
-
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Use OCaml ${{ matrix.ocaml-compiler}}
-        uses: ocaml/setup-ocaml@v2
-        with:
-          ocaml-compiler: ${{ matrix.ocaml-compiler }}
-
-      - name: Install deps
-        run: opam install . --deps-only --with-test
-
-      - name: Build
-        run: opam exec -- dune build
-
-      - name: Copy built PPX file
-        run: |
-          mv ./_build/default/bin/bin.exe ppx.exe
-
-      - name: (only on release) Upload artifacts ${{ matrix.os }}
-        uses: actions/upload-artifact@master
-        with:
-          name: ${{ matrix.os }}
-          path: src/ppx.exe
-          if-no-files-found: error
-
-  publish:
-    needs: [build_linux, build_macos, build_windows]
-    name: (only on release) Publish (pre-release)
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16
-          registry-url: "https://registry.npmjs.org"
-
-      - name: Download linux artifacts
-        if: success()
-        uses: actions/download-artifact@master
-        with:
-          name: ubuntu-latest
-          path: binaries/linux
-
-      - name: Download macOS artifacts
-        if: success()
-        uses: actions/download-artifact@master
-        with:
-          name: macOS-latest
-          path: binaries/darwin
-
-      - name: Download windows artifacts
-        if: success()
-        uses: actions/download-artifact@master
-        with:
-          name: windows-latest
-          path: binaries/windows
-
-      - name: Move artifacts
-        if: success()
-        run: |
-          mkdir -p bin
-          mv binaries/linux/ppx.exe ppx-linux.exe
-          mv binaries/darwin/ppx.exe ppx-osx.exe
-          mv binaries/windows/ppx.exe ppx-windows.exe
-
-      - name: Change npm release version
-        if: success()
-        uses: reedyuk/npm-version@1.1.1
-        with:
-          version: ${{ github.event.inputs.release_version }}
-
-      - name: Pack package
-        if: success()
-        run: npm pack
-
-      - name: Publish
-        if: success()
-        run: npm publish greenlabs-ppx-spice-${{ github.event.inputs.release_version }}.tgz --tag next
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}

package/.vscode/settings.json

@@ -1,6 +0,0 @@
-{
-  "ocaml.sandbox": {
-    "kind": "opam",
-    "switch": "4.12.1"
-  }
-}

package/src/bin/bin.ml

@@ -1 +0,0 @@
-let () = Ppxlib.Driver.run_as_ppx_rewriter ()

package/src/bin/dune

@@ -1,5 +0,0 @@
-(executable
- (package ppx_spice)
- (name bin)
- (public_name ppx_spice)
- (libraries ppx_spice))

package/src/dune

@@ -1 +0,0 @@
-(dirs ppx bin)

package/src/dune-project

@@ -1,2 +0,0 @@
-(lang dune 2.7)
-(name ppx_spice)

package/src/dune-workspace

@@ -1,3 +0,0 @@
-(lang dune 1.1)
-
-(env (release-static (flags (:standard -ccopt -static))))

package/src/esy.lock/.gitattributes

@@ -1,3 +0,0 @@
-
-# Set eol to LF so files aren't converted to CRLF-eol on Windows.
-* text eol=lf linguist-generated

package/src/esy.lock/.gitignore

@@ -1,3 +0,0 @@
-
-# Reset any possible .gitignore, we want all esy.lock to be un-ignored.
-!*