CHANGELOG
xdg-app-paths

Documentation

• docs ~ (README) sync with JSDocs descriptions ∾ 6ab0c02
• docs ~ JSDocs polish ∾ 0833db2
• docs ~ add cspell dictionary word(s) ∾ 25540e4

Maintenance

• maint (deps): add ‘typedoc’ (dev; for future use) ∾ fd8e7f0

Documentation

• docs ~ revise XDGAppPaths interface/type (show methods not properties) ∾ ca428a4
• docs ~ redefine XDGAppPaths as an interface (for better automatic doc generation) ∾ fa6717c
• docs ~ add JSDocs descriptions ∾ 9765b63

Maintenance

• maint (build): remove unneeded intermediate ‘default’ export object ∾ 6c4d26b
• maint (build): fix CJS type rewrite ∾ 15c007f

Refactoring

• refactor ~ replace intermediate default export object to improve deno docs results ∾ 7d5e0d2

Documentation

• docs ~ README corrections ∾ b68009c

Documentation

• docs ~ add Deno examples using remote imports ∾ d5fb0a9
• docs ~ disable remark lint complaint (maximum-heading-length) ∾ a521003
• docs ~ (README) fix Deno required permissions list ∾ add23f7

Changes

• add support for Deno ∾ 09fb1d3

Documentation

• docs ~ README revisions for Deno ∾ 2d09289
• docs ~ add Deno example ∾ 5a64a43

Maintenance

• maint (dev): add Deno types ∾ 57c6ba7

Refactoring

• refactor ~ add support (Platform.Adapter) for other platforms (eg, Deno) ∾ 1c6405a

Changes

• add support for ‘pkg’ packaged applications ∾ 5d405f2
• add ‘hack’ to correctly auto-generate $name under ts-node/ESM ∾ fb08259
• add ‘hack’ to auto-generate application name for ESM scripts ∾ 43424a3
• add ESM support (via ‘esm-wrapper’) ∾ e4bfa58
• change (API!): add package ‘exports’ to publicize ESM support ∾ aaa478c

Fixes

• fix ~ use ‘an-anonymous-script’ as name for scripts w/o ‘require.main.filename’ ∾ 02dd0c9
• fix remark . complaint (passive voice) ∾ 9378936

Dependency Updates

• update ~ remove unneeded dep ∾ 00330ae

Documentation

• docs ~ polish/update CHANGELOG format template ∾ ee32f02
• docs ~ add cspell dictionary words ∾ 9d552d8
• docs ~ README polish and updates ∾ d2ff230
• docs ~ restore Node-v4+ compatibility for CJS example ∾ 0802c32
• docs ~ add ESM example ∾ 4bb33ea
• docs ~ revise CJS and TS examples (imports, naming, …) ∾ a776960
• docs ~ add XDG reference comment ∾ 58fdbb3
• docs ~ revise spell-checker exceptions ∾ b986eeb
• docs ~ rewrite examples for TypeScript-based package ∾ f3bf949
• docs ~ (package.json) polish module description ∾ 751262d

Maintenance

• maint (CICD): disable NodeJS-v14 on TravisCI (broken TravisCI-side for Linux/NodeJS-v14) ∾ a6a95c6
• maint (CICD): update CI for NodeJS-v10+ build/test requirement ∾ 10fa159
• maint (build): (gitignore) revise for new ‘dist’ packaging model ∾ 370d3db
• maint (build): avoid transpilation for test fixtures ∾ 5399a29
• maint (build): add esm-wrapper to tests build folder ∾ c638dcb
• maint (build): (package.json) update files for ‘dist’ project model ∾ 920cb98
• maint (build): (package.json) declare package support for NodeJS-v4+ engines ∾ ce80dab
• maint (build): (package.json) revise packages tags to advertise support for NodeJS-v4+ ∾ 5fe1e2c
• maint (build): add ‘cjs’ directory to distribution for tools w/o ‘exports’ support ∾ 8073b3e
• maint (build): name revision (tests_ => testbed) ∾ 896663b
• maint (dev): add RemarkLint config ∾ 8a60f98
• maint (dev): update ESLint config for TypeScript-based package ∾ 1d5d1d7
• maint (dev): add CommitLint config ∾ b97c098
• maint (dev): update dep (xdg-portable; for Node-v4+ compatibility) ∾ f2e8831
• maint (dev): revise VSCode ‘ToDO Tree’ settings (ignore ‘vendor’) ∾ 0f8bd67
• maint (dev): (package.json) add rebuild:all script ∾ 6151867
• maint (dev): ignore non-test build folders for code coverage calculations ∾ c046331
• maint (dev): (npm) suppress annoying update messages ∾ 10f5e08
• maint (dev): add rollup config for type bundling ∾ 63c9270
• maint (dev): (package.json) update dev scripts and deps (for dev, new min NodeJS of v10.14+) ∾ a82e531
• maint (dev): add TypeScript ‘tsconfig’ files ∾ 9ae72b3
• maint (dev): add TypeScript dev deps ∾ 79b67ab
• maint (dev): update VSCode settings (includes cspell config/dictionaries) ∾ 8ce27fd
• maint (dev): relocate Prettier config from ‘package.json’ to external file ∾ e707bdb
• maint (dev): update EditorConfig ∾ d5a95b5
• maint (dev): (QA) add CodeClimate config ∾ e8d3139
• maint (dev): (QA) add Codacy configuration (with cloud-side config notes) ∾ a50f0c5

Refactoring

• refactor ~ common code consolidation and changes to improve testability ∾ 6566325
• refactor ~ remove redundant null-coalesce ∾ a55bea2
• refactor ~ remove unneeded manual type specifications ∾ 21722f3
• refactor ~ sort XDGAppPaths type definitions and exports ∾ 38047e0
• refactor ~ minimize use of typeof x to avoid loss of eslint variable tracking ∾ 540bccc
• refactor ~ convert to TypeScript ∾ a228c2f

Fixes

• fix examples (restore Node-v6 compatibility) ∾ a76fe7d

Fixes

• fix ~ remove erroneous devDependency (‘fs@0.0.1-security’) ∾ d9d97ce

Documentation

• docs ~ refactor examples (improved flexibility and robustness) ∾ b4c702d
• docs ~ add CHANGELOG spell-checker exceptions ∾ d26c92e
• docs ~ add TypeScript example ∾ 655beee
• docs ~ polish README ∾ 73414bc

Maintenance

• maint (build): fix package keywords ∾ 0240b3a
• maint (build): include CHANGELOG in distribution file list ∾ ce467f3
• maint (build): update ‘README.md’ filename in package manifest ∾ 708ad3a
• maint (dev): refactor/polish package.json ∾ bdd0cff
• maint (dev): npm script polish ∾ 3c5f95a
• maint (dev): include .history (for VSCode plugin) in .prettierignore ∾ f6fd80c
• maint (dev): include .history (for VSCode plugin) in .gitignore ∾ c58b821

Documentation

• docs ~ README filename change (NPMjs requires ‘README.md’) ∾ b728ae5

Fixes

• fix options normalization logic error ∾ 28857ac

Documentation

• docs ~ polish README badges ∾ 33b40aa
• docs ~ update LICENSE filename ∾ 92257b0
• docs ~ update README ∾ 4feb8c6
• docs ~ update example code (improved appPaths.log()) ∾ 8e12d9f
• docs ~ update README ∾ 14f4c59
• docs (polish): minor comment reformatting ∾ 20610fd
• docs (polish): improved show-paths.js example ∾ 29f9de5

Maintenance

• maint (CICD): add MacOS CI testing ∾ 2da1365
• maint (CICD): synchronize GHA CI name/config ∾ a331ef3
• maint (build): refactor package NodeJS engine compatibility specification ∾ dd45719
• maint (build): update package files for LICENSE and README ∾ 51d31a9
• maint (build): refactor npm scripts ∾ f9e9c4f
• maint (build): update CHANGELOG template with markdown-lint and spell-checker signals ∾ d367cdd
• maint (build): update EditorConfig (include more file types and commentary) ∾ a835c2d
• maint (build): revise and polish npm scripts ∾ 60f91fa
• maint (build): add explanation for NPMrc package-lock=false ∾ c9f6092
• maint (build): reorganize package.json ∾ 0c9c821
• maint (dev): add Prettier ignore file (to simplify automation) ∾ 881586a
• maint (dev): add Prettier ∾ 69e18ad
• maint (dev): XO => ESLint/Prettier (better tooling + TypeScript prep) ∾ 258445b
• maint (dev): change to ‘eslintrc.js’ configuration file ∾ 15af0d2
• maint (dev): add ESLint ∾ 91df9e0
• maint (dev): remove XO ∾ 47d12b5
• maint (dev): add VSCode settings (ENABLE auto-format on save) ∾ 84378e5
• maint (dev): add/update .gitattributes ∾ 62d06d6
• maint (dev): update .gitignore files ∾ 8f13ac7
• maint (dev): add Prettier configuration ∾ c2e9f42

Refactoring

• refactor ~ remove unnecessary extra test for xdg.runtime() ∾ a5fa5d0
• refactor ~ remove unnecessary dirOptions.isolated tests ∾ cfa4ed3
• refactor ~ minimize use of typeof x to avoid loss of linter variable tracking ∾ 3d0a586
• refactor ~ remove unnecessary OS-specific code ∾ 472ea08
• refactor (polish): fix ESLint complaints ∾ 1a3853d
• refactor (polish): prettier re-format ∾ c8330ea

Fixes

• fix npx xo warnings ∾ bbfb8aa

Dependency Updates

• update dependencies ∾ 382ec3c

Maintenance

• maint ~ reconfigure for git-changelog (from GH:rivy-go) ∾ 69611f1
• maint (CICD): add GitHub Actions CI ∾ b893e31
• maint (build): refactor run-scripts for code coverage to run only for Node-v10+ ∾ fba5f36
• maint (build): refactor run-scripts for updated cspell, tsd, and xo to run only for Node-v10+ ∾ 29a92ed
• maint (dev): update editorconfig + whitespace cleanup ∾ 398555d

Refactoring

• refactor ~ add state functions after adding base platform-dependent extension functions ∾ 9632d64
• refactor ~ remove unusual use of return in class constructor ∾ f69c9f2
• refactor repository directory structure prior to typescript (and then deno) conversion ∾ d680042

Documentation

• docs ~ update README badges ∾ 6fdaa5b
• docs ~ add CHANGELOG (via git-chglog) ∾ 1a458ba
• docs ~ update module keywords ∾ 0fd867e

Maintenance

• maint ~ add git-chglog configuration ∾ 64c61e8
• maint (CI): fix CI testing using NodeJS v6 ∾ d1e5192
• maint (build): refactor lint/test run-scripts ∾ ed1f035

Refactoring

• refactor tests for NodeJS v6 compatibility ∾ 612c4c9
• refactor ~ support module use back to NodeJS v6 ∾ 6076f97

Fixes

• fix typescript definitions and testing ∾ 7a99d84

Changes

• change ~ remove dissonant, unneeded temp() method ∾ ceed5d0

Documentation

• docs ~ polish README ∾ 32afd69
• docs ~ improve example ∾ ec43fce
• docs ~ fix broken CI README badges (point to repo master branch) ∾ d043db5

Documentation

• docs ~ fix README example code ∾ 0f4bd17

Maintenance

• maint ~ fix spelling in tests ∾ 2fc9283

Changes

• change ~ remove unneeded ‘flexible’ constructor code ∾ 86704c5

Fixes

• fix parsing of ‘options’ ∾ c43fdb2

Documentation

• docs ~ fix README ∾ 3ebc5d3

Maintenance

• maint ~ add and improve tests ∾ c53aa2e

Refactoring

• refactor ~ convert to ES2015 class notation ∾ ab2b9d7
• refactor ~ revise internal naming ∾ ec56ae1

Documentation

• docs ~ fix and polish README ∾ 2829fe2

Maintenance

• maint ~ improve code coverage testing and reporting ∾ 5636d68
• maint ~ expand testing to include NodeJS v12 ∾ ecf5f9b

Changes

• change ~ improve/update example for new API ∾ 9978c1f
• change ~ API! - change to method-based API ∾ 7d1f8a3
• change ~ rename module to ‘xdg-app-paths’ ∾ 5bc765a
• change ~ remove ‘.default’ export ∾ 7b21ad2
• add example ∾ bb51888

Documentation

• docs ~ update/improve README ∾ db03fab

Maintenance

• maint ~ add coverage testing ∾ 37f5a69
• maint ~ be strict about node version ∾ a3b98dc
• maint ~ improve linting support for IDEs ∾ 4aa4407
• maint ~ add AppVeyor CI ∾ 3dea7e5

Refactoring

• refactor ~ use ‘xdg-portable’ ∾ 1c016d1

Documentation

• docs ~ polish and add XDG references ∾ 1696b46

Changes

• add improved XDG support (CONFIG_DIRS and DATA_DIRS) ∾ c6a250b
• add cross-platform XDG support (plus comment polish) ∾ 4d87f8d
• add note about the user needing to create the actual directories ∾ 294db55

Fixes

• fix ~ windows ‘data’ should roam with user ∾ a0b2f75

Maintenance

• maint ~ comment polish ∾ dab0324
• maint ~ add README linting and corrections ∾ aaf1e6c
• maint ~ add spell-checker exceptions ∾ bf9d759

Refactoring

• refactor ~ reorganize properties ∾ f376e0c

Refactoring

• refactor TypeScript definition to CommonJS compatible export (#12) ∾ dacf4e9

Changes

• add TypeScript definition (#11) ∾ 949cd22

No changelog for this release.

Fixes

• fix incorrect paths on Linux (#6) ∾ 3a2ba84

No changelog for this release.

Fixes

• fix usage example ∾ 88a5908

Changes

• add suffix to prevent possible conflict with native apps ∾ c2fda19

No changelog for this release.