deps: update

* deps: Compile deps into single file with ncc
* ci: update husky setting

Close #67

.dependabot/config.yml

@@ -0,0 +1,9 @@
+version: 1
+update_configs:
+  - package_manager: "javascript"
+    directory: "/"
+    update_schedule: "weekly"
+    default_labels:
+      - "dependencies"
+    commit_message:
+      prefix: "deps"

.dockerignore

@@ -1,5 +0,0 @@
-.git
-.github
-LICENSE
-README.md
-images

.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true

.envrc

@@ -0,0 +1,3 @@
+nvmrc=~/.nvm/nvm.sh
+source $nvmrc
+nvm use

.eslintrc.json

@@ -0,0 +1,19 @@
+{
+  "env": {
+    "commonjs": true,
+    "es6": true,
+    "node": true
+  },
+  "extends": "eslint:recommended",
+  "globals": {
+    "Atomics": "readonly",
+    "SharedArrayBuffer": "readonly"
+  },
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "sourceType": "module",
+    "ecmaVersion": 2019
+  },
+  "rules": {
+  }
+}

.github/CODEOWNERS

@@ -0,0 +1,3 @@
+# https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners
+
+* @peaceiris

.github/FUNDING.yml

@@ -1,8 +0,0 @@
-# These are supported funding model platforms
-
-github: peaceiris
-patreon: peaceiris
-open_collective: # Replace with a single Open Collective username
-ko_fi: # Replace with a single Ko-fi username
-tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
-custom: # Replace with a single custom sponsorship URL

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,31 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: 'Bug: This is a sample issue title'
+labels: bug
+assignees: peaceiris
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Your YAML file**
+- A link to your repository
+- A link to your YAML file
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: GitHub Actions Community Forum
+    url: https://github.community/t5/GitHub-Actions/bd-p/actions
+    about: Please ask questions about GitHub Actions here.
+  - name: Hugo Community Forum
+    url: https://discourse.gohugo.io/
+    about: Please ask questions about Hugo here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: 'feat: This is a sample title'
+labels: request
+assignees: peaceiris
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/main.workflow

@@ -1,9 +0,0 @@
-workflow "Main workflow" {
-  on = "push"
-  resolves = ["docker-build"]
-}
-
-action "docker-build" {
-  uses = "actions/docker/cli@master"
-  args = "build -t peaceiris/actions-hugo ."
-}

.github/workflows/test.yml

@@ -0,0 +1,73 @@
+name: 'Test'
+
+on:
+  pull_request:
+    types: [opened, synchronize]
+    paths-ignore:
+    - '**.md'
+  push:
+    paths-ignore:
+    - '**.md'
+    branches:
+    - master
+
+jobs:
+  test:
+    runs-on: ubuntu-18.04
+
+    steps:
+    - uses: actions/checkout@v1
+      with:
+        fetch-depth: 1
+
+    - name: Read .nvmrc
+      run: echo ::set-output name=NVMRC::$(cat .nvmrc)
+      id: nvm
+
+    - name: Setup Node
+      uses: actions/setup-node@v1
+      with:
+        node-version: '${{ steps.nvm.outputs.NVMRC }}'
+
+    - name: Cache
+      uses: actions/cache@v1.0.1
+      with:
+        path: ~/.npm
+        key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+        restore-keys: |
+          ${{ runner.os }}-node-
+
+    - run: npm ci
+
+    - run: npm run format:check
+
+    - run: npm run lint
+
+    - run: npm test
+
+    - name: Upload test coverage
+      uses: actions/upload-artifact@master
+      with:
+        name: coverage
+        path: coverage
+
+
+  test-prod:
+    runs-on: ${{ matrix.os }}
+    needs: test
+    strategy:
+      matrix:
+        os: ['ubuntu-18.04', 'macos-latest', 'windows-latest']
+        hugo-version: ['latest', '0.57.2']
+        extended: [true, false]
+
+    steps:
+    - uses: actions/checkout@v1
+      with:
+        fetch-depth: 1
+
+    - name: Test action
+      uses: ./
+      with:
+        hugo-version: ${{ matrix.hugo-version }}
+        extended: ${{ matrix.extended }}

.gitignore

@@ -0,0 +1,5 @@
+coverage
+.npm
+.eslintcache
+.env
+node_modules

.nvmrc

@@ -0,0 +1 @@
+12.13.0

.prettierrc.json

@@ -0,0 +1,11 @@
+{
+    "printWidth": 80,
+    "tabWidth": 2,
+    "useTabs": false,
+    "semi": true,
+    "singleQuote": true,
+    "trailingComma": "none",
+    "bracketSpacing": false,
+    "arrowParens": "avoid",
+    "parser": "typescript"
+  }

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "git.ignoreLimitWarning": true
+}

Dockerfile

@@ -1,27 +0,0 @@
-FROM debian:9-slim
-
-LABEL "com.github.actions.name"="Hugo extended action"
-LABEL "com.github.actions.description"="GitHub Actions for Hugo extended version"
-LABEL "com.github.actions.icon"="package"
-LABEL "com.github.actions.color"="yellow"
-
-LABEL "repository"="https://github.com/peaceiris/actions-hugo"
-LABEL "homepage"="https://github.com/peaceiris/actions-hugo"
-LABEL "maintainer"="peaceiris"
-
-ENV HUGO_VERSION='0.56.0'
-ENV HUGO_NAME="hugo_extended_${HUGO_VERSION}_Linux-64bit"
-ENV HUGO_URL="https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/${HUGO_NAME}.deb"
-ENV BUILD_DEPS="wget ca-certificates"
-
-RUN apt-get update && \
-    apt-get install -y --no-install-recommends git ${BUILD_DEPS} && \
-    wget "${HUGO_URL}" && \
-    apt-get install -y --no-install-recommends "./${HUGO_NAME}.deb" && \
-    rm -rf "./${HUGO_NAME}.deb" "${HUGO_NAME}" && \
-    apt-get remove -y ${BUILD_DEPS} && \
-    apt-get autoremove -y && \
-    apt-get clean && \
-    rm -rf /var/lib/apt/lists/*
-
-ENTRYPOINT [ "/usr/local/bin/hugo" ]

README.md

@@ -1,61 +1,125 @@
 [![license](https://img.shields.io/github/license/peaceiris/actions-hugo.svg)](https://github.com/peaceiris/actions-hugo/blob/master/LICENSE)
 [![release](https://img.shields.io/github/release/peaceiris/actions-hugo.svg)](https://github.com/peaceiris/actions-hugo/releases/latest)
 [![GitHub release date](https://img.shields.io/github/release-date/peaceiris/actions-hugo.svg)](https://github.com/peaceiris/actions-hugo/releases)
+![GitHub Actions status](https://github.com/peaceiris/actions-hugo/workflows/Test/badge.svg)
+[![CodeFactor](https://www.codefactor.io/repository/github/peaceiris/actions-hugo/badge)](https://www.codefactor.io/repository/github/peaceiris/actions-hugo)
 
-<img width="400" alt="GitHub Actions for Hugo extended" src="./images/ogp.svg">
+<img width="400" alt="GitHub Actions for Hugo" src="./images/ogp.svg">
 
 
 
-## GitHub Actions for Hugo extended
+## GitHub Actions for Hugo extended and Modules
 
 - [gohugoio/hugo: The world’s fastest framework for building websites.](https://github.com/gohugoio/hugo)
 
+We can run Hugo on a virtual machine of GitHub Actions by this Hugo action. Hugo extended version and Hugo Modules are supported.
+
+From `v2.0.0`, this Hugo action migrated to a JavaScript (TypeScript)  action. We no longer build or pull a Hugo docker image. Thanks to this change, we can complete this action less than **4 sec**. (A docker base action was taking about 1 min or more execution time to build or pull.)
+
+| OS (runs-on) | ubuntu-18.04 | macos-latest | windows-2019 |
+|---|:---:|:---:|:---:|
+| Support | ✅️ | ✅️ | ✅️ |
+
+| Hugo type | Hugo Extended | Hugo Modules | Latest Hugo |
+|---|:---:|:---:|:---:|
+| Support | ✅️ | ✅️ | ✅️ |
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+*Table of Contents*
+
+- [Getting started](#getting-started)
+  - [⭐️ Create your workflow](#%EF%B8%8F-create-your-workflow)
+- [Options](#options)
+  - [⭐️ Use Hugo extended](#%EF%B8%8F-use-hugo-extended)
+  - [⭐️ Use the latest version of Hugo](#%EF%B8%8F-use-the-latest-version-of-hugo)
+- [License](#license)
+- [About the author](#about-the-author)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 
 
 ## Getting started
 
-### Create `main.workflow`
+### ⭐️ Create your workflow
 
-An example with [GitHub Actions for deploying to GitHub Pages with Static Site Generators]
+An example workflow `.github/workflows/gh-pages.yml` with [GitHub Actions for GitHub Pages]
 
-[GitHub Actions for deploying to GitHub Pages with Static Site Generators]: https://github.com/peaceiris/actions-gh-pages
+[GitHub Actions for GitHub Pages]: https://github.com/peaceiris/actions-gh-pages
+
+[![peaceiris/actions-gh-pages - GitHub](https://gh-card.dev/repos/peaceiris/actions-gh-pages.svg?fullname)](https://github.com/peaceiris/actions-gh-pages)
 
 ![peaceiris/actions-hugo latest version](https://img.shields.io/github/release/peaceiris/actions-hugo.svg?label=peaceiris%2Factions-hugo)
 ![peaceiris/actions-gh-pages latest version](https://img.shields.io/github/release/peaceiris/actions-gh-pages.svg?label=peaceiris%2Factions-gh-pages)
 
-```hcl
-workflow "GitHub Pages" {
-  on = "push"
-  resolves = ["deploy"]
-}
+```yaml
+name: github pages
 
-action "is-branch-master" {
-  uses = "actions/bin/filter@master"
-  args = "branch master"
-}
+on:
+  push:
+    branches:
+    - master
 
-action "build" {
-  needs = "is-branch-master"
-  uses = "peaceiris/actions-hugo@v0.56.0"
-  args = ["--gc", "--minify", "--cleanDestinationDir"]
-}
+jobs:
+  build-deploy:
+    runs-on: ubuntu-18.04
+    steps:
+    - uses: actions/checkout@master
+      # with:
+      #   submodules: true
 
-action "deploy" {
-  needs = "build"
-  uses = "peaceiris/actions-gh-pages@v1.0.1"
-  env = {
-    PUBLISH_DIR = "./public"
-    PUBLISH_BRANCH = "gh-pages"
-  }
-  secrets = ["ACTIONS_DEPLOY_KEY"]
-}
+    - name: Setup Hugo
+      uses: peaceiris/actions-hugo@v2.2.2
+      with:
+        hugo-version: '0.58.3'
+        # extended: true
+
+    - name: Build
+      run: hugo --minify
+
+    - name: Deploy
+      uses: peaceiris/actions-gh-pages@v2.5.0
+      env:
+        ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+        PUBLISH_BRANCH: gh-pages
+        PUBLISH_DIR: ./public
 ```
 
 
 
+## Options
+
+### ⭐️ Use Hugo extended
+
+Set `extended: true` to use a Hugo extended version.
+
+```yaml
+- name: Setup Hugo
+  uses: peaceiris/actions-hugo@v2.2.2
+  with:
+    hugo-version: '0.58.3'
+    extended: true
+```
+
+### ⭐️ Use the latest version of Hugo
+
+Set `hugo-version: 'latest'` to use the latest version of Hugo.
+
+```yaml
+- name: Setup Hugo
+  uses: peaceiris/actions-hugo@v2.2.2
+  with:
+    hugo-version: 'latest'
+```
+
+This action fetches the latest version of Hugo by [hugo | Homebrew Formulae](https://formulae.brew.sh/formula/hugo)
+
+
+
 ## License
 
-[MIT License - peaceiris/actions-hugo]
+- [MIT License - peaceiris/actions-hugo]
 
 [MIT License - peaceiris/actions-hugo]: https://github.com/peaceiris/actions-hugo/blob/master/LICENSE
 
@@ -64,5 +128,3 @@ action "deploy" {
 ## About the author
 
 - [peaceiris's homepage](https://peaceiris.com/)
-
-<a href="https://www.patreon.com/peaceiris"><img src="./images/patreon.jpg" alt="peaceiris - Patreon" width="150px"></a>

__tests__/get-os.test.ts

@@ -0,0 +1,18 @@
+import getOS from '../src/get-os';
+
+describe('getOS', () => {
+  test('test', () => {
+    expect(getOS('linux')).toBe('Linux');
+    expect(getOS('darwin')).toBe('macOS');
+    expect(getOS('win32')).toBe('Windows');
+  });
+
+  test('test exception', () => {
+    // expect(() => {
+    //   getOS("win32");
+    // }).toThrowError("Windows is not supported");
+    expect(() => {
+      getOS('centos');
+    }).toThrowError('centos is not supported');
+  });
+});

__tests__/get-url.test.ts

@@ -0,0 +1,22 @@
+import getURL from '../src/get-url';
+
+describe('getURL()', () => {
+  test('test', () => {
+    const baseURL =
+      'https://github.com/gohugoio/hugo/releases/download/v0.58.2';
+    const urlLinux = `${baseURL}/hugo_0.58.2_Linux-64bit.tar.gz`;
+    const urlLinuxExtended = `${baseURL}/hugo_extended_0.58.2_Linux-64bit.tar.gz`;
+    const urlMacOS = `${baseURL}/hugo_0.58.2_macOS-64bit.tar.gz`;
+    const urlWindows = `${baseURL}/hugo_0.58.2_Windows-64bit.zip`;
+    expect(getURL('Linux', 'false', '0.58.2')).toBe(urlLinux);
+    expect(getURL('Linux', 'true', '0.58.2')).toBe(urlLinuxExtended);
+    expect(getURL('macOS', 'false', '0.58.2')).toBe(urlMacOS);
+    expect(getURL('Windows', 'false', '0.58.2')).toBe(urlWindows);
+  });
+
+  // test("test exception", () => {
+  //   expect(() => {
+  //     getURL("Linux", "hoge", "0.58.2");
+  //   }).toThrowError("Invalid input (extended): hoge");
+  // });
+});

action.yml

@@ -0,0 +1,18 @@
+name: 'Hugo setup'
+description: 'GitHub Actions for Hugo ⚡️ Setup Hugo quickly and build your site fast. Hugo extended and Hugo Modules are supported.'
+author: 'peaceiris'
+inputs:
+  hugo-version:
+    description: 'The Hugo version to download (if necessary) and use. Example: 0.58.2'
+    required: false
+    default: 'latest'
+  extended:
+    description: 'Download (if necessary) and use Hugo extended version. Example: true'
+    required: false
+    default: 'false'
+runs:
+  using: 'node12'
+  main: 'lib/index.js'
+branding:
+  icon: 'package'
+  color: 'yellow'

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
+}

package.json

@@ -0,0 +1,69 @@
+{
+  "name": "hugo-action",
+  "version": "2.2.0",
+  "description": "Hugo setup action",
+  "main": "lib/index.js",
+  "scripts": {
+    "lint": "eslint ./src/**/*.ts",
+    "lint:fix": "eslint --fix ./src/**/*.ts",
+    "test": "jest --coverage --verbose",
+    "build": "ncc build ./src/index.ts -o lib",
+    "tsc": "tsc",
+    "format": "prettier --write **/*.ts",
+    "format:check": "prettier --check **/*.ts"
+  },
+  "husky": {
+    "skipCI": true,
+    "hooks": {
+      "pre-commit": "lint-staged",
+      "post-commit": "npm run build && echo '⚠️ Do not forget to Commit and Push ./lib/index.js'"
+    }
+  },
+  "lint-staged": {
+    "src/**/*.ts": [
+      "prettier --check",
+      "eslint",
+      "jest --bail --findRelatedTests",
+      "git add"
+    ]
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/peaceiris/actions-hugo.git"
+  },
+  "keywords": [
+    "GitHub",
+    "Actions",
+    "JavaScript",
+    "TypeScript",
+    "Hugo",
+    "Setup"
+  ],
+  "author": "peaceiris",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/peaceiris/actions-hugo/issues"
+  },
+  "homepage": "https://github.com/peaceiris/actions-hugo#readme",
+  "dependencies": {
+    "@actions/core": "^1.2.0",
+    "@actions/exec": "^1.0.1",
+    "@actions/io": "^1.0.1",
+    "@actions/tool-cache": "^1.1.2",
+    "xmlhttprequest": "^1.8.0"
+  },
+  "devDependencies": {
+    "@types/jest": "^24.0.23",
+    "@types/node": "^12.12.8",
+    "@typescript-eslint/parser": "^2.7.0",
+    "@zeit/ncc": "^0.20.5",
+    "eslint": "^6.6.0",
+    "husky": "^3.0.9",
+    "jest": "^24.9.0",
+    "jest-circus": "^24.9.0",
+    "lint-staged": "^9.4.3",
+    "prettier": "1.19.1",
+    "ts-jest": "^24.1.0",
+    "typescript": "^3.7.2"
+  }
+}

src/get-latest-version.ts

@@ -0,0 +1,19 @@
+const XMLHttpRequest = require('xmlhttprequest').XMLHttpRequest;
+
+export default function getLatestVersion(): Promise<string> {
+  return new Promise((resolve, reject) => {
+    const xhr = new XMLHttpRequest();
+    const url: string = 'https://formulae.brew.sh/api/formula/hugo.json';
+    xhr.open('GET', url);
+    xhr.send();
+    xhr.onreadystatechange = function() {
+      if (xhr.readyState === 4 && xhr.status === 200) {
+        const result = JSON.parse(xhr.responseText);
+        const latestVersion: string = result.versions.stable;
+        resolve(latestVersion);
+      } else if (xhr.readyState === 4 && xhr.status !== 200) {
+        reject(`ERROR: got status ${xhr.status} of ${url}`);
+      }
+    };
+  });
+}

src/get-os.ts

@@ -0,0 +1,12 @@
+export default function getOS(platform: string) {
+  if (platform === 'linux') {
+    return 'Linux';
+  } else if (platform === 'darwin') {
+    return 'macOS';
+  } else if (platform === 'win32') {
+    return 'Windows';
+    // throw new Error("Windows is not supported");
+  } else {
+    throw new Error(`${platform} is not supported`);
+  }
+}

src/get-url.ts

@@ -0,0 +1,31 @@
+export default function getURL(
+  os: string,
+  extended: string,
+  version: string
+): string {
+  const extendedStr = (extended: string) => {
+    if (extended === 'true') {
+      return 'extended_';
+    } else {
+      return '';
+      // } else {
+      //   throw new Error(`Invalid input (extended): ${extended}`);
+    }
+  };
+
+  const ext = (os: string) => {
+    if (os === 'Windows') {
+      return 'zip';
+    } else {
+      return 'tar.gz';
+    }
+  };
+
+  const hugoName: string = `hugo_${extendedStr(
+    extended
+  )}${version}_${os}-64bit`;
+  const baseURL: string = 'https://github.com/gohugoio/hugo/releases/download';
+  const url: string = `${baseURL}/v${version}/${hugoName}.${ext(os)}`;
+
+  return url;
+}

src/index.ts

@@ -0,0 +1,37 @@
+import * as core from '@actions/core';
+import * as exec from '@actions/exec';
+import getLatestVersion from './get-latest-version';
+import installer from './installer';
+
+// most @actions toolkit packages have async methods
+async function run() {
+  const dump = async () => {
+    // Show version
+    await exec.exec('hugo version');
+  };
+
+  try {
+    const hugoVersion: string = core.getInput('hugo-version');
+
+    if (hugoVersion === '' || hugoVersion === 'latest') {
+      getLatestVersion().then(
+        async function(latestVersion): Promise<void> {
+          console.log(`Hugo version: ${latestVersion} (${hugoVersion})`);
+          await installer(latestVersion);
+          await dump();
+        },
+        function(error) {
+          core.setFailed(error);
+        }
+      );
+    } else {
+      console.log(`Hugo version: ${hugoVersion}`);
+      await installer(hugoVersion);
+      await dump();
+    }
+  } catch (error) {
+    core.setFailed(error.message);
+  }
+}
+
+run();

src/installer.ts

@@ -0,0 +1,42 @@
+import * as core from '@actions/core';
+import * as tc from '@actions/tool-cache';
+import * as io from '@actions/io';
+import getOS from './get-os';
+import getURL from './get-url';
+
+export default async function installer(version: string) {
+  try {
+    const extended: string = core.getInput('extended');
+    console.log(`Hugo extended: ${extended}`);
+
+    const osName: string = getOS(process.platform);
+    console.log(`Operating System: ${osName}`);
+
+    const hugoURL: string = getURL(osName, extended, version);
+    core.debug(`hugoURL: ${hugoURL}`);
+
+    const hugoPath: string = `${process.env.HOME}/bin`;
+    await io.mkdirP(hugoPath);
+    core.addPath(hugoPath);
+
+    // Download and extract Hugo binary
+    const hugoAssets: string = await tc.downloadTool(hugoURL);
+    let hugoBin: string = '';
+    if (osName === 'Windows') {
+      const hugoExtractedFolder: string = await tc.extractZip(
+        hugoAssets,
+        '/tmp'
+      );
+      hugoBin = `${hugoExtractedFolder}/hugo.exe`;
+    } else {
+      const hugoExtractedFolder: string = await tc.extractTar(
+        hugoAssets,
+        '/tmp'
+      );
+      hugoBin = `${hugoExtractedFolder}/hugo`;
+    }
+    await io.mv(hugoBin, hugoPath);
+  } catch (error) {
+    core.setFailed(error.message);
+  }
+}

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": true,                    /* 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"]
+}