Merge branch 'release/1.1.0'

Author: davesag

.circleci/config.yml

@@ -18,7 +18,7 @@ jobs:
 
       - restore_cache:
           keys:
-          - dependencies-{{ checksum "package.json" }}
+          - dependencies-v2-{{ checksum "package.json" }}
 
       - run:
           name: Install global packages
@@ -33,7 +33,7 @@ jobs:
           command: npm install
 
       - save_cache:
-          key: dependencies-{{ checksum "package.json" }}
+          key: dependencies-v2-{{ checksum "package.json" }}
           paths:
             - node_modules
 

.eslintrc.js

@@ -1,6 +1,6 @@
 module.exports = {
-  extends: ['standard', 'prettier', 'prettier/standard'],
-  plugins: ['prettier', 'standard', 'import', 'promise'],
+  extends: ['standard', 'plugin:prettier/recommended'],
+  plugins: ['import', 'promise', 'mocha'],
   parserOptions: {
     sourceType: 'module'
   },

.github/dependabot.yml

@@ -0,0 +1,20 @@
+# Basic dependabot.yml file with
+# minimum configuration for two package managers
+
+version: 2
+updates:
+  # Enable version updates for npm
+  - package-ecosystem: "npm"
+    # Look for `package.json` and `lock` files in the `root` directory
+    directory: "/"
+    # Check the npm registry for updates every day (weekdays)
+    schedule:
+      interval: "daily"
+
+  # Enable version updates for Docker
+  # - package-ecosystem: "docker"
+  #   # Look for a `Dockerfile` in the `root` directory
+  #   directory: "/"
+  #   # Check for updates once a week
+  #   schedule:
+  #     interval: "weekly"

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,62 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [develop, master]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [develop]
+  schedule:
+    - cron: '0 4 * * 0'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        # Override automatic language detection by changing the below list
+        # Supported options are ['csharp', 'cpp', 'go', 'java', 'javascript', 'python']
+        language: ['javascript']
+        # Learn more...
+        # https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#overriding-automatic-language-detection
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+      with:
+        # We must fetch at least the immediate parents so that if this is
+        # a pull request then we can checkout the head.
+        fetch-depth: 2
+
+    # If this run was triggered by a pull request event, then checkout
+    # the head of the pull request instead of the merge commit.
+    - run: git checkout HEAD^2
+      if: ${{ github.event_name == 'pull_request' }}
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+
+    # 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

.gitignore

@@ -35,3 +35,6 @@ node_modules/
 
 # macOS Desktop cache files
 .DS_Source
+
+# VS Code metadata
+.vscode

.husky/.gitignore

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

.husky/pre-commit

@@ -0,0 +1 @@
+npx --no-install lint-staged

README.md

@@ -6,7 +6,7 @@ A Pub Sub system that uses `AMQP` messaging to exchange data between services.
 
 ## To Use
 
-You project needs to be using at least Node version 8, and ideally Node 10 (LTS) or later.
+You project needs to be using at least Node version 8, and ideally Node 14 (LTS) or later.
 
 ```sh
 npm install amqp-simple-pub-sub
@@ -113,7 +113,7 @@ See some examples in the tests, and also:
 
 ### Prerequisites
 
-- [NodeJS](htps://nodejs.org), version 10.18.2 (LTS) or better (I use [`nvm`](https://github.com/creationix/nvm) to manage Node versions — `brew install nvm`.)
+- [NodeJS](htps://nodejs.org), 8.10.0+ (I use [`nvm`](https://github.com/creationix/nvm) to manage Node versions — `brew install nvm`.)
 - [Docker](https://www.docker.com) (Use [Docker for Mac](https://docs.docker.com/docker-for-mac/), not the homebrew version)
 
 ### Initialisation
@@ -135,7 +135,6 @@ Runs Rabbit MQ.
 - `npm test` — runs the unit tests (quick and does not need `rabbitmq` running)
 - `npm run test:unit:cov` — runs the unit tests with code coverage (does not need `rabbitmq`)
 - `npm run test:integration` — runs the integration tests (needs `rabbitmq`)
-- `npm run test:mutants` — runs the mutation tests (does not need `rabbitmq`)
 
 ### Lint it
 

SECURITY.md

@@ -0,0 +1,18 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.x     | :white_check_mark: |
+| < 1.x   | :x:                |
+
+## Reporting a Vulnerability
+
+Report a vulnerability to [the author](https://about.me/davesag) directly.
+
+You can expect to get an update on a reported vulnerability within 2 working days.
+
+## Vulnerabilities in development dependencies
+
+I'm using `dependabot` to scan for security issues and update dependencies in the `develop` branch regularly.