CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

5.0.1 (2024-04-30)

Continuous integration

• ci: audit package signatures and provenance attestations (9966ace)
• deps: bump wagoid/commitlint-github-action from 5 to 6 (#365) (8a16660)
• use latest node lts version (172b71d)

Improvements

• index: use slice() over startsWith() (054a0e5)

5.0.0 (2024-03-12)

⚠ BREAKING CHANGES

• index: unrtfPath and unrtfVersion fields can no longer be changed after class has been initialised

Dependencies

• deps-dev: bump dev dependencies (b148274)
• deps-dev: bump the commitlint group with 2 updates (#362) (37b420e)

Miscellaneous

• ignore types dir (4378b45)
• index: inline comment re export types (c6c4e02)
• index: remove backticks from string (85bee42)
• stop types being committed (0e1e412)

Continuous integration

• cd: standardise @fdawgs cd workflows (3e34f52)
• ci: standardise @fdawgs ci workflows (bdff8a4)
• dependabot: add [@eslint-community](https://github.com/eslint-community) scoped deps to eslint group (0985f77)

Improvements

• enable strict type checking (da3b3b4)
• index: make unrtfPath and unrtfVersion fields private (e2c3c50)

Documentation

• remove outdated api docs; refer to type defs instead (eb30adc)

4.1.7 (2024-02-22)

Dependencies

• deps-dev: bump dev dependencies (598315a)
• deps-dev: bump husky from 8.0.3 to 9.0.6 (#358) (ce62a47)
• deps: bump semver from 7.5.4 to 7.6.0 (35d25c9)

Miscellaneous

• .husky: migrate hooks to v9 style (d12a911)
• .vscode: fix prettier.prettierPath setting (9542260)

Continuous integration

• cd: use main environment for publish-npm job (014981c)
• deps: bump actions/dependency-review-action from 3 to 4 (#357) (8533389)

Improvements

• index: swap negated condition (ee06254)
• index: use string.StartsWith() over regex.test() (d2e21d6)
• index: use constant comparison order (1267519)

4.1.6 (2024-01-24)

Dependencies

• deps-dev: bump dev dependencies (788cc97)

Miscellaneous

• .vscode: use local prettier version (ffcf4ed)
• scripts/license-checker: handle old license arrays or missing (ba2420d)
• tsconfig: remove lib; target will be used in absence (168250f)

Continuous integration

• cd: param order (6debe1b)

4.1.5 (2024-01-16)

Continuous integration

• cd: set github package to public (c5fb131)

4.1.4 (2024-01-16)

Miscellaneous

• package: fix repository structure (9a7a9bc)

Continuous integration

• cd: add missing id-token for github package job (c9b7667)

4.1.3 (2024-01-16)

Dependencies

• deps-dev: bump dev dependencies (1f4458e)

Miscellaneous

• .prettierignore: ignore auto-generate types (7ea841d)
• jsdoc comments must be complete sentences (d21ba63)
• license: update license year (9546a48)
• package: add lint:fix script (02f147d)
• package: run lint:prettier in test script (4a22932)
• use shared files from fdawgs/.github (264b1dd)

Continuous integration

• automerge: optimise inline js scripts (cafd051)
• cd: add github packages publish job (028bd85)
• dependabot: ignore release-please-action major updates (8c78af3)
• deps: bump actions/upload-artifact from 3 to 4 (#343) (85f2c54)
• deps: bump github/codeql-action from 2 to 3 (#342) (43f4436)

Documentation

• readme: update links (8ee9a87)

4.1.2 (2023-11-29)

Dependencies

• deps-dev: bump dev dependencies (162716c)
• deps-dev: bump the commitlint group with 2 updates (#334) (1dd812d)
• deps-dev: bump the eslint group with 1 update (#335) (6adc0a6)
• deps-dev: remove broken eslint-plugin-security-node (45e8dcb)

Miscellaneous

• index: add inline comment explaining regex cache (5a33b91)

Continuous integration

• deps: bump actions/github-script from 6 to 7 (#337) (31972e5)
• deps: bump actions/setup-node from 3 to 4 (#333) (1794f54)

Documentation

• readme: fix broken ci badge link (ba00408)
• readme: fix npm badge (ec9d90e)
• readme: update examples (26f5fcb)

4.1.1 (2023-10-23)

Dependencies

• deps-dev: add eslint-community/eslint-plugin-eslint-comments (5e28633)

Miscellaneous

• .vscode: add github-markdown-preview to recommended extension (f1d98f8)
• .vscode: add gitlens to recommended extensions (879578f)
• scripts/license-checker: update link to deprecated list (46ffc53)
• tsconfig: use es2022 lib (504bc84)

Improvements

• index: cache regex literals (eb46c0c)

Documentation

• readme: remove section re passing bin path for unix installs (99b59d7)

4.1.0 (2023-09-25)

Features

• index: use binary from path env variable if not passed as param (402289b)

Dependencies

• deps-dev: bump eslint from 8.49.0 to 8.50.0 (9c0c7fd)

Improvements

• index: check bin version once on class init, not every func call (1085984)
• index: create acceptedOptions obj on init, not every func call (4a9816b)

4.0.2 (2023-09-23)

Bug fixes

• index: do not mask error code if unknown (70c4a11)

4.0.1 (2023-09-23)

Miscellaneous

• .gitattributes: auto lf eol all files (baacf05)
• tsconfig: target es2022 (0284215)

Continuous integration

• dependabot: group dependabot updates (0ad4307)

4.0.0 (2023-09-21)

⚠ BREAKING CHANGES

• dropped support for EOL node 14 and 16

Bug fixes

• index: type build (1a25f55)

Dependencies

• deps-dev: add @types/jest (9499665)
• deps-dev: bump dev dependencies (78801a8)

Miscellaneous

• .eslintrc: bump ecmaversion to 2023 (552b51b)
• add missing .gitattributes file (c91218b)
• change comment blocks with one line into single block (794a75f)
• destruct upath module import (#316) (8ae0fdc)
• drop support for node 14 and 16 (#317) (680aa50)
• index: add seg fault error code (07510c1)
• package: explicitly declare js module type (e43ea37)
• scripts/license-checker: declare copyLeftLicenses type (0b7e98b)
• scripts/license-checker: ignore invalid ts error (57f79e9)
• tsconfig: disable strict mode (#319) (fd6f241)
• tsconfig: enable checkJs compiler option (f2502e6)
• tsconfig: set module to nodenext (25254c2)
• use [@see](https://github.com/see) jsdoc tag for inline comment links (cf7c27d)

Continuous integration

• deps: bump actions/checkout from 3 to 4 (#322) (4f8e2a5)
• deps: bump coverallsapp/github-action from 2.2.1 to 2.2.3 (#323) (327547e)

Improvements

• index: replace hasOwnProperty.call() with hasOwn() (fbedb02)
• index: return error messages (#320) (df842df)
• use node: prefix to bypass require.cache call for builtins (db1b1a8)

Documentation

• readme: update chaining example with .catch() (a925c05)

3.1.7 (2023-08-16)

Dependencies

• deps-dev: bump dev dependencies (71bd998)
• deps-dev: bump eslint-config-prettier from 8.10.0 to 9.0.0 (#311) (a7e5354)
• deps: bump semver from 7.5.3 to 7.5.4 (168bf47)

Miscellaneous

• .eslintrc: error on google closure jsdoc syntax (7fb28c7)
• fix import order for linting (5c210f3)
• remove outdated inline eslint rule (349fd26)
• rename lint:prettier scripts to reflect their function (#303) (37116c8)
• scripts/license-checker: use console.error() to log failures (89c9397)
• test-resources: use dash over camelcase for naming files (5dfee8e)
• tsconfig: sort options (70990c8)
• update import order (07df94c)
• use jsdoc syntax for arrays over interfaces (302d17c)
• use jsdoc syntax for opt params over google closure syntax (92e4068)

Continuous integration

• ci: error on new jest snapshot (370addc)
• ci: revert jest snapshot cli arg addition (3cb32b7)
• deps: bump coverallsapp/github-action from 2.2.0 to 2.2.1 (#306) (970e9f2)

Improvements

• deconstruct imports (dbe1051)

3.1.6 (2023-07-08)

Improvements

• index: add strict u flag to all regex patterns (e53e956)
• index: remove useless i regex flag (34d2df3)

Miscellaneous

• .eslintrc: sort extends array (d679587)

Dependencies

• deps-dev: add eslint-plugin-regexp (4616c07)
• deps-dev: bump dev dependencies (0080245)

Bug fixes

• add missing strict mode directives (#300) (f3aa8ac)
• index: escape regexp quantifier characters (fbb7fa5)

3.1.5 (2023-06-24)

Continuous integration

• deps: bump coverallsapp/github-action from 2.1.2 to 2.2.0 (#294) (b717f52)

Miscellaneous

• .eslintrc: enable additional jest plugin rules (7146e71)
• .eslintrc: enable additional jsdoc plugin rules (f19811d)
• .eslintrc: only use jest plugin to lint test-related files (96b981a)
• .eslintrc: update ecmascript version (fc4ab0b)
• package: remove global jest mock config values (#291) (9331a40)
• package: set jest coverage threshold (42bc695)

Dependencies

• deps-dev: bump dev dependencies (f2ad989)
• deps: bump semver from 7.5.1 to 7.5.3 (b4455f2)

3.1.4 (2023-06-02)

Miscellaneous

• fix inline comment style (9e04b13)
• use nouns for leading word in function description tags (#285) (354a2a8)

Dependencies

• deps-dev: bump dev dependencies (#288) (85c9570)
• deps-dev: bump eslint-plugin-jsdoc from 44.2.7 to 46.1.0 (#289) (bce0174)

Bug fixes

• index: return types don't support promise rejection values (#290) (79746ec)

3.1.3 (2023-05-13)

Miscellaneous

• index: state default output if no output* options passed (639fcda)
• scripts/license-checker: resolve eslint jsdoc warning (#279) (ed2b694)

Bug fixes

• index: do not pass false boolean options to binary (44fddd2)

Dependencies

• deps-dev: bump eslint-plugin-jsdoc from 43.2.0 to 44.2.3 (#284) (96cf2e2)
• deps: bump semver from 7.3.8 to 7.5.1 (#282) (784d186)

3.1.2 (2023-04-24)

Miscellaneous

• .prettierrc: enable arrowParens option (#274) (93598f6)
• index: remove redundant eslint comments (#271) (095cb26)

Dependencies

• deps-dev: bump eslint-plugin-jsdoc from 40.3.0 to 43.0.7 (#276) (4d6224a)

Continuous integration

• cd: publish to npm with provenance (#278) (88ff6d0)
• ci: add node 20 to test matrix (#277) (7df7c7b)
• deps: bump coverallsapp/github-action from 2.0.0 to 2.1.2 (#275) (caad54e)

3.1.1 (2023-03-31)

Miscellaneous

• ignore bun lockfile (#258) (414bb45)
• index: remove redundant async keywords (#262) (d4e0ac0)
• package: add funding url (a7e5ee7)
• scripts: add eslint rule file (c02487f)
• scripts: remove redundant export (931c586)
• scripts: use js script to check licenses (#260) (3f69505)

Documentation

• contributing: add link to conventional config (#265) (73a8fb8)

Continuous integration

• dependabot: change commit message prefix for gh actions to ci (#264) (23b4631)
• dependabot: ignore esm major versions (#263) (0e12e21)
• deps: bump coverallsapp/github-action from 1.2.4 to 2.0.0 (#266) (4c4c7ee)

Improvements

• index: remove blocking fs.existsSync() call (#261) (2c3efd9)
• index: remove redundant multi line regex flag (#269) (b8b6fa2)

Dependencies

• deps-dev: bump dev dependencies (9a967fa)
• deps-dev: bump typescript from 4.9.5 to 5.0.2 (#267) (4679b8e)
• deps: bump coverallsapp/github-action from 1.1.3 to 1.2.3 (#256) (3fbf0d4)
• deps: bump coverallsapp/github-action from 1.2.3 to 1.2.4 (#257) (1a5ff13)

3.1.0 (2023-02-20)

Features

• add nodenext compatibility (#252) (0476264)

Documentation

• api: remove parseOptions() private method (#253) (6412a92)

Miscellaneous

• index: remove jsdoc type from parseOptions() (a19a76e)

Improvements

• index: do not return empty error message on rejection (88c92c5)

3.0.6 (2023-02-13)

Documentation

• readme: rename intro to overview (9145985)

Continuous integration

• cd: use sentence case for changelog headings (49b64e2)

Dependencies

• deps-dev: bump dev dependencies (283b042)

Miscellaneous

• rename master branch to main (#250) (1de78ad)
• use sentence case over ap style for titles and headings (eef9ac5)

3.0.5 (2023-01-31)

Miscellaneous

• package: remove doc script (#245) (6d9e929)

Documentation

• readme: add note re windows binary (1032a12)
• readme: fix linux path example (#242) (4210dfd)
• readme: remove fluff (9f7240b)

Dependencies

• deps-dev: bump dev dependencies (860a394)
• deps: replace file-type with native functionality (148ee6e)

3.0.4 (2023-01-13)

Miscellaneous

• license: update license year (e77850e)

Documentation

• contributing: update min node version (d0b3ef7)
• grammar and clarity fixes (ce7a89f)

Dependencies

• deps-dev: bump dev dependencies (e81d337)
• deps-dev: bump jsdoc-to-markdown from 7.1.1 to 8.0.0 (#238) (e8eeced)
• deps: bump actions/dependency-review-action from 2 to 3 (#237) (3616a3f)

Improvements

• index: convert parseOptions() internal func to sync (39d24e2)
• index: remove catch rethrowing errors (#241) (907902f)

3.0.3 (2022-10-25)

Continuous integration

• cd: fix typescript def gen (931b986)

3.0.2 (2022-10-25)

Miscellaneous

• lib/win32: compress binaries (#233) (caf7794)

Continuous integration

• cd: gen typescript definitions before publishing (21e0b85)
• cd: remove dev values from package.json (49a022d)

Dependencies

• deps-dev: bump dev dependencies (8cd7042)
• deps: bump semver from 7.3.7 to 7.3.8 (bdf759c)

3.0.1 (2022-10-03)

Documentation

• readme: remove redundant statement (58f2f60)
• use shorter urls; remove yarn install guidance (be81d59)

Miscellaneous

• .husky: shell path and arg updates (#224) (9fd65dd)
• .npmignore: reduce entries (c3dd237)
• .vscode/extensions: remove unmaintained extension (a6d6f49)
• *.ignore: add clinicjs directory (8ee7d00)
• import destructuring (#230) (80e4748)
• LICENSE: remove trailing whitespace (ca8cb7d)
• prefer object destructuring (#232) (abaa7dd)

Dependencies

• deps-dev: bump dev dependencies (c0b587b)
• deps-dev: bump eslint-plugin-jest from 26.9.0 to 27.0.1 (#226) (f7e67b6)
• deps-dev: bump jest from 28.1.3 to 29.0.1 (#227) (c1cffa3)

3.0.0 (2022-08-09)

⚠ BREAKING CHANGES

• drop support for EOL node 12

Miscellaneous

• .gitignore: use latest github ignore template (cbf460d)
• .npmrc: disable package-lock generation (#219) (fadab12)
• .prettierignore: add new paths from .gitignore (999cb48)
• drop support for node 12 (#222) (f8289a2)
• ignore pnpm lock file (e7d4d64)

Dependencies

• .npmignore: add documentation; reduce package size by ~33.2% (#220) (3b9f772)
• dependabot: increase open-pull-requests-limit from 5 to 20 (1de18cb)
• deps: bump actions/dependency-review-action from 1 to 2 (#217) (6d06a02)
• deps: bump dependencies (#223) (4af18b4)
• deps: bump wagoid/commitlint-github-action from 4 to 5 (#216) (58679bf)

2.0.9 (2022-06-04)

Miscellaneous

• .github/funding: remove unused keys (c76b454)
• .github: add FUNDING.yml (5f0d22f)

Dependencies

• .npmignore: ignore tsconfig.json (1539079)
• .npmignore: ignore support files; reduce package size by ~73% (01f9e6f)

2.0.8 (2022-06-01)

Documentation

• improve readability (7636248)
• readme: fix broken link (96cb17c)
• readme: remove snyk badge (dd5dfae)

Miscellaneous

• .eslintrc: enable plugin:jest/style rules (#200) (b1af9ca)
• .github/codeql-config: remove quotation marks (7062f47)
• bug_report: use node 18 as placeholder for node-version (39eb3b6)
• ci: remove quotation marks from step name (03554a3)
• index: update constructor jsdoc param tag (#189) (3abc92a)
• scripts: remove redundant gitkraken fix from prepare script (758bce0)
• scripts: use shorter arg aliases; remove debugging args from jest (eb83f38)
• use npm install alias (26e9fdd)

Continuous integration

• add dependency-review job (0c42629)
• add job step names, workflow comments, and whitespace (10d24d8)
• automerge: fix context (ba623e0)
• automerge: squash automerge prs (#190) (7afcfb8)
• cd: update org name for release-please-action (a640ab2)
• cd: use lts/* for node setup in release job (ab4d5ff)
• check user.login is dependabot instead of actor (#202) (9178aec)
• ci: add node 18 to test matrix (#201) (870d7d7)
• ci: require unit-tests job to pass for save-pr-number job to run (438652b)
• ci: use lts/* for node setup in lint job (98cb0c3)
• ci: use node-version for node matrix key (b3e4bdc)
• codeql-analysis: remove unused autobuild step (5913103)
• codeql: grant minimum permissions to run; rename file (#186) (47379f6)
• codeql: only run on pr changes to .html, .js, and .yml files (09733fb)
• codeql: resolve missing analyses (5fbd4b6)
• codeql: specify which files to scan during analysis (c4a7a0f)
• link-check: fix skip regex (48da5ac)
• link-check: replace npx linkinator call with github action (983c25e)
• only save pr number artifact for dependabot (d66ce1c)
• only trigger dependency-review on pr (6347c11)
• reduce workflow permissions to minimum (bb640f2)
• remove git credentials after checkout (#205) (c4c4751)
• replace workflow-run-cleanup-action with github concurrency (fd31220)

Dependencies

• deps-dev: bump @commitlint/cli from 16.3.0 to 17.0.1 (#209) (e09053c)
• deps-dev: bump @commitlint/config-conventional (#207) (aa1eee8)
• deps-dev: bump eslint-plugin-jsdoc from 37.9.7 to 38.0.6 (1184217)
• deps-dev: bump eslint-plugin-jsdoc from 38.1.6 to 39.2.9 (#198) (7bcab92)
• deps-dev: bump husky from 7.0.4 to 8.0.1 (#208) (e79ae3e)
• deps-dev: bump jest from 27.5.1 to 28.0.3 (#197) (0684645)
• deps: bump actions/checkout from 2 to 3 (af36dea)
• deps: bump actions/upload-artifact from 2 to 3 (#196) (0a365b3)
• deps: bump github/codeql-action from 1 to 2 (#195) (96392b2)
• deps: bump minor and hotfix versions (#210) (fd18299)

2.0.7 (2022-02-25)

Bug fixes

• index: use spawn for larger stream results (#181) (14515f2)

Documentation

• contributing: add mention of husky pre-commit hook (4a006fd)
• contributing: add step for lint:licenses script (#166) (54a54f5)
• readme: add windows binary known issues section (#165) (06b9b1b)

Continuous integration

• remove spellcheck workflow (#173) (4c28c91)

Miscellaneous

• .github: remove trailing whitespace (5a9a431)
• turn off security/detect-object-injection eslint rule (#162) (9fde2cf)

Dependencies

• dependabot: ignore minor and patch commit-lint updates (#175) (0443af1)
• dependabot: ignore minor and patch release-please-action updates (#164) (edd4c69)
• dependabot: major tags no longer need ignore support (240be7b)
• dependabot: use default open-pull-requests-limit value (d7e2723)
• deps-dev: bump @commitlint/cli from 15.0.0 to 16.0.1 (8c86caa)
• deps-dev: bump @commitlint/config-conventional (a7974fb)
• deps-dev: bump dev dependencies (7c244dd)
• deps-dev: bump eslint from 7.32.0 to 8.7.0 (9c7954b)
• deps-dev: bump eslint-plugin-jest from 25.7.0 to 26.0.0 (67fc04d)
• deps-dev: bump eslint-plugin-promise from 5.2.0 to 6.0.0 (9b249c3)
• deps-dev: bump prettier from 2.5.0 to 2.5.1 (3fbe274)
• deps: bump actions/github-script from 5 to 6 (f8af51e)
• deps: bump actions/setup-node from 2 to 3 (ad9d0df)
• deps: bump GoogleCloudPlatform/release-please-action from 2 to 3 (165b2ab)

2.0.6 (2021-12-02)

Bug fixes

• index: do not assume win32 usage for binaries (bbd50d8)

Continuous integration

• ci: do not run clean-up on draft prs (f0105cf)
• spell-check: do not run on draft prs (f4705c2)
• trigger workflows when drafts marked as "ready to review" (#148) (4fc27d5)

Documentation

• coc: reduce verbosity (6532486)

Miscellaneous

• ignore .yarnclean (#154) (fc420c9)
• package/scripts: add lint:licenses (#155) (3761264)

Improvements

• index: remove unused conditional; all options are binary (#157) (d563d23)

Dependencies

• dependabot: ignore minor and patch github-actions updates (#149) (5994571)
• deps-dev: bump @commitlint/cli from 14.1.0 to 15.0.0 (1d6e73a)
• deps-dev: bump @commitlint/config-conventional (46b55b7)
• deps-dev: bump dev dependencies (#161) (8ef1863)
• deps-dev: bump eslint-config-airbnb-base from 14.2.1 to 15.0.0 (6659063)
• deps-dev: bump prettier from 2.4.1 to 2.5.0 (8d98289)
• deps: bump GoogleCloudPlatform/release-please-action (21f0d71)

2.0.5 (2021-11-04)

Bug fixes

• index: normalize binPath constructor param (#145) (81e2863)

Dependencies

• deps-dev: bump @commitlint/cli from 13.2.1 to 14.1.0 (a289044)
• deps-dev: bump @commitlint/config-conventional (c5990e5)
• deps: bump actions/checkout from 2.3.4 to 2.3.5 (6940cbe)
• deps: bump GoogleCloudPlatform/release-please-action (70e5b66)
• deps: bump wagoid/commitlint-github-action from 4.1.5 to 4.1.9 (de5ab57)

Miscellaneous

• .prettierrc: only enable bracketSameLine for html (#142) (529f0e8)

Continuous integration

• cd: stop prepare script running (#144) (731aecb)

2.0.4 (2021-10-29)

Miscellaneous

• ignore emf and wmf test files (#134) (8d79d76)

2.0.3 (2021-10-29)

Continuous integration

• automerge: update location of octokit rest methods (853455e)
• ci: revert to workflow-run-clean-action from github concurrency (010965e)

Miscellaneous

• .eslintrc: remove inaccurate sourcetype (#128) (6b9bd44)
• .eslintrc: remove redundant impliedStrict option (#131) (6e1d15f)
• .eslintrc: set correct ecmascript version (#118) (1e0913c)
• .husky/.gitignore: remove now redundant file (4c805bd)
• .npmignore: add API.md (#120) (acf9589)
• .prettierrc: enable bracketsameline option (bfde76d)
• .prettierrc: override defaults for html, css, and scss files (#119) (c3cc50e)
• .vscode: add mhutchie.git-graph extension (e4fa7e4)
• .vscode: remove deprecated settings (#129) (a09bb79)
• disable irrelevant eslint rules (#130) (1542272)

Documentation

• bump coc from v2.0.0 to v2.1.0 (#132) (c7bb201)

Dependencies

• deps-dev: add eslint-plugin-security-node (#121) (71ed617)
• deps-dev: bump dev dependencies (9fe5ece)
• deps-dev: bump prettier from 2.3.2 to 2.4.1 (9caa2bc)
• deps: bump actions/setup-node from 2.4.0 to 2.4.1 (12c1d2c)
• deps: bump file-type from 16.5.0 to 16.5.3 (f7246ba)
• deps: bump GoogleCloudPlatform/release-please-action (40836ed)
• deps: bump semver from 7.3.4 to 7.3.5 (f15e0a5)
• deps: bump wagoid/commitlint-github-action from 4.1.1 to 4.1.5 (4bba7ee)

2.0.2 (2021-09-06)

Documentation

• readme: grammar fix (0c067cb)

Miscellaneous

• .github: use new YAML configured GitHub issue forms (#113) (1ebfbd5)
• vscode: disable red hat telemetry (8b4caad)
• vscode: remove user space config setting (a86bb2f)

Continuous integration

• ci: disable homebrew analytics for macos builds (#101) (de448c3)
• ci: replace workflow-run-cleanup-action with github concurrency (#114) (15f202c)
• link-check: reduce frequency from daily to monthly (#95) (42f60b8)

Dependencies

• add .npmignore; reduce package size from 1.2MB to 117.2kB (#115) (0484881)
• deps-dev: bump @commitlint/cli from 12.1.4 to 13.1.0 (0f0a344)
• deps-dev: bump @commitlint/config-conventional (a195be4)
• deps-dev: bump eslint-plugin-jsdoc from 35.5.1 to 36.0.6 (55eb347)
• deps-dev: bump husky from 6.0.0 to 7.0.0 (07b37d7)
• deps-dev: bump prettier from 2.3.1 to 2.3.2 (5d59e46)
• deps: bump actions/github-script from 4.0.2 to 4.1 (c0c97ff)
• deps: bump actions/setup-node from 2.1.5 to 2.2.0 (fc0ff51)
• deps: bump actions/setup-node from 2.2.0 to 2.3.0 (09bbcd6)
• deps: bump actions/setup-node from 2.3.0 to 2.4.0 (261513f)
• deps: bump actions/upload-artifact from 2.2.3 to 2.2.4 (00e3c19)
• deps: bump coverallsapp/github-action from 1.1.2 to 1.1.3 (d6f6386)
• deps: bump GoogleCloudPlatform/release-please-action (745c5d1)
• deps: bump wagoid/commitlint-github-action from 3.1.4 to 4.1.1 (b48d588)

2.0.1 (2021-06-15)

Bug fixes

• index: normalize file paths (#89) (9660cce)
• index: throw error if file param is not rtf (e3552bb)

Documentation

• readme: remove repetition (08758ff)

Miscellaneous

• ci: replace node-version key with shorter node (#80) (6beeef2)
• workflows: remove stale.yml (e914a39)

Continuous integration

• cd: move perf optimizations and refactoring into same section (7ab68ec)
• fix key usage in action/setup-node (d3ddf47)

Dependencies

• deps-dev: bump eslint-plugin-jsdoc from 33.3.0 to 35.1.2 (bb5f80e)
• deps-dev: bump jest from 26.6.3 to 27.0.3 (ff94919)
• deps-dev: bump prettier from 2.2.1 to 2.3.0 (61478d5)
• deps-dev: bump prettier from 2.3.0 to 2.3.1 (538a5a4)
• deps: bump GoogleCloudPlatform/release-please-action (671e4e0)
• deps: bump wagoid/commitlint-github-action from 3.1.0 to 3.1.4 (da1c9a1)

2.0.0 (2021-04-29)

⚠ 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)

1.1.1 (2021-03-29)

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 main branch (d993574)

1.1.0 (2021-03-08)

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)

1.0.8 (2021-03-02)

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)

1.0.7 (2021-01-18)

• 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)

1.0.6 (2021-01-03)

• 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)

1.0.5 (2020-12-28)

• 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)

1.0.4 (2020-12-01)

• 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)

1.0.3 (2020-11-10)

• 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)

1.0.2 (2020-10-29)

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

1.0.1 (2020-10-27)

• build(deps-dev): bump dev dependencies (cf5cd8b)
• ci(travis): add npm deploy stage (d194055)
• fix(index): catch empty file vars before unrtf parses them (789afbd)

1.0.0 (2020-10-26)

• build(deps-dev): bump dev dependencies (dd3f926)
• refactor(index): move optional option param for convert function to end (02b95a9)
• chore(scripts): do not lint ts and tsx files (f40b335)
• feat(index): add typescript definitions (e2203a6)

BREAKING CHANGE

• usage of convert(option, file) should be replaced with convert(file, option)

0.0.2 (2020-10-21)

• docs: add api docs and examples (59f1fc3)
• docs(index): add note to jsdoc tags about select options errors (d1d9964)
• docs(index): clarify on required unrtf binary version (2c74019)
• docs(readme): add osx usage instructions (2b64327)
• tests: add more complex test rtf file (20ed0c6)
• tests(index): extend tests (9386e78)
• tests(index): remove broken vt test (a7ac427)
• build(deps-dev): add is-html to test html responses (c03e25d)
• ci(travis): add osx test stage (53f9c34)
• chore: move travis file to root (6158b29)
• feat(index): add support for output for ps and wpml formats (df88f2b)