Merge pull request #19 from imbsky/prettier

Add prettier and some improvements

Author: BSKY

.gitattributes

@@ -1 +1,2 @@
+* text=auto eol=lf
 lib/* linguist-generated

.github/workflows/test.yml

@@ -1,25 +1,40 @@
 name: Test ocaml-action
 
 on:
-  push:
-    branches:
-      - "master"
-      - "releases/*"
-  pull_request:
+  - push
+  - pull_request
 
 jobs:
   test:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, macos-latest, windows-latest]
-        ocaml-version: ["4.08.1", "4.05.0"]
+        os:
+          - macos-latest
+          - ubuntu-latest
+          - windows-latest
+        node-version:
+          - 13.x
+        ocaml-version:
+          - 4.08.1
+          - 4.05.0
 
     runs-on: ${{ matrix.os }}
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/[email protected]
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/[email protected]
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Install npm packages
+        run: yarn --frozen-lockfile
+
+      - name: Check formatting
+        run: yarn fmt:check
 
       - name: Use OCaml ${{ matrix.ocaml-version }}
         uses: ./

.prettierignore

@@ -0,0 +1 @@
+lib/

README.md

@@ -1,11 +1,11 @@
-# Create an OCaml Action 
+# Create an OCaml Action
 
 Use this template to bootstrap the creation of an OCaml action.:rocket:
 
 This template installs the [opam](https://opam.ocaml.org) on Ubuntu Linux,
 macOS and Windows for use with GitHub Actions.
 
-If you are new, there's also a simpler introduction.  See the [Hello World
+If you are new, there's also a simpler introduction. See the [Hello World
 OCaml Action](https://github.com/avsm/hello-world-action-ocaml) that uses Dune
 and opam to build a simple library.
 
@@ -17,19 +17,19 @@ and opam to build a simple library.
 
 The action does the following:
 
-- *Ubuntu:* Installs the latest opam with sandboxing active
-- *macOS:* Installs the latest opam from Homebrew with sandboxing active
-- *Windows:* Installs Cygwin and the [fdopen fork](https://fdopen.github.io/opam-repository-mingw/) with mingw64c
+- _Ubuntu:_ Installs the latest opam with sandboxing active
+- _macOS:_ Installs the latest opam from Homebrew with sandboxing active
+- _Windows:_ Installs Cygwin and the [fdopen fork](https://fdopen.github.io/opam-repository-mingw/) with mingw64c
 
 The repository is initialised to the default one, and then the following plugins are installed:
+
 - `opam-depext`
 
 The `opam` binary is added to the `PATH` for subsequent actions, so that
 executing `opam` commands will just work after that.
 
 ## Example workflow
 
-
 ```
 name: Build Hello World executable
 on: [push, pull_request]
@@ -59,7 +59,7 @@ jobs:
 ## Roadmap
 
 This action aims to provide an OS-neutral interface to `opam`, and so
-will not add features that only work on one operating system.  It will
+will not add features that only work on one operating system. It will
 also track the latest stable release of opam.
 
 Discussions: https://discuss.ocaml.org/t/github-actions-for-ocaml-opam-now-available/4745

__tests__/installer.test.ts

@@ -1,20 +1,14 @@
-import io = require('@actions/io');
-import fs = require('fs');
-import os = require('os');
-import path = require('path');
+import * as io from "@actions/io";
+import * as path from "path";
+import * as installer from "../src/installer";
 
-const toolDir = path.join(__dirname, 'runner', 'tools');
-const tempDir = path.join(__dirname, 'runner', 'temp');
-const dataDir = path.join(__dirname, 'data');
+const toolDir = path.join(__dirname, "runner", "tools");
+const tempDir = path.join(__dirname, "runner", "temp");
 
-process.env['RUNNER_TOOL_CACHE'] = toolDir;
-process.env['RUNNER_TEMP'] = tempDir;
-import * as installer from '../src/installer';
-
-const IS_WINDOWS = process.platform === 'win32';
-
-describe('installer tests', () => {
+process.env["RUNNER_TOOL_CACHE"] = toolDir;
+process.env["RUNNER_TEMP"] = tempDir;
 
+describe("installer tests", () => {
   beforeAll(async () => {
     await io.rmRF(toolDir);
     await io.rmRF(tempDir);
@@ -25,13 +19,11 @@ describe('installer tests', () => {
       await io.rmRF(toolDir);
       await io.rmRF(tempDir);
     } catch {
-      console.log('Failed to remove test directories');
+      console.log("Failed to remove test directories");
     }
   }, 100000);
 
-  it('Acquires opam source', async () => {
-    await installer.getOpam('2.0.5');
-    const OCamldir = path.join(toolDir, 'opam', '2.0.5', os.arch());
+  it("Acquires opam source", async () => {
+    await installer.getOpam("2.0.5");
   }, 1000000);
-
 });

action.yml

@@ -2,12 +2,12 @@ name: Set up OCaml
 description: Set up an OCaml and opam environment and add to PATH
 author: Anil Madhavapeddy
 branding:
-  icon: 'package'
-  color: 'orange'
+  icon: "package"
+  color: "orange"
 inputs:
   ocaml-version:
     description: Version of the OCaml compiler to initialise
     default: 4.08.1
 runs:
-  using: 'node12'
-  main: 'lib/index.js'
+  using: "node12"
+  main: "lib/index.js"

jest.config.js

@@ -1,11 +1,11 @@
 module.exports = {
   clearMocks: true,
-  moduleFileExtensions: ['js', 'ts'],
-  testEnvironment: 'node',
-  testMatch: ['**/*.test.ts'],
-  testRunner: 'jest-circus/runner',
+  moduleFileExtensions: ["js", "ts"],
+  testEnvironment: "node",
+  testMatch: ["**/*.test.ts"],
+  testRunner: "jest-circus/runner",
   transform: {
-    '^.+\\.ts$': 'ts-jest'
+    "^.+\\.ts$": "ts-jest",
   },
-  verbose: true
-}
+  verbose: true,
+};

lib/index.js

@@ -1,6 +1,8 @@
 {
   "private": true,
   "scripts": {
+    "fmt": "prettier --write .",
+    "fmt:check": "prettier --check .",
     "test": "jest",
     "build:copy": "mkdir -p lib && shx cp src/*.{bat,cmd,sh} lib/",
     "build:setup-ocaml": "ncc build src/setup-ocaml.ts -o lib",
@@ -17,6 +19,7 @@
     "jest": "25.2.7",
     "jest-circus": "25.2.7",
     "npm-run-all": "4.1.5",
+    "prettier": "2.0.4",
     "shx": "0.3.2",
     "ts-jest": "25.3.1",
     "typescript": "3.8.3"