v2.0.0

⚠ BREAKING CHANGES

• remove support for nodejs v10, as it is EOL as of 2021-04-30

Dependencies

• deps: bump actions/github-script from v3.1.0 to v3.1.1 (eff3805)

Miscellaneous

• remove support for nodejs v10 (2ae95c7)

Documentation

• grammar and readability fixes (35e9d0c)

Continuous Integration

• add cleanup-run job (37eda95)
• add nodejs v16 to unit test matrix (eac6377)
• do not run coveralls steps/jobs on forks (cb9a6f8)
• link-check: fix skip regex (be010ea)
• link-check: ignore links to lib binaries (822a03a)

v1.1.1

Miscellaneous

• husky: move doc step to pre-commit hook (bbca3e5)
• index: make version param optional (3476ad0)
• prettierignore: add api.md (15ec35e)

Dependencies

• deps-dev: bump husky from 4.3.8 to 6.0.0 (3832a5b)
• deps: bump GoogleCloudPlatform/release-please-action (387d34b)
• deps: bump typoci/spellcheck-action from v0.3.0 to v0.4.0 (13fd1b3)

Continuous Integration

• automerge: move automerge job into new workflow (1f6c64c)
• ci: ignore dependabot prs for commit message linting (4db8bdc)
• stale: shorten workflow name (84f86ae)
• workflows: run only on push and pulls to master branch (d993574)

v1.1.0

Features

• index: add binary version checking for options (3e91223)

Bug Fixes

• index: correct misspelling of received in error string (cda01e6)

Continuous Integration

• workflows: move release steps into cd workflow (#45) (7713848)

Documentation

• changelog: add compare links (8b51b55)
• changelog: add h1 header (ec72246)

Miscellaneous

• package: move prettier config to separate file (8a20a35)
• prettier: create .prettierignore (0fbe516)
• workflows: rename ci and perf sections (7674345)

Dependencies

• deps: add semver dependency (a1e8467)
• deps: bump actions/stale from v3.0.17 to v3.0.18 (0e95561)
• deps: bump fastify/github-action-merge-dependabot (733272f)
• deps: bump GoogleCloudPlatform/release-please-action (f5bfb06)
• deps: bump wagoid/commitlint-github-action from v3.0.1 to v3.0.6 (fa23fec)

v1.0.8

Documentation

• bump coc from v1.4.0 to v2.0.0 (3f1a367)
• contributing: add documentation style (17b373b)
• readme: fix broken link (a0d360f)
• readme: grammar (68aba60)
• readme: revamp intro section (86edaa3)
• readme: shorten links (bb80196)

Dependencies

• dependabot: set commit message prefix; lower pull limit (26cac51)
• deps-dev: add husky for git hook handling (537497c)
• deps-dev: bump @commitlint/cli from 11.0.0 to 12.0.1 (#41) (9b2d9b4)
• deps-dev: bump @commitlint/config-conventional (e1b6506)
• deps-dev: bump eslint-config-prettier from 7.2.0 to 8.1.0 (cd7a091)
• deps-dev: bump eslint-plugin-jsdoc from 31.6.1 to 32.0.1 (#37) (5fa4c1f)
• deps-dev: bump jsdoc-to-markdown from 6.0.1 to 7.0.0 (#40) (00306f0)
• deps-dev: pin husky major version (994c53b)
• deps-dev: remove coveralls, replaced by github action (d602daf)
• deps-dev: remove jsinspect (ddb0e60)
• deps: bump wagoid/commitlint-github-action from v2.0.3 to v2.2.3 (eab0134)
• deps: bump wagoid/commitlint-github-action from v2.2.3 to v3.0.1 (4226100)
• deps: specify minor and hotfix versions (57bcbd1)

Miscellaneous

• add commit-lint job (b2842b4)
• add commitlint husky commit-msg hook (47b8438)
• add link check workflow (d56c153)
• add pull request template (41593f5)
• automate release and changelog generation (84113f7)
• capitalise headings correctly (3c302f8)
• ci: capitalise jobs and job step names (e4fb8d1)
• codeql: remove autobuild action (27d7e86)
• dependabot: ignore husky updates (234088c)
• disable long running homebrew cleanup tasks (812de48)
• github-actions: set flag-name for parallel coverage tests (7dccf38)
• github-actions: set semver for coverallsapp (723b833)
• ignore test wmf file (550287f)
• jest: enable resetmocks option (c7bb98c)
• linkcheck: extend ignored urls (c8b7162)
• lint-check: compress patterns (5f1d76c)
• readme: add linebreaks between badges (07af20d)
• readme: capitalise headings correctly (ef91208)
• readme: prettier badge shape (ea67e5c)
• remove cache actions as they use lock file (c8ca340)
• replace stalebot with github action (2d9339b)
• replace typo ci app with action (8c5f4f9)
• revert linux os to ubuntu-latest from 20.04 (cfe6b9f)
• scripts: rename jest-coverage to jest:coverage (093e365)
• shorten husky pre-push script (5e03f99)
• stop excess coverage files being generated (15be36a)
• tests: use apa header style for describe name params (78eef74)
• vscode: add redhat.vscode-yaml as recommended extension (aeb9a16)
• vscode: add updateImportsOnFileMove setting (bcf3342)
• vscode: add workspace settings and extensions (0704d1d)
• vscode: remove conflicting prettier ext setting (cb2fe3d)
• workflows: fix release types to account for bots (477dae4)
• workflows: rename spellcheck workflow (f8a2de7)
• workflows: tidy node-version syntax (5ff6186)

v1.0.7

• build: add typoci config file (673d667)
• build: remove yarn as package manager, revert to npm (92bfa05)
• build(deps-dev): bump eslint-plugin-jsdoc from 30.7.13 to 31.0.7 (#26) (3a385b0), closes #26
• fix: remove lockfile (3f1f06f)
• fix: script calls (92c1d12)
• ci: ignore scripts on publish (51bbc50)
• ci: remove redundant javascript dictionary (5bb970f)
• ci(typo-ci): add ydh to list of excluded words (ce0dd7d)
• chore(package): add homepage and bug urls (0296e85)
• docs: update contact email (b1ab606)
• docs(contributing): update yarn link (e1c4bc0)

v1.0.6

• build(deps-dev): bump eslint from 7.16.0 to 7.17.0 (#23) (906057f), closes #23
• build(deps-dev): bump eslint-plugin-jsdoc from 30.7.9 to 30.7.13 (#22) (3a6a54c), closes #22
• build(deps-dev): remove cross-env (3fb81e4)
• ci: refactor codeql-analysis.yml (ed2cf30)
• ci: use yarn cache of node dependencies if present (fe7171a)
• ci(codeql): specify more query suites (0bf1d99)
• chore: remove old .env files from gitignore (1fcc8dd)
• docs(readme): update examples (22d5943)
• test(index): function with no options param passed (72c97af)
• refactor(index): remove unused default branch (aee6c76)
• style(ci): tidy job names (78bc55e)

v1.0.5

• build: update github-actions with dependabot (e905020)
• build(deps-dev): bump cross-env from 7.0.2 to 7.0.3 (3c99ec3)
• build(deps-dev): bump eslint from 7.14.0 to 7.16.0 (96b903f)
• build(deps-dev): bump eslint-config-prettier from 6.15.0 to 7.1.0 (a9c02e6)
• build(deps-dev): bump eslint-plugin-jsdoc from 30.7.8 to 30.7.9 (#14) (ff9c9d2), closes #14
• build(deps-dev): bump typescript from 4.1.2 to 4.1.3 (#16) (372bd4b), closes #16
• build(deps-dev): remove eslint-plugin-json (ae41058)
• build(deps): bump fastify/github-action-merge-dependabot (#13) (dbda5ae), closes #13
• build(typescript): enable strict option (4c5344a)
• docs(contributing): update prettier script (c2df110)
• docs(readme): remove abbreviation (cca9eb4)
• ci: add linting job; expand scope of jobs (2abbfc1)
• ci: automatically merge dependabot pull requests on pass build stage (3c7b40a)
• ci: bump actions/setup-node from v1 to v2 (3ec3d8b)
• ci: freeze yarn lockfile on publish (65135d6)
• ci: merge unit test jobs (4fe02c8)
• ci: move dependency installs to correct step (5bf2bd9)
• ci: require lint job on automerge (ab41541)
• style: use default prettier options for trailing commas and quotes (c4f9fad)
• fix(scripts): test script (b5a59e0)
• chore: add stale confg (777a58e)
• chore(scripts): rename test scripts (e0cee9f)

v1.0.4

• build(deps-dev): bump dev dependencies (25a4bb4)
• chore: add security.md (821352e)
• ci: add cd action to publish to npm (709bef7)
• ci: replace travis-ci with github actions (70d23d8)

v1.0.3

• build(deps-dev): bump dev dependencies (2e96ea0)
• fix(index): return promise objects (863d9f7)
• docs(index): correct return jsdoc tag for parseoptions function (59bb581)
• refactor(index): concat invalid args provided into error object (dd1084e)
• chore(index): rename const to reflect functionality (a0624e9)

v1.0.2

• build(deps-dev): bump dev dependencies (79e05f9)
• docs: grammar and spelling fixes (f5fb9e3)
• fix(index): check file exists before attempting to parse (41daf30)