comments

.editorconfig

@@ -1,15 +0,0 @@
-# EditorConfig is awesome: https://EditorConfig.org
-
-# top-most EditorConfig file
-root = true
-
-# Unix-style newlines with a newline ending every file
-[*]
-charset = utf-8
-end_of_line = lf
-indent_size = 2
-indent_style = space
-insert_final_newline = true
-
-[LICENSE]
-indent_size = unset

.github/workflows/test.yml

@@ -12,23 +12,28 @@ jobs:
         os: [ubuntu-latest, macos-latest]
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v2.3.4
+    - run: yarn install --frozen-lockfile
+    - run: yarn build
     - name: Install Nix
       uses: ./
       with:
-        nix_path: nixpkgs=channel:nixos-22.11
+        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
+
   custom-nix-path:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest]
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v2.3.4
+    - run: yarn install --frozen-lockfile
+    - run: yarn build
     - name: Install Nix
       uses: ./
       with:
@@ -42,11 +47,13 @@ jobs:
         os: [ubuntu-latest, macos-latest]
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v2.3.4
+    - run: yarn install --frozen-lockfile
+    - run: yarn build
     - name: Install Nix
       uses: ./
       with: 
-        nix_path: nixpkgs=channel:nixos-22.11
+        nix_path: nixpkgs=channel:nixos-20.03
         extra_nix_config: |
           sandbox = relaxed
     - run: cat /etc/nix/nix.conf
@@ -58,9 +65,17 @@ jobs:
         os: [ubuntu-latest, macos-latest]
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v2.3.4
+    - run: yarn install --frozen-lockfile
+    - run: yarn build
     - name: Install Nix
       uses: ./
+      with:
+        install_url: https://nixos-nix-install-tests.cachix.org/serve/i6laym9jw3wg9mw6ncyrk6gjx4l34vvx/install
+        install_options: '--tarball-url-prefix https://nixos-nix-install-tests.cachix.org/serve'
+        extra_nix_config: |
+          experimental-features = nix-command flakes
+          access-tokens = github.com=${{ secrets.GITHUB_TOKEN }}
     - run: nix flake show github:NixOS/nixpkgs
 
   installer-options:
@@ -69,36 +84,13 @@ jobs:
         os: [ubuntu-latest, macos-latest]
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v2
+    - run: yarn install --frozen-lockfile
+    - run: yarn build
     - name: Install Nix
       uses: ./
       with: 
-        nix_path: nixpkgs=channel:nixos-22.11
-        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
+        nix_path: nixpkgs=channel:nixos-21.05
+        install_url: https://nixos-nix-install-tests.cachix.org/serve/i6laym9jw3wg9mw6ncyrk6gjx4l34vvx/install
+        install_options: '--tarball-url-prefix https://nixos-nix-install-tests.cachix.org/serve'
     - run: nix-build test.nix
-
-  oldest-supported-installer:
-    strategy:
-        matrix:
-          os: [ubuntu-latest, macos-latest]
-    runs-on: ${{ matrix.os }}
-    steps:
-    - uses: actions/checkout@v4
-    - name: Install Nix
-      uses: ./
-      with:
-        nix_path: nixpkgs=channel:nixos-22.11
-        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@v4
-    - 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,24 +1,23 @@
 # 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)
-(see also [pinning tutorial](https://nix.dev/tutorials/towards-reproducibility-pinning-nixpkgs)).
+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`
+- [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`
+- Allows specifying extra Nix configration 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
 
@@ -33,13 +32,14 @@ jobs:
   tests:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
-    - uses: cachix/install-nix-action@v22
+    - uses: actions/checkout@v2.3.4
+    - uses: cachix/install-nix-action@v13
       with:
         nix_path: nixpkgs=channel:nixos-unstable
     - run: nix-build
 ```
 
+
 ## Usage with Flakes
 
 ```yaml
@@ -51,10 +51,14 @@ jobs:
   tests:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
-    - uses: cachix/install-nix-action@v22
+    - uses: actions/checkout@v2.3.4
+    - uses: cachix/install-nix-action@v14
       with:
-        github_access_token: ${{ secrets.GITHUB_TOKEN }}
+        install_url: https://nixos-nix-install-tests.cachix.org/serve/vij683ly7sl95nnhb67bdjjfabclr85m/install
+        install_options: '--tarball-url-prefix https://nixos-nix-install-tests.cachix.org/serve'
+        extra_nix_config: |
+          experimental-features = nix-command flakes
+          access-tokens = github.com=${{ secrets.GITHUB_TOKEN }}
     - run: nix build
     - run: nix flake check
 ```
@@ -63,28 +67,25 @@ To install Nix from any commit, go to [the corresponding installer_test action](
 
 ## 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.
+- `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)
 
 - `nix_path`: set `NIX_PATH` environment variable, for example `nixpkgs=channel:nixos-unstable`
 
+- `extra_nix_config`: append to `/etc/nix/nix.conf`
+
 ---
 
 ## FAQ
 
 ### How do I print nixpkgs version I have configured?
 
+
 ```yaml
 - name: Print nixpkgs version
   run: nix-instantiate --eval -E '(import <nixpkgs> {}).lib.version'
 ```
 
-### How do I run NixOS tests?
+### How can I run NixOS tests?
 
 With the following inputs:
 
@@ -96,7 +97,7 @@ With the following inputs:
 
 [Note that there's no hardware acceleration on GitHub Actions.](https://github.com/actions/virtual-environments/issues/183#issuecomment-610723516).
 
-### How do I install packages via nix-env from the specified `nix_path`?
+### How can I install packages via nix-env from the specified `nix_path`?
 
 ```
 nix-env -i mypackage -f '<nixpkgs>'
@@ -120,29 +121,26 @@ 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@v22
+- uses: cachix/install-nix-action@vXX
   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/
 ```
 
-### How do I pass environment variables to commands run with `nix develop` or `nix shell`?
+## Hacking
 
-Nix runs commands in a restricted environment by default, called `pure mode`.
-In pure mode, environment variables are not passed through to improve the reproducibility of the shell.
-
-You can use the `--keep / -k` flag to keep certain environment variables:
-
-```yaml
-- name: Run a command with nix develop
-  run: nix develop --ignore-environment --keep MY_ENV_VAR --command echo $MY_ENV_VAR
-  env:
-    MY_ENV_VAR: "hello world"
+Install the dependencies
+```bash
+$ yarn install
 ```
 
-Or you can disable pure mode entirely with the `--impure` flag:
+Build the typescript
+```bash
+$ yarn build
+```
 
-```
-nix develop --impure
+Run the tests :heavy_check_mark:
+```bash
+$ yarn test
 ```

__tests__/main.test.ts

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

action.yml

@@ -2,28 +2,17 @@ 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.'
   install_options:
     description: 'Additional installer flags passed to the installer script.'
   nix_path:
     description: 'Set NIX_PATH environment variable.'
+  extra_nix_config:
+    description: 'gets appended to `/etc/nix/nix.conf` if passed.'
 branding:
   color: 'blue'
   icon: 'sun'
 runs:
-  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 }}
+  using: 'node12'
+  main: 'lib/main.js'

install-nix.sh

@@ -1,100 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-
-if nix_path="$(type -p nix)" ; then
-  echo "Aborting: Nix is already installed at ${nix_path}"
-  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" >> "$workdir/nix.conf"
-}
-add_config "show-trace = true"
-# Set jobs to number of cores
-add_config "max-jobs = auto"
-if [[ $OSTYPE =~ darwin ]]; then
-  add_config "ssl-cert-file = /etc/ssl/cert.pem"
-fi
-# 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 [[ -n "${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 [[ -n "${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://releases.nixos.org/nix/nix-2.17.0/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[@]}"
-
-# Set paths
-echo "/nix/var/nix/profiles/default/bin" >> "$GITHUB_PATH"
-# new path for nix 2.14
-echo "$HOME/.nix-profile/bin" >> "$GITHUB_PATH"
-
-if [[ -n "${INPUT_NIX_PATH:-}" ]]; then
-  echo "NIX_PATH=${INPUT_NIX_PATH}" >> "$GITHUB_ENV"
-fi
-
-# Set temporary directory (if not already set) to fix https://github.com/cachix/install-nix-action/issues/197
-if [[ -z "${TMPDIR:-}" ]]; then
-  echo "TMPDIR=${RUNNER_TEMP}" >> "$GITHUB_ENV"
-fi
-
-# Close the log message group which was opened above
-echo "::endgroup::"

jest.config.js

@@ -0,0 +1,11 @@
+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

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

lib/install-nix.sh

@@ -0,0 +1,68 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+# Set paths early (ephemeral self-hosted runners might reuse a runner)
+PATH="/nix/var/nix/profiles/per-user/$USER/profile/bin":"/nix/var/nix/profiles/default/bin":$PATH
+
+if type -p nix &>/dev/null ; then
+  echo "Aborting: Nix is already installed at $(type -p nix)"
+  exit
+fi
+
+# Configure Nix
+add_config() {
+  echo "$1" | tee -a /tmp/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"
+# Append extra nix configuration if provided
+if [[ $INPUT_EXTRA_NIX_CONFIG != "" ]]; then
+  add_config "$INPUT_EXTRA_NIX_CONFIG"
+fi
+
+# Nix installer flags
+installer_options=(
+  --no-channel-add
+  --darwin-use-unencrypted-nix-store-volume
+  --nix-extra-conf-file /tmp/nix.conf
+)
+
+# only use the nix-daemon settings if on darwin (which get ignored) or systemd is supported
+if [[ $OSTYPE =~ darwin || -e /run/systemd/system ]]; then
+  installer_options+=(
+    --daemon
+    --daemon-user-count `python -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
+  mkdir -m 0755 /etc/nix
+  echo "build-users-group =" > /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[@]}"
+sh <(curl --retry 5 --retry-connrefused -L "${INPUT_INSTALL_URL:-https://nixos.org/nix/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/per-user/$USER/profile/bin" >> "$GITHUB_PATH"
+echo "/nix/var/nix/profiles/default/bin" >> "$GITHUB_PATH"
+
+
+if [[ $INPUT_NIX_PATH != "" ]]; then
+  echo "NIX_PATH=${INPUT_NIX_PATH}" >> "$GITHUB_ENV"
+fi

lib/main.js

@@ -0,0 +1,4 @@
+"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

@@ -0,0 +1,36 @@
+{
+  "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.2.6",
+    "@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

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

src/main.ts

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

tsconfig.json

@@ -0,0 +1,63 @@
+{
+  "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"]
+}