Convert to contemporary node module (#7)

Version bump to 2.0.0
TypeScript
Replace QUnit with Jest/JSDOM
Remove Grunt
Remove Bower

.env

@@ -0,0 +1,3 @@
+# Local env vars for debugging
+TS_NODE_IGNORE="false"
+TS_NODE_FILES="true"

.eslintignore

@@ -0,0 +1,2 @@
+.eslintrc.js
+jest.config.js

.eslintrc.js

@@ -0,0 +1,33 @@
+module.exports = {
+    root: true,
+    parser: '@typescript-eslint/parser',
+    plugins: ['@typescript-eslint', 'node', 'prettier'],
+    parserOptions: {
+        tsconfigRootDir: __dirname,
+        project: ['./tsconfig.json'],
+    },
+    extends: [
+        'eslint:recommended',
+        'plugin:node/recommended',
+        'plugin:@typescript-eslint/eslint-recommended',
+        'plugin:@typescript-eslint/recommended',
+        'plugin:@typescript-eslint/recommended-requiring-type-checking',
+        'plugin:prettier/recommended',
+    ],
+    rules: {
+        'prettier/prettier': 'warn',
+        'node/no-missing-import': 'off',
+        'node/no-empty-function': 'off',
+        'node/no-unsupported-features/es-syntax': 'off',
+        'node/no-missing-require': 'off',
+        'node/shebang': 'off',
+        '@typescript-eslint/no-use-before-define': 'off',
+        quotes: ['warn', 'single', { avoidEscape: true }],
+        'node/no-unpublished-import': 'off',
+        '@typescript-eslint/no-unsafe-assignment': 'off',
+        '@typescript-eslint/no-var-requires': 'off',
+        '@typescript-eslint/ban-ts-comment': 'off',
+        '@typescript-eslint/no-explicit-any': 'off',
+        '@typescript-eslint/no-empty-function': 'off',
+    },
+}

.gitattributes

@@ -0,0 +1,2 @@
+# Set the repository to show as TypeScript rather than JS in GitHub
+*.js linguist-detectable=false

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,27 @@
+---
+name: '🐛 Bug Report'
+about: Report a reproducible bug or regression.
+title: ''
+labels: bug
+assignees: ''
+---
+
+## Current Behavior
+
+<!-- Describe how the issue manifests. -->
+
+## Expected Behavior
+
+<!-- Describe what the desired behavior would be. -->
+
+## Steps to Reproduce the Problem
+
+1.
+1.
+1.
+
+## Environment
+
+- Version: <!-- Version set in package.json -->
+- Platform: <!-- Win/Mac/Linux -->
+- Node.js Version: <!-- Output of running `node -v` -->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,36 @@
+---
+name: 🌈 Feature request
+about: Suggest an amazing new idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+---
+
+## Feature Request
+
+**Is your feature request related to a problem? Please describe.**
+
+<!-- A clear and concise description of what the problem is. Ex. I have an issue when [...] -->
+
+**Describe the solution you'd like**
+
+<!-- A clear and concise description of what you want to happen. Add any considered drawbacks. -->
+
+**Describe alternatives you've considered**
+
+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
+
+## Are you willing to resolve this issue by submitting a Pull Request?
+
+<!--
+  Remember that first-time contributors are welcome! 🙌
+-->
+
+- [ ] Yes, I have the time, and I know how to start.
+- [ ] Yes, I have the time, but I don't know how to start. I would need guidance.
+- [ ] No, I don't have the time, although I believe I could do it if I had the time...
+- [ ] No, I don't have the time and I wouldn't even know how to start.
+
+<!--
+  👋 Have a great day and thank you for the feature request!
+-->

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,42 @@
+<!--
+  😀 Wonderful!  Thank you for opening a pull request.
+
+  Please fill in the information below to expedite the review
+  and (hopefully) merge of your change.
+-->
+
+### Description of change
+
+<!--
+  Please be clear and concise what the change is intended to do,
+  why this change is needed, and how you've verified that it
+  corrects what you intended.
+
+  In some cases it may be helpful to include the current behavior
+  and the new behavior.
+
+  If the change is related to an open issue, you can link it here.
+  If you include `Fixes #0000` (replacing `0000` with the issue number)
+  when this is merged it will automatically mark the issue as fixed and
+  close it.
+-->
+
+### Pull-Request Checklist
+
+<!--
+  Please make sure to review and check all of the following.
+
+  If an item is not applicable, you can add "N/A" to the end.
+-->
+
+- [ ] Code is up-to-date with the `main` branch
+- [ ] `npm run lint` passes with this change
+- [ ] `npm run test` passes with this change
+- [ ] This pull request links relevant issues as `Fixes #0000`
+- [ ] There are new or updated unit tests validating the change
+- [ ] Documentation has been updated to reflect this change
+- [ ] The new commits follow conventions outlined in the [conventional commit spec](https://www.conventionalcommits.org/en/v1.0.0/)
+
+<!--
+  🎉 Thank you for contributing!
+-->

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,71 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: 'CodeQL'
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [main]
+  schedule:
+    - cron: '36 7 * * 6'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: ['javascript']
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        # Learn more:
+        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v1
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
+          # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v1
+
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 https://git.io/JvXDl
+
+      # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+      #    and modify them (or add more) to build your code if your project
+      #    uses a compiled language
+
+      #- run: |
+      #   make bootstrap
+      #   make release
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v1

.github/workflows/pr.yml

@@ -0,0 +1,22 @@
+name: Pull Request
+
+on: [pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [12.x, 14.x, 16.x]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm ci
+      - run: npm run build --if-present
+      - run: npm test
+      - run: npm run coverage

.github/workflows/release.yml

@@ -0,0 +1,31 @@
+name: Release
+on:
+  push:
+    branches:
+      - main
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Setup Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: lts/*
+      - name: Install dependencies
+        run: npm ci
+      - name: Test
+        run: npm test
+      - name: Build
+        run: npm run build
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npx semantic-release
+      - name: Code Coverage
+        run: npm run coverage

.gitignore

@@ -1,2 +1,31 @@
-node_modules
-*.sublime-*
+# Logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional eslint cache
+.eslintcache
+
+# Output of 'npm pack'
+*.tgz
+
+# dotenv environment variables file
+.env.test
+.env.local
+
+# Compiled code
+dist/

.husky/.gitignore

@@ -0,0 +1 @@
+_

.husky/pre-commit

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

.husky/prepare-commit-msg

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+exec </dev/tty || true

.npmignore

@@ -1,5 +1 @@
-node_modules
-.gitattributes
-.jshintrc
-test
-bower.json
+# This is meant to expose the compiled code (namely the type declarations) to NPM but not git

.prettierrc

@@ -0,0 +1,8 @@
+{
+    "singleQuote": true,
+    "tabWidth": 4,
+    "trailingComma": "all",
+    "arrowParens": "always",
+    "printWidth": 120,
+    "semi": false
+}