Update README for v19

update tests

.github/dependabot.yml

@@ -0,0 +1,13 @@
+version: 2
+updates:
+
+- package-ecosystem: github-actions
+  directory: "/"
+  schedule:
+    interval: daily
+    time: '00:00'
+    timezone: UTC
+  open-pull-requests-limit: 10
+  commit-message:
+      prefix: "chore"
+      include: "scope"

.github/workflows/test.yml

@@ -2,6 +2,9 @@ name: "install-nix-action test"
 on:
   pull_request:
   push:
+    branches:
+      - master
+
 jobs:
   simple-build:
     strategy:
@@ -9,28 +12,93 @@ jobs:
         os: [ubuntu-latest, macos-latest]
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v2
-    - run: yarn install --frozen-lockfile
-    - run: yarn build
+    - uses: actions/checkout@v3
     - name: Install Nix
       uses: ./
+      with:
+        nix_path: nixpkgs=channel:nixos-20.03
     - run: nix-env -iA cachix -f https://cachix.org/api/v1/install
     - run: cat /etc/nix/nix.conf
     # cachix should be available and be able to configure a cache
     - run: cachix use cachix
     - run: nix-build test.nix
-  no-channel:
+  custom-nix-path:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest]
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v2
-    - run: yarn install --frozen-lockfile
-    - run: yarn build
+    - uses: actions/checkout@v3
     - name: Install Nix
       uses: ./
       with:
-        skip_adding_nixpkgs_channel: true
-    - run: nix-build test.nix && exit 1 || echo "OK"
-    - run: NIX_PATH=nixpkgs=https://github.com/NixOS/nixpkgs/tarball/ab5863afada3c1b50fc43bf774b75ea71b287cde nix-build test.nix
+        nix_path: nixpkgs=channel:nixos-20.03
+    - run: test $NIX_PATH == "nixpkgs=channel:nixos-20.03"
+    - run: nix-build test.nix
+
+  extra-nix-config:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v3
+    - name: Install Nix
+      uses: ./
+      with:
+        nix_path: nixpkgs=channel:nixos-20.03
+        extra_nix_config: |
+          sandbox = relaxed
+    - run: cat /etc/nix/nix.conf
+    - run: nix-build test.nix --arg noChroot true
+
+  flakes:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v3
+    - name: Install Nix
+      uses: ./
+    - run: nix flake show github:NixOS/nixpkgs
+
+  installer-options:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v3
+    - name: Install Nix
+      uses: ./
+      with:
+        nix_path: nixpkgs=channel:nixos-22.05
+        install_options: --tarball-url-prefix https://nixos-nix-install-tests.cachix.org/serve
+        install_url: https://nixos-nix-install-tests.cachix.org/serve/s62m7lc0q0mz2mxxm9q0kkrcg90njzhq/install
+    - run: nix-build test.nix
+
+  oldest-supported-installer:
+    strategy:
+        matrix:
+          os: [ubuntu-latest, macos-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v3
+    - name: Install Nix
+      uses: ./
+      with:
+        nix_path: nixpkgs=channel:nixos-22.05
+        install_url: https://releases.nixos.org/nix/nix-2.8.0/install
+    - run: nix-build test.nix
+
+  act-support:
+    strategy:
+        matrix:
+          os: [ubuntu-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v3
+    - run: curl https://raw.githubusercontent.com/nektos/act/master/install.sh | sudo bash
+    - run: docker pull ghcr.io/catthehacker/ubuntu:js-20.04
+    - run: ./bin/act -P ubuntu-latest=ghcr.io/catthehacker/ubuntu:js-20.04 push -j simple-build

README.md

@@ -1,9 +1,25 @@
 # install-nix-action
 
-![github actions badge](https://github.com/cachix/install-nix-action/workflows/install-nix-action%20test/badge.svg)
+![GitHub Actions badge](https://github.com/cachix/install-nix-action/workflows/install-nix-action%20test/badge.svg)
 
 Installs [Nix](https://nixos.org/nix/) on GitHub Actions for the supported platforms: Linux and macOS.
 
+By default it has no nixpkgs configured, you have to set `nix_path`
+by [picking a channel](https://status.nixos.org/)
+or [pin nixpkgs yourself](https://nix.dev/reference/pinning-nixpkgs.html)
+(see also [pinning tutorial](https://nix.dev/tutorials/towards-reproducibility-pinning-nixpkgs.html)).
+
+# Features
+
+- Quick installation (~4s on Linux, ~20s on macOS)
+- Multi-User installation (with sandboxing enabled only on Linux)
+- [Self-hosted GitHub runner](https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners) support
+- Allows specifying Nix installation URL via `install_url` (the oldest supported Nix version is 2.3.5)
+- Allows specifying extra Nix configuration options via `extra_nix_config`
+- Allows specifying `$NIX_PATH` and channels via `nix_path`
+- Share `/nix/store` between builds using [cachix-action](https://github.com/cachix/cachix-action) for simple binary cache setup to speed up your builds and share binaries with your team
+- Enables `flakes` and `nix-command` experimental features by default (to disable, set `experimental-features` via `extra_nix_config`)
+
 ## Usage
 
 Create `.github/workflows/test.yml` in your repo with the following contents:
@@ -17,33 +33,96 @@ jobs:
   tests:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-    - uses: cachix/install-nix-action@v8
+    - uses: actions/checkout@v3
+    - uses: cachix/install-nix-action@v19
+      with:
+        nix_path: nixpkgs=channel:nixos-unstable
     - run: nix-build
 ```
 
+## Usage with Flakes
 
-See [action.yml](action.yml) for all options.
+```yaml
+name: "Test"
+on:
+  pull_request:
+  push:
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: cachix/install-nix-action@v19
+      with:
+        github_access_token: ${{ secrets.GITHUB_TOKEN }}
+    - run: nix build
+    - run: nix flake check
+```
 
-See also [cachix-action](https://github.com/cachix/cachix-action) for
-simple binary cache setup to speed up your builds and share binaries
-with developers.
+To install Nix from any commit, go to [the corresponding installer_test action](https://github.com/NixOS/nix/runs/2219534360) and click on "Run cachix/install-nix-action@XX" step and expand the first line.
+
+## Inputs (specify using `with:`)
+
+- `extra_nix_config`: append to `/etc/nix/nix.conf`
+
+- `github_access_token`: configure Nix to pull from GitHub using the given GitHub token. This helps work around rate limit issues. Has no effect when `access-tokens` is also specified in `extra_nix_config`.
+
+- `install_url`: specify URL to install Nix from (useful for testing non-stable releases or pinning Nix, for example https://releases.nixos.org/nix/nix-2.3.7/install)
+
+- `install_options`: additional installer flags passed to the installer script.
+
+- `nix_path`: set `NIX_PATH` environment variable, for example `nixpkgs=channel:nixos-unstable`
 
 ---
 
-## Hacking
+## FAQ
 
-Install the dependencies
-```bash
-$ yarn install
+### How do I print nixpkgs version I have configured?
+
+```yaml
+- name: Print nixpkgs version
+  run: nix-instantiate --eval -E '(import <nixpkgs> {}).lib.version'
 ```
 
-Build the typescript
-```bash
-$ yarn build
+### How can I run NixOS tests?
+
+With the following inputs:
+
+```yaml
+- uses: cachix/install-nix-action@vXX
+  with:
+    extra_nix_config: "system-features = nixos-test benchmark big-parallel kvm"
 ```
 
-Run the tests :heavy_check_mark:
-```bash
-$ yarn test
+[Note that there's no hardware acceleration on GitHub Actions.](https://github.com/actions/virtual-environments/issues/183#issuecomment-610723516).
+
+### How can I install packages via nix-env from the specified `nix_path`?
+
+```
+nix-env -i mypackage -f '<nixpkgs>'
+```
+
+### How do I add a binary cache?
+
+If the binary cache you want to add is hosted on [Cachix](https://cachix.org/) and you are
+using [cachix-action](https://github.com/cachix/cachix-action), you
+should use their `extraPullNames` input like this:
+
+```yaml
+- uses: cachix/cachix-action@vXX
+   with:
+     name: mycache
+     authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
+     extraPullNames: nix-community
+```
+
+Otherwise, you can add any binary cache to nix.conf using
+install-nix-action's own `extra_nix_config` input:
+
+```yaml
+- uses: cachix/install-nix-action@v19
+  with:
+    extra_nix_config: |
+      trusted-public-keys = hydra.iohk.io:f/Ea+s+dFdN+3Y/G+FDgSq+a5NEWhJGzdjvKNGv0/EQ= cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY=
+      substituters = https://hydra.iohk.io https://cache.nixos.org/
 ```

__tests__/main.test.ts

@@ -1,4 +0,0 @@
-test('nothing', async() => {
-});
-
-// TODO: hopefully github actions will support integration tests

action.yml

@@ -2,13 +2,28 @@ name: 'Install Nix'
 description: 'Installs Nix on GitHub Actions for the supported platforms: Linux and macOS.'
 author: 'Domen Kožar'
 inputs:
+  extra_nix_config:
+    description: 'Gets appended to `/etc/nix/nix.conf` if passed.'
+  github_access_token:
+    description: 'Configure nix to pull from github using the given github token.'
   install_url:
-    description: 'Installation URL that will contain a script to install Nix'
-  skip_adding_nixpkgs_channel:
-    description: 'Skip adding nixpkgs-unstable channel'
+    description: 'Installation URL that will contain a script to install Nix.'
+  install_options:
+    description: 'Additional installer flags passed to the installer script.'
+  nix_path:
+    description: 'Set NIX_PATH environment variable.'
 branding:
   color: 'blue'
   icon: 'sun'
 runs:
-  using: 'node12'
-  main: 'lib/main.js'
+  using: 'composite'
+  steps:
+    - run : ${{ github.action_path }}/install-nix.sh
+      shell: bash
+      env:
+        INPUT_EXTRA_NIX_CONFIG: ${{ inputs.extra_nix_config }}
+        INPUT_GITHUB_ACCESS_TOKEN: ${{ inputs.github_access_token }}
+        INPUT_INSTALL_OPTIONS: ${{ inputs.install_options }}
+        INPUT_INSTALL_URL: ${{ inputs.install_url }}
+        INPUT_NIX_PATH: ${{ inputs.nix_path }}
+        GITHUB_TOKEN: ${{ github.token }}

install-nix.sh

@@ -0,0 +1,98 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+if type -p nix &>/dev/null ; then
+  echo "Aborting: Nix is already installed at $(type -p nix)"
+  exit
+fi
+
+# GitHub command to put the following log messages into a group which is collapsed by default
+echo "::group::Installing Nix"
+
+# Create a temporary workdir
+workdir=$(mktemp -d)
+trap 'rm -rf "$workdir"' EXIT
+
+# Configure Nix
+add_config() {
+  echo "$1" | tee -a "$workdir/nix.conf" >/dev/null
+}
+# Set jobs to number of cores
+add_config "max-jobs = auto"
+# Allow binary caches for user
+add_config "trusted-users = root $USER"
+# Add github access token
+if [[ -n "${INPUT_GITHUB_ACCESS_TOKEN:-}" ]]; then
+  add_config "access-tokens = github.com=$INPUT_GITHUB_ACCESS_TOKEN"
+elif [[ -n "${GITHUB_TOKEN:-}" ]]; then
+  add_config "access-tokens = github.com=$GITHUB_TOKEN"
+fi
+# Append extra nix configuration if provided
+if [[ $INPUT_EXTRA_NIX_CONFIG != "" ]]; then
+  add_config "$INPUT_EXTRA_NIX_CONFIG"
+fi
+if [[ ! $INPUT_EXTRA_NIX_CONFIG =~ "experimental-features" ]]; then
+  add_config "experimental-features = nix-command flakes"
+fi
+
+# Nix installer flags
+installer_options=(
+  --no-channel-add
+  --darwin-use-unencrypted-nix-store-volume
+  --nix-extra-conf-file "$workdir/nix.conf"
+)
+
+# only use the nix-daemon settings if on darwin (which get ignored) or systemd is supported
+if [[ (! $INPUT_INSTALL_OPTIONS =~ "--no-daemon") && ($OSTYPE =~ darwin || -e /run/systemd/system) ]]; then
+  installer_options+=(
+    --daemon
+    --daemon-user-count "$(python3 -c 'import multiprocessing as mp; print(mp.cpu_count() * 2)')"
+  )
+else
+  # "fix" the following error when running nix*
+  # error: the group 'nixbld' specified in 'build-users-group' does not exist
+  add_config "build-users-group ="
+  sudo mkdir -p /etc/nix
+  sudo chmod 0755 /etc/nix
+  sudo cp $workdir/nix.conf /etc/nix/nix.conf
+fi
+
+if [[ $INPUT_INSTALL_OPTIONS != "" ]]; then
+  IFS=' ' read -r -a extra_installer_options <<< "$INPUT_INSTALL_OPTIONS"
+  installer_options=("${extra_installer_options[@]}" "${installer_options[@]}")
+fi
+
+echo "installer options: ${installer_options[*]}"
+
+# There is --retry-on-errors, but only newer curl versions support that
+curl_retries=5
+while ! curl -sS -o "$workdir/install" -v --fail -L "${INPUT_INSTALL_URL:-https://nixos.org/nix/install}"
+do
+  sleep 1
+  ((curl_retries--))
+  if [[ $curl_retries -le 0 ]]; then
+    echo "curl retries failed" >&2
+    exit 1
+  fi
+done
+
+sh "$workdir/install" "${installer_options[@]}"
+
+if [[ $OSTYPE =~ darwin ]]; then
+  # macOS needs certificates hints
+  cert_file=/nix/var/nix/profiles/default/etc/ssl/certs/ca-bundle.crt
+  echo "NIX_SSL_CERT_FILE=$cert_file" >> "$GITHUB_ENV"
+  export NIX_SSL_CERT_FILE=$cert_file
+  sudo launchctl setenv NIX_SSL_CERT_FILE "$cert_file"
+fi
+
+# Set paths
+echo "/nix/var/nix/profiles/default/bin" >> "$GITHUB_PATH"
+echo "/nix/var/nix/profiles/per-user/$USER/profile/bin" >> "$GITHUB_PATH"
+
+if [[ $INPUT_NIX_PATH != "" ]]; then
+  echo "NIX_PATH=${INPUT_NIX_PATH}" >> "$GITHUB_ENV"
+fi
+
+# Close the log message group which was opened above
+echo "::endgroup::"

jest.config.js

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

lib/README.md

@@ -1,5 +0,0 @@
-
-# Generated Code
-
-The files in this directory are generated.
-See [src](../src)

lib/create-darwin-volume.sh

@@ -1,102 +0,0 @@
-#!/usr/bin/env bash
-set -e
-
-root_disks() {
-    diskutil list -plist /
-}
-
-apfs_volumes_for() {
-    disk=$1
-    diskutil apfs list -plist "$disk"
-}
-
-disk_identifier() {
-    xpath "/plist/dict/key[text()='WholeDisks']/following-sibling::array[1]/string/text()" 2>/dev/null
-}
-
-volume_get() {
-    key=$1 i=$2
-    xpath "/plist/dict/array/dict/key[text()='Volumes']/following-sibling::array/dict[$i]/key[text()='$key']/following-sibling::string[1]/text()" 2> /dev/null
-}
-
-find_nix_volume() {
-    disk=$1
-    i=1
-    volumes=$(apfs_volumes_for "$disk")
-    while true; do
-        name=$(echo "$volumes" | volume_get "Name" "$i")
-        if [ -z "$name" ]; then
-            break
-        fi
-        case "$name" in
-            [Nn]ix*)
-                echo "$name"
-                break
-                ;;
-        esac
-        i=$((i+1))
-    done
-}
-
-test_fstab() {
-    grep -q "/nix" /etc/fstab 2>/dev/null
-}
-
-test_synthetic_conf() {
-    grep -q "^nix" /etc/synthetic.conf 2>/dev/null
-}
-
-test_nix() {
-    test -d "/nix"
-}
-
-main() {
-    (
-        echo ""
-        echo "     ------------------------------------------------------------------ "
-        echo "    | This installer will create a volume for the nix store and        |"
-        echo "    | configure it to mount at /nix.  Follow these steps to uninstall. |"
-        echo "     ------------------------------------------------------------------ "
-        echo ""
-        echo "  1. Remove the entry from fstab using 'sudo vifs'"
-        echo "  2. Destroy the data volume using 'diskutil apfs deleteVolume'"
-        echo "  3. Delete /etc/synthetic.conf"
-        echo ""
-    ) >&2
-
-    if [ -L "/nix" ]; then
-        echo "error: /nix is a symlink, please remove it or edit synthetic.conf (requires reboot)" >&2
-        echo "  /nix -> $(readlink "/nix")" >&2
-        exit 2
-    fi
-
-    if ! test_synthetic_conf; then
-        echo "Configuring /etc/synthetic.conf..." >&2
-        echo nix | sudo tee /etc/synthetic.conf
-        /System/Library/Filesystems/apfs.fs/Contents/Resources/apfs.util -B
-    fi
-
-    if ! test_nix; then
-        echo "Creating mountpoint for /nix..." >&2
-        sudo mkdir /nix
-    fi
-
-    disk=$(root_disks | disk_identifier)
-    volume=$(find_nix_volume "$disk")
-    if [ -z "$volume" ]; then
-        echo "Creating a Nix Store volume..." >&2
-        sudo diskutil apfs addVolume "$disk" APFS 'Nix Store' -mountpoint /nix
-        volume="Nix Store"
-    else
-        echo "Using existing '$volume' volume" >&2
-    fi
-
-    if ! test_fstab; then
-        echo "Configuring /etc/fstab..." >&2
-        label=$(echo "$volume" | sed 's/ /\\040/g')
-        printf "\$a\nLABEL=%s /nix apfs rw\n.\nwq\n" "$label" | EDITOR=ed sudo vifs
-        sudo defaults write /Library/Preferences/SystemConfiguration/autodiskmount AutomountDisksWithoutUserLogin -bool true
-    fi
-}
-
-main "$@"

lib/install-nix.sh

@@ -1,34 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-
-# Set jobs to number of cores
-sudo sh -c 'echo max-jobs = auto >> /tmp/nix.conf'
-# Allow binary caches for runner user
-sudo sh -c 'echo trusted-users = root runner >> /tmp/nix.conf'
-
-if [[ $INPUT_SKIP_ADDING_NIXPKGS_CHANNEL = "true" ]]; then
-  extra_cmd=--no-channel-add
-else
-  extra_cmd=
-fi
-
-sh <(curl -L ${INPUT_INSTALL_URL:-https://nixos.org/nix/install}) \
-  --daemon --daemon-user-count 4 --nix-extra-conf-file /tmp/nix.conf --darwin-use-unencrypted-nix-store-volume $extra_cmd
-
-if [[ $OSTYPE =~ darwin ]]; then
-  # Disable spotlight indexing of /nix to speed up performance
-  sudo mdutil -i off /nix
-
-  # macOS needs certificates hints
-  cert_file=/nix/var/nix/profiles/default/etc/ssl/certs/ca-bundle.crt
-  echo "::set-env name=NIX_SSL_CERT_FILE::$cert_file"
-  export NIX_SSL_CERT_FILE=$cert_file
-  sudo launchctl setenv NIX_SSL_CERT_FILE "$cert_file"
-fi
-
-# Set paths
-echo "::add-path::/nix/var/nix/profiles/per-user/runner/profile/bin"
-echo "::add-path::/nix/var/nix/profiles/default/bin"
-if [[ $INPUT_SKIP_ADDING_NIXPKGS_CHANNEL != "true" ]]; then
-echo "::set-env name=NIX_PATH::/nix/var/nix/profiles/per-user/root/channels"
-fi

lib/main.js

@@ -1,4 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const child_process_1 = require("child_process");
-child_process_1.execFileSync(`${__dirname}/install-nix.sh`, { stdio: 'inherit' });

package.json

@@ -1,36 +0,0 @@
-{
-  "name": "install-nix-action",
-  "version": "1.0.0",
-  "private": true,
-  "description": "Installs Nix on GitHub Actions for the supported platforms: Linux and macOS.",
-  "main": "lib/main.js",
-  "scripts": {
-    "build": "tsc",
-    "test": "jest"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/cachix/install-nix-action.git"
-  },
-  "keywords": [
-    "actions",
-    "node",
-    "setup"
-  ],
-  "author": "Domen Kožar",
-  "license": "ASL2",
-  "dependencies": {
-    "@actions/core": "^1.1.0",
-    "@actions/exec": "^1.0.1",
-    "@actions/tool-cache": "^1.1.2"
-  },
-  "devDependencies": {
-    "ts-node": "^8.4.1",
-    "@types/jest": "^24.0.13",
-    "@types/node": "^12.0.4",
-    "jest": "^24.8.0",
-    "jest-circus": "^24.7.1",
-    "ts-jest": "^24.0.2",
-    "typescript": "^3.5.1"
-  }
-}

shell.nix

@@ -1,8 +0,0 @@
-{ pkgs ? import <nixpkgs> {}
-}:
-
-pkgs.mkShell {
-  name = "install-nix-action-shell";
-
-  buildInputs = [ pkgs.yarn ];
-}

src/main.ts

@@ -1,3 +0,0 @@
-import { execFileSync } from 'child_process';
-
-execFileSync(`${__dirname}/install-nix.sh`, { stdio: 'inherit' });

test.nix

@@ -2,14 +2,17 @@
 { size ? 1 # MB
 , num ? 10 # count 
 , currentTime ? builtins.currentTime
+, noChroot ? false
 }:
 
 with import <nixpkgs> {};
 
 let
-  drv = i: runCommand "${toString currentTime}-${toString i}" {} ''
+  drv = i: runCommand "${toString currentTime}-${toString i}" {
+    __noChroot = noChroot;
+  } ''
     dd if=/dev/zero of=$out bs=${toString size}MB count=1
   '';
 in writeText "empty-${toString num}-${toString size}MB" ''
   ${lib.concatMapStringsSep "" drv (lib.range 1 num)}
-''
+''

tsconfig.json

@@ -1,63 +0,0 @@
-{
-  "compilerOptions": {
-    /* Basic Options */
-    // "incremental": true,                   /* Enable incremental compilation */
-    "target": "es6",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
-    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
-    // "allowJs": true,                       /* Allow javascript files to be compiled. */
-    // "checkJs": true,                       /* Report errors in .js files. */
-    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
-    // "declaration": true,                   /* Generates corresponding '.d.ts' file. */
-    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
-    // "sourceMap": true,                     /* Generates corresponding '.map' file. */
-    // "outFile": "./",                       /* Concatenate and emit output to single file. */
-    "outDir": "./lib",                        /* Redirect output structure to the directory. */
-    "rootDir": "./src",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
-    // "composite": true,                     /* Enable project compilation */
-    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
-    // "removeComments": true,                /* Do not emit comments to output. */
-    // "noEmit": true,                        /* Do not emit outputs. */
-    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
-    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
-    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
-
-    /* Strict Type-Checking Options */
-    "strict": true,                           /* Enable all strict type-checking options. */
-    "noImplicitAny": false,                 /* Raise error on expressions and declarations with an implied 'any' type. */
-    // "strictNullChecks": true,              /* Enable strict null checks. */
-    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
-    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
-    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
-    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
-    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
-
-    /* Additional Checks */
-    // "noUnusedLocals": true,                /* Report errors on unused locals. */
-    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
-    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
-    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
-
-    /* Module Resolution Options */
-    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
-    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
-    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
-    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
-    // "typeRoots": [],                       /* List of folders to include type definitions from. */
-    // "types": [],                           /* Type declaration files to be included in compilation. */
-    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
-    "esModuleInterop": true                   /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
-    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
-    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */
-
-    /* Source Map Options */
-    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
-    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
-    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
-    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
-
-    /* Experimental Options */
-    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
-    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
-  },
-  "exclude": ["node_modules", "**/*.test.ts"]
-}