chore: Merge pull request #78 from eventOneHQ/develop

v2 Beta 1

.eslintrc.json

@@ -1,3 +1,14 @@
 {
-    "extends": "standard"
-}
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "plugins": ["@typescript-eslint"],
+  "extends": [
+    "eslint:recommended",
+    "standard",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "rules": {
+    "@typescript-eslint/no-explicit-any": ["warn"]
+  }
+}

.github/workflows/docs.yml

@@ -0,0 +1,30 @@
+name: Docs
+
+on:
+  push:
+    branches:
+      - master
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v1
+      - name: Setup Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 16
+      - name: Typedoc
+        run: |
+          npm ci
+          npm run docs
+        env:
+          CI: true
+      - name: Deploy
+        if: success()
+        uses: crazy-max/ghaction-github-pages@v2
+        with:
+          target_branch: gh-pages
+          build_dir: docs
+        env:
+          GH_PAT: ${{ secrets.GH_TOKEN }}

.github/workflows/nodejs.yml

@@ -17,7 +17,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node-version: [8.x, 10.x, 12.x, 13.x, 14.x, 15.x]
+        node-version: [12.x, 13.x, 14.x, 15.x, 16.x]
         os: [ubuntu-latest, macOS-latest]
     runs-on: ${{ matrix.os }}
 
@@ -29,5 +29,7 @@ jobs:
           node-version: ${{ matrix.node-version }}
       - name: install
         run: npm ci
+      - name: build
+        run: npm run build
       - name: run tests
         run: npm run test-ci

.github/workflows/release.yml

@@ -0,0 +1,26 @@
+name: Release
+on:
+  push:
+    branches:
+      - next
+      - beta
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-18.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Setup Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 16
+      - name: Install dependencies
+        run: npm ci
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npx semantic-release

.gitignore

@@ -1,12 +1,11 @@
-
-# Created by https://www.gitignore.io/api/node,code
+# Created by https://www.toptal.com/developers/gitignore/api/node,code
+# Edit at https://www.toptal.com/developers/gitignore?templates=node,code
 
 ### Code ###
-# Visual Studio Code - https://code.visualstudio.com/
-.settings/
-.vscode/
-tsconfig.json
-jsconfig.json
+.vscode/*
+!.vscode/tasks.json
+!.vscode/launch.json
+*.code-workspace
 
 ### Node ###
 # Logs
@@ -15,6 +14,10 @@ logs
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
 
 # Runtime data
 pids
@@ -27,11 +30,12 @@ lib-cov
 
 # Coverage directory used by tools like istanbul
 coverage
+*.lcov
 
 # nyc test coverage
 .nyc_output
 
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
 .grunt
 
 # Bower dependency directory (https://bower.io/)
@@ -40,22 +44,34 @@ bower_components
 # node-waf configuration
 .lock-wscript
 
-# Compiled binary addons (http://nodejs.org/api/addons.html)
+# Compiled binary addons (https://nodejs.org/api/addons.html)
 build/Release
 
 # Dependency directories
 node_modules/
 jspm_packages/
 
-# Typescript v1 declaration files
+# TypeScript v1 declaration files
 typings/
 
+# TypeScript cache
+*.tsbuildinfo
+
 # Optional npm cache directory
 .npm
 
 # Optional eslint cache
 .eslintcache
 
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
 # Optional REPL history
 .node_repl_history
 
@@ -67,8 +83,47 @@ typings/
 
 # dotenv environment variables file
 .env
+.env.test
+.env*.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
 
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
 
-# End of https://www.gitignore.io/api/node,code
+# End of https://www.toptal.com/developers/gitignore/api/node,code
 tests/
-npm-audit.html
+npm-audit.html
+dist/
+.yarn/
+docs/

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run lint

README.md

@@ -3,7 +3,7 @@
 <p align="center">
 <a href="https://github.com/eventOneHQ/npm-audit-html/blob/master/LICENSE"><img src="https://img.shields.io/github/license/eventOneHQ/npm-audit-html.svg" alt="GitHub license"></a>
 <a href="https://www.npmjs.com/package/npm-audit-html"><img src="https://img.shields.io/npm/v/npm-audit-html.svg" alt="npm"></a>
-<a href="https://travis-ci.com/eventOneHQ/npm-audit-html"><img src="https://travis-ci.com/eventOneHQ/npm-audit-html.svg?branch=master" alt="Build Status"></a>
+<a href="https://github.com/eventOneHQ/npm-audit-html/actions/workflows/nodejs.yml"><img src="https://github.com/eventOneHQ/npm-audit-html/actions/workflows/nodejs.yml/badge.svg" alt="Node CI"></a>
 <a href="http://commitizen.github.io/cz-cli/"><img src="https://img.shields.io/badge/commitizen-friendly-brightgreen.svg" alt="Commitizen friendly"></a>
 <a href="https://standardjs.com"><img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="JavaScript Style Guide"></a>
 <a href="https://github.com/semantic-release/semantic-release"><img src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg" alt="semantic-release"></a>