Improve templates (#108)

* make switch install from lockfile

* Ignore constraint on OCaml

* Add None for test framework

* Misc improvements to templates

* Update CI schedule

* Fix CI errors

* Fix test command

Author: tmattio

.github/workflows/ci.yml

@@ -1,71 +1,55 @@
 name: CI
 
-on: [push, pull_request]
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
 
 jobs:
-  build:
-    name: Build and test
-
-    runs-on: ${{ matrix.os }}
+  build-and-test:
+    name: CI
 
     strategy:
       fail-fast: false
+
       matrix:
         os:
           - macos-latest
           - ubuntu-latest
-        ocaml-version:
-          - 4.10.1
+          - windows-latest
+
+        ocaml-compiler:
+          - 4.12.x
+
+    runs-on: ${{ matrix.os }}
 
     steps:
+
       - name: Checkout code
         uses: actions/checkout@v2
 
-      - name: Retrieve opam cache
-        uses: actions/cache@v2
-        if: runner.os != 'Windows'
-        id: cache-opam
-        with:
-          path: ~/.opam
-          key: v1-${{ runner.os }}-opam-${{ matrix.ocaml-version }}-${{ hashFiles('spin.opam.locked') }}
-          restore-keys: |
-            v1-${{ runner.os }}-opam-${{ matrix.ocaml-version }}-
-
-      - name: Use OCaml ${{ matrix.ocaml-version }}
-        uses: avsm/setup-ocaml@v1
-        with:
-          ocaml-version: ${{ matrix.ocaml-version }}
-
-      - name: Use Node.js 12.x
-        uses: actions/setup-node@v1
+      - name: Use OCaml ${{ matrix.ocaml-compiler }}
+        uses: avsm/setup-ocaml@v2
         with:
-          node-version: 12.x
-          registry-url: "https://registry.npmjs.org"
-
-      - name: Install esy
-        run: npm install -g esy@latest
+          ocaml-compiler: ${{ matrix.ocaml-compiler }}
+          dune-cache: ${{ matrix.os != 'macos-latest' }}
+          opam-depext-flags: --with-test
 
-      - name: Pin package
-        run: opam pin add spin.dev . --no-action
+      - name: Install ocamlformat
+        run: opam install ocamlformat.0.18.0
+        if: ${{ matrix.os == 'ubuntu-latest' }}
 
-      - name: Query and install external dependencies
-        run: opam depext spin --yes --with-doc --with-test
+      - name: Install opam packages
+        run: opam install . --with-test
 
-      - name: Install dependencies
-        if: steps.cache-opam.outputs.cache-hit != 'true'
-        run: |
-          opam install . --deps-only --with-doc --with-test --locked --unlock-base
-          opam install ocamlformat reason --skip-updates
-
-      - name: Upgrade dependencies
-        run: opam upgrade --fixup
-        if: steps.cache-opam.outputs.cache-hit == 'true'
+      - name: Check formatting
+        run: make fmt
+        if: ${{ matrix.os == 'ubuntu-latest' && always() }}
 
-      - name: Build
+      - name: Run build
         run: make build
 
-      - name: Check formatting
-        run: make format
-
-      - name: Run tests
+      - name: Run the unit tests
         run: make test
+        timeout-minutes: 1

.github/workflows/release.yml

@@ -6,19 +6,30 @@ on:
 
 jobs:
   build:
-    name: Build and test
-    runs-on: ${{ matrix.os }}
     strategy:
+      fail-fast: false
+
       matrix:
-        os: [ubuntu-latest, macos-latest]
-        ocaml-version: ['4.10.1']
+        os:
+          - macos-latest
+          - ubuntu-latest
+
+        ocaml-compiler:
+          - 4.12.x
+
+    runs-on: ${{ matrix.os }}
 
     steps:
-      - uses: actions/checkout@v2
 
-      - uses: avsm/setup-ocaml@master
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Use OCaml ${{ matrix.ocaml-compiler }}
+        uses: avsm/setup-ocaml@v2
         with:
-          ocaml-version: ${{ matrix.ocaml-version }}
+          ocaml-compiler: ${{ matrix.ocaml-compiler }}
+          dune-cache: ${{ matrix.os != 'macos-latest' }}
+          opam-depext-flags: --with-test
 
       - name: Use Node.js 12.x
         if: ${{ matrix.os == 'ubuntu-latest' }}
@@ -29,25 +40,21 @@ jobs:
       - name: Fetch git tags
         run: git fetch --tags --force
 
-      - name: Pin package
-        run: opam pin add spin.dev -n .
+      - name: Install opam packages
+        run: opam install .
+          
+      - name: Substitute watermarks
+        run: opam exec -- dune subst
 
-      - name: Query and install external dependencies
-        run: opam depext -yt spin
+      - name: Run build
+        run: opam exec -- dune build --release
 
-      - name: Install dependencies
-        run: opam install --deps-only -y .
-          
       - name: Substitute watermarks
         run: opam exec -- dune subst
 
       - name: Build
         run: opam exec -- dune build --release
 
-      - name: Make NPM release skeleton
-        if: ${{ matrix.os == 'ubuntu-latest' }}
-        run: node script/release-make-skeleton.js
-
       - name: Upload _release
         if: ${{ matrix.os == 'ubuntu-latest' }}
         uses: actions/upload-artifact@master
@@ -121,12 +128,12 @@ jobs:
           asset_name: spin-linux-x64.zip
           asset_content_type: application/gzip
 
-      - name: Publish NPM package
-        run: |
-          npm config set //registry.npmjs.org/:_authToken=$NODE_AUTH_TOKEN
-          npm config set scope "@tmattio"
-          npm config list
-          npm publish --access public
-        working-directory: ./_release
+      - name: Upload spin-windows-x64.zip to Github release 
+        uses: actions/upload-release-asset@v1
         env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ github.event.release.upload_url }}
+          asset_path: spin-windows-x64.zip
+          asset_name: spin-windows-x64.zip
+          asset_content_type: application/gzip

.ocamlformat

@@ -1,3 +1,4 @@
+version = 0.18.0
 profile = sparse
 break-cases = nested
 break-fun-decl = smart
@@ -15,4 +16,4 @@ ocp-indent-compat = true
 wrap-comments = true
 parse-docstrings = true
 let-binding-spacing = compact
-type-decl = sparse
+type-decl = sparse

CHANGES.md

@@ -11,6 +11,14 @@
 
 ## Changed
 
+- Increase version of `ocamlformat` to `0.18.0` in templates
+- Do not install merlin when installing dev dependencies in templates
+- Drop support for BuckleScript in PPX
+- Drop support for publishing on NPM for CLI and PPX templates
+- Update CI scripts to `avsm/setup-ocaml@v2`
+- Remove python dependency to serve documentation in Makefile
+- Inline release script in Makefile
+- Remove global `-open StdLabels` in templates
 - The `spa` template has been removed from the official templates and now lives at https://github.com/tmattio/spin-incr-dom
 - Spin does not parse binary files by default anymore, they are simply copied to the destination folder
 - Use `test` stanza for unit tests now that Alcotest prints colors by default

CONTRIBUTING.md

@@ -73,11 +73,7 @@ The, you can run the script `script/release.sh`. The script will perform the fol
 - Publish the distribution archive to a Github Release.
 - Submit a PR on Opam's repository.
 
-When the release is published on Github, the CI/CD will trigger the `Release` workflow which will perform the following actions
-
-- Compile binaries for all supported platforms.
-- Create an NPM release containing the pre-built binaries.
-- Publish the NPM release to the registry.
+When the release is published on Github, the CI/CD will trigger the `Release` workflow which will compile binaries for all supported platforms and add them to the Github Release as assets.
 
 ### Repository Structure
 

Makefile

@@ -1,43 +1,17 @@
 .DEFAULT_GOAL := all
 
-define BROWSER_PYSCRIPT
-import os, webbrowser, sys
-
-from urllib.request import pathname2url
-
-webbrowser.open("file://" + pathname2url(os.path.abspath(sys.argv[1])))
-endef
-export BROWSER_PYSCRIPT
-
-define PRINT_HELP_PYSCRIPT
-import re, sys
-
-for line in sys.stdin:
-	match = re.match(r'^([a-zA-Z_-]+):.*?## (.*)$$', line)
-	if match:
-		target, help = match.groups()
-		print("%-20s %s" % (target, help))
-endef
-export PRINT_HELP_PYSCRIPT
-
-BROWSER := python -c "$$BROWSER_PYSCRIPT"
-
 ARGS := $(wordlist 2,$(words $(MAKECMDGOALS)),$(MAKECMDGOALS))
 $(eval $(ARGS):;@:)
 
-.PHONY: help
-help: ## Print this help message
-	@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)
-
 .PHONY: all
 all:
 	opam exec -- dune build --root . @install
 
 .PHONY: dev
 dev: ## Install development dependencies
-	opam switch create --no-install . ocaml-base-compiler.4.10.1
-	opam install -y dune-release merlin ocamlformat utop ocaml-lsp-server reason
-	opam install --locked --deps-only --with-test --with-doc -y .
+	opam switch create --no-install . ocaml-base-compiler.4.12.0
+	opam install -y dune-release ocamlformat utop ocaml-lsp-server
+	opam install --deps-only --with-test --with-doc -y .
 
 .PHONY: build
 build: ## Build the project, including non installable libraries and executables
@@ -50,6 +24,7 @@ start: all ## Start the project
 .PHONY: install
 install: all ## Install the packages on the system
 	opam exec -- dune install --root .
+	bash -c "cp $$(opam exec -- which spin) /usr/local/bin/spin"
 
 .PHONY: test
 test: ## Run the unit tests
@@ -70,10 +45,10 @@ doc: ## Generate odoc documentation
 
 .PHONY: servedoc
 servedoc: doc ## Open odoc documentation with default web browser
-	$(BROWSER) _build/default/_doc/_html/index.html
+	open _build/default/_doc/_html/index.html
 
-.PHONY: format
-format: ## Format the codebase with ocamlformat
+.PHONY: fmt
+fmt: ## Format the codebase with ocamlformat
 	opam exec -- dune build --root . @fmt --auto-promote
 
 .PHONY: watch
@@ -86,4 +61,8 @@ utop: ## Run a REPL and link with the project's libraries
 
 .PHONY: release
 release: ## Run the release script
-	opam exec -- sh script/release.sh
+	opam exec -- dune-release tag
+	opam exec -- dune-release distrib
+	opam exec -- dune-release publish distrib -y
+	opam exec -- dune-release opam pkg
+	opam exec -- dune-release opam submit --no-auto-open -y

README.md

@@ -53,14 +53,6 @@ brew install tmattio/tap/spin
 opam install spin
 ```
 
-### Using npm
-
-```bash
-yarn global add @tmattio/spin
-# Or
-npm -g install @tmattio/spin
-```
-
 ### Using a script
 
 ```bash
@@ -86,7 +78,7 @@ The official Spin templates templates are the following:
 - **bin** - Native project containing a binary.
 - **cli** - Command Line Interface releasable on Opam.
 - **lib** - Library releasable on Opam.
-- **ppx** - PPX library with prebuilt binaries for native and bucklescript.
+- **ppx** - PPX library.
 - **c-bindings** - Bindings to a C library.
 - **js** - Js application with Js_of_ocaml.
 

bin/common.ml

@@ -87,9 +87,13 @@ let handle_errors = function
 
 let exits =
   Term.exit_info 3 ~doc:"on indiscriminate errors reported on stderr."
-  :: Term.exit_info 4 ~doc:"on missing required environment variable."
-  :: Term.exit_info 5 ~doc:"on failure to parse a file."
-  :: Term.exit_info 6 ~doc:"on invalid spin template."
-  :: Term.exit_info 7 ~doc:"on failure to generate project."
-  :: Term.exit_info 8 ~doc:"on failure to run a generator."
-  :: Term.default_exits
+  ::
+  Term.exit_info 4 ~doc:"on missing required environment variable."
+  ::
+  Term.exit_info 5 ~doc:"on failure to parse a file."
+  ::
+  Term.exit_info 6 ~doc:"on invalid spin template."
+  ::
+  Term.exit_info 7 ~doc:"on failure to generate project."
+  ::
+  Term.exit_info 8 ~doc:"on failure to run a generator." :: Term.default_exits

dune-project

@@ -26,6 +26,7 @@
    (>= 4.08.0))
   dune
   (alcotest :with-test)
+  (reason :with-test)
   (odoc :with-doc)
   (crunch :build)
   base

lib/spin/decoder.ml

@@ -277,7 +277,7 @@ let one_of decoders sexp =
       | Error error ->
         go
           (tag_errors ~msg:(Printf.sprintf "%S decoder" name) [ error ]
-          :: errors)
+           :: errors)
           rest)
     | [] ->
       Error