Merge pull request #6 from tmattio/v2

Author: tmattio

.gitattributes

@@ -1,4 +1,4 @@
-# Tell github that .re and .rei files are Reason
+# Tell github that .ml and .mli files are OCaml
 *.ml linguist-language=OCaml
 *.mli linguist-language=OCaml
 

.github/workflows/ci.yml

@@ -1,60 +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('inquire.opam.locked') }}
-          restore-keys: |
-            v1-${{ runner.os }}-opam-${{ matrix.ocaml-version }}-
-
-      - name: Use OCaml ${{ matrix.ocaml-version }}
-        uses: avsm/setup-ocaml@v1
+      - 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: Pin package
-        run: opam pin add inquire.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 inquire --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 --skip-updates
+      - name: Install examples opam packages
+        run: opam install cmdliner
 
-      - 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
-

.gitignore

@@ -1,14 +1,5 @@
-# ocamlbuild working directory
+# Dune working directory
 _build/
-
-# ocamlbuild targets
-*.byte
-*.native
-
-# Merlin configuring file for Vim and Emacs
-.merlin
-
-# Dune generated files
 *.install
 
 # Local OPAM switch

.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

@@ -1,3 +1,16 @@
+# 0.3.0 - 2021-05-17
+
+## Added
+
+- Improved all prompts prompt to handle escape sequences (e.g. "Ctrl-L" will clear the screen while reading from answer).
+- Improved `select` to allow selection using indexes.
+- Improved prompts to clear defaults and other tooltip on a valid answer and print the answer after the prompt.
+
+## Changed
+
+- Stripped out `lambda-term` dependency
+- Removed `lwt` integration
+
 # 0.2.1 - 2020-10-04
 
 ## Changed 

CONTRIBUTING.md

@@ -0,0 +1,86 @@
+# Contributing
+
+## Setup your development environment
+
+You need Opam, you can install it by following [Opam's documentation](https://opam.ocaml.org/doc/Install.html).
+
+With Opam installed, you can install the dependencies in a new local switch with:
+
+```bash
+make switch
+```
+
+Or globally, with:
+
+```bash
+make deps
+```
+
+Then, build the project with:
+
+```bash
+make build
+```
+
+### Running Binary
+
+After building the project, you can run the main binary that is produced.
+
+
+```bash
+make start
+```
+
+### Running Tests
+
+You can run the test compiled executable:
+
+
+```bash
+make test
+```
+
+### Building documentation
+
+Documentation for the libraries in the project can be generated with:
+
+
+```bash
+make doc
+open-cli $(make doc-path)
+```
+
+This assumes you have a command like [open-cli](https://github.com/sindresorhus/open-cli) installed on your system.
+
+> NOTE: On macOS, you can use the system command `open`, for instance `open $(make doc-path)`
+
+### Repository Structure
+
+The following snippet describes Inquire's repository structure.
+
+```text
+.
+├── bin/
+|   Source for inquire's binary. This links to the library defined in `lib/`.
+│
+├── lib/
+|   Source for Inquire's library. Contains Inquire's core functionnalities.
+│
+├── test/
+|   Unit tests and integration tests for Inquire.
+│
+├── dune-project
+|   Dune file used to mark the root of the project and define project-wide parameters.
+|   For the documentation of the syntax, see https://dune.readthedocs.io/en/stable/dune-files.html#dune-project
+│
+├── LICENSE
+│
+├── Makefile
+|   Make file containing common development command.
+│
+├── README.md
+│
+└── inquire.opam
+    Opam package definition.
+    To know more about creating and publishing opam packages, see https://opam.ocaml.org/doc/Packaging.html.
+```

LICENSE

@@ -1,7 +1,21 @@
-Copyright 2019 Thibaut Mattio
+MIT License
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Copyright (c) 2020 Thibaut Mattio
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -1,44 +1,55 @@
 .PHONY: all
 all:
-	opam exec -- dune build @install
+	opam exec -- dune build --root . @install
 
-.PHONY: dev
-dev:
-	opam install dune-release merlin ocamlformat utop
+.PHONY: deps
+deps: ## Install development dependencies
+	opam install -y dune-release merlin ocamlformat utop ocaml-lsp-server
 	opam install --deps-only --with-test --with-doc -y .
 
+.PHONY: create_switch
+create_switch:
+	opam switch create . --no-install
+
+.PHONY: switch
+switch: create_switch deps ## Create an opam switch and install development dependencies
+
+.PHONY: lock
+lock: ## Generate a lock file
+	opam lock -y .
+
 .PHONY: build
-build:
-	opam exec -- dune build
+build: ## Build the project, including non installable libraries and executables
+	opam exec -- dune build --root .
 
 .PHONY: install
-install:
-	opam exec -- dune install
+install: all ## Install the packages on the system
+	opam exec -- dune install --root .
+
+.PHONY: start
+start: all ## Run the produced executable
+	opam exec -- dune exec --root . bin/main.exe $(ARGS)
+
+.PHONY: test
+test: ## Run the unit tests
+	opam exec -- dune build --root . @test/runtest -f
 
 .PHONY: clean
-clean:
-	opam exec -- dune clean
+clean: ## Clean build artifacts and other generated files
+	opam exec -- dune clean --root .
 
 .PHONY: doc
-doc:
-	opam exec -- dune build @doc
-
-.PHONY: doc-path
-doc-path:
-	@echo "_build/default/_doc/_html/index.html"
+doc: ## Generate odoc documentation
+	opam exec -- dune build --root . @doc
 
-.PHONY: format
-format:
-	opam exec -- dune build @fmt --auto-promote
+.PHONY: fmt
+fmt: ## Format the codebase with ocamlformat
+	opam exec -- dune build --root . --auto-promote @fmt
 
 .PHONY: watch
-watch:
-	opam exec -- dune build --watch
+watch: ## Watch for the filesystem and rebuild on every change
+	opam exec -- dune build --root . --watch
 
 .PHONY: utop
-utop:
-	opam exec -- dune utop lib -- -implicit-bindings
-
-.PHONY: release
-release:
-	opam exec -- sh script/release.sh
+utop: ## Run a REPL and link with the project's libraries
+	opam exec -- dune utop --root . lib -- -implicit-bindings