CHANGELOG
xdg-portable

Changes

• change ~ improve type exports for static tooling (eg, Intellisense) ∾ 02ebd58

Documentation

• docs ~ disable remark lint complaint (maximum-heading-length) ∾ 1307b3a
• docs ~ README corrections ∾ 9d3060a
• docs ~ CHANGELOG update ∾ de29ea8
• docs ~ revise/update CHANGELOG template ∾ 7d1310f
• docs ~ (README) fix markdownlint complaint (first-line-h1) ∾ 2b23408
• docs ~ remove simplistic (distracting) JSDocs @example’s ∾ 66e8864
• docs ~ (README) add type notes ∾ d298c90

Refactoring

• refactor ~ improve CJS ESM-wrapper ∾ b8df673

Documentation

• docs ~ (README) add archival links ∾ 8af9631
• docs ~ add cSpell word exceptions ∾ d2fc3e1
• docs ~ README polish ∾ b6e463d
• docs ~ (README) revise spell-checker exceptions ∾ 679a5eb
• docs ~ (README) additional Deno notations ∾ 4e5ced3
• docs ~ use ‘xdg’ as the deno.land module name for Deno imports ∾ 0aeefb9

Maintenance

• maint (dev): (scripts) build in series (await parallel shx mkdir fix) ∾ 8c369d9
• maint (dev): remove now-unneeded rollup configs for CJS and ESM ∾ 5a6a4a4

Changes

• add Deno platform compatibility ∾ eae3269

Documentation

• docs ~ add Deno example ∾ 3daf730
• docs ~ README update for Deno ∾ ca35952

Maintenance

• maint (dev): add Deno types ∾ 54f9696
• maint (dist): update ∾ ba37ee8

Documentation

• docs ~ add JSDocs tags to Platform.Adapter methods and properties ∾ 94f4687
• docs ~ update CHANGELOG (restore original v5.0.0) ∾ 6abd7e4

Maintenance

• maint (build): ignore ‘vendor’ for linting ∾ e5b5a44
• maint (dev): update to git-changelog v1.1 (for use of --next-tag-now) ∾ 108a166
• maint (dev): npm dev script polish (comments) ∾ 1424e85
• maint (dev): (QA/Codacy) add notes for Codacy website setup of ESLint and RemarkLint (per project) ∾ 19f1bda

Refactoring

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

Fixes

• fix ~ add ‘cjs’ directory to distribution file list (as previously intended) ∾ 46500b9

Changes

• add ESM support (via ‘esm-wrapper’) ∾ 6d7de51
• change (API!): add package ‘exports’ to publicize ESM support ∾ de48f6d

Fixes

• fix EditorConfig complaint (leading spaces) ∾ 9e8d679
• fix erroneous type declarations for CJS vs ESM/TypeScript ∾ 77e96bb

Documentation

• docs ~ add specific CJS, ESM, and TypeScript examples ∾ 8461398
• docs ~ README update (for v8.0.0) ∾ 1121880
• docs ~ update CHANGELOG (includes a parallel ‘v5.0.0’) ∾ 7946252
• docs ~ polish JSDocs ∾ f28e26d
• docs ~ README polish (shields) ∾ a8318d1
• docs ~ README updates and polish ∾ 3e3fbd7
• docs ~ README edits and polish ∾ f601bce
• docs ~ harmonize and polish package and method descriptions ∾ 2815ba8
• docs ~ fix remark . complaint (passive voice) ∾ 2220695
• docs ~ update CHANGELOG ∾ 6146cdd
• docs ~ change examples to show properties and methods of project object ∾ 844c533
• docs ~ add cspell dictionary words ∾ 79feea9
• docs ~ example updates for ‘dist’ project model ∾ 6d8f49c
• docs ~ fix ESLint complaints in examples ∾ c9873b5
• docs ~ (package.json) polish module description ∾ 0c5a878

Maintenance

• maint (CICD): update CI for NodeJS-v10+ build/test requirement ∾ fdb8180
• maint (build): (package.json) declare package support for NodeJS-v4+ engines ∾ 604c1ee
• maint (build): normalize ‘build’ directory structure ∾ 6007cc0
• maint (build): (package.json) update main/types and files for ‘dist’ project model ∾ 579421c
• maint (build): (package.json) specify ‘CommonJS’ as package type ∾ 498b396
• maint (build): (package.json) use the common ‘exports’ type ∾ 1316032
• maint (build): (package.json) polish dev scripts ∾ 894c8ec
• maint (build): add ‘cjs’ directory to distribution for tools w/o ‘exports’ support ∾ 52975e7
• maint (build): add ‘./cjs’ exports subpath to advertise correct types for CJS ∾ 9f1ce88
• maint (build): clean up and increase ‘prepublishOnly’ robustness ∾ 20d0f17
• maint (build): fix ‘dist’ packing to allow publishing ‘–dry-run’ testing ∾ c492703
• maint (build): use ‘succeeded’ signal files as build targets (improve build robustness) ∾ 8ec629b
• maint (build): (package.json) polish dev scripts ∾ 53c494d
• maint (dev): update EditorConfig ∾ 08a79fe
• maint (dev): (package.json) rephrase package tags for node version support ∾ 3b34da8
• maint (dev): (package.json) reorganize ‘exports’ ∾ ab1f1c3
• maint (dev): (npm) suppress annoying update messages ∾ d930c0e
• maint (dev): (deps) improve ‘exec-if-updated’ reference ∾ 5f722a4
• maint (dev): update Remark markdown-linting configuration and plugins ∾ 7c3c1b9
• maint (dev): (QA) add CodeClimate config ∾ 88c7c80
• maint (dev): (QA) add Codacy configuration ∾ 4dee2fc
• maint (dev): relocate Prettier config from ‘package.json’ to external file ∾ 4310b38
• maint (dev): (gitignore) ignore ‘dist’ target ‘succeeded’ files ∾ b55663b
• maint (dev): use forked exec-if-updated (await upstream exec-if-updated fixes) ∾ 2d2336f
• maint (dev): fix ‘dist’ update regen targets ∾ 7474d90
• maint (dev): (gitignore) revise for ‘dist’ packaging model ∾ 9c80620
• maint (dev): add ‘editorconfig-checker’ linting ∾ 60de572
• maint (dev): add commitlint configuration ∾ 1d5aaeb
• maint (dev): refactor ESLint for project change to TypeScript ∾ 5411de2
• maint (dev): add Rollup support (for generation of ESM with correct extensions) ∾ 11a43a0
• maint (dev): update npm dev scripts and dev deps (for dev, new min NodeJS of v10.14+) ∾ 9b6e7d1
• maint (dev): add TypeScript ‘tsconfig’ files ∾ 1bb46e7
• maint (dev): add TypeScript dev deps ∾ 9f7aac0
• maint (dev): update VSCode settings (includes cspell config/dictionaries) ∾ ef6aff2
• maint (dist): update ∾ 6e73ed8

Refactoring

• refactor all internal module imports to use fully-specified paths (with extensions) ∾ c84e2dd
• refactor ~ improve XDG function naming/definition ∾ 5cf2b18
• refactor ~ reduce code duplication ∾ f9c5202
• refactor ~ merge/simplify path construction calls ∾ 3c58a5d
• refactor ~ build/return XDG instead of XDGPortable ∾ b6a48c8
• refactor ~ convert to TypeScript ∾ e356726

Fixes

• fix ~ remove erroneous devDependency (‘fs@0.0.1-security’) ∾ de6b7e8
• fix test type declarations for configDirs() and dataDirs() ∾ 35c5691

Documentation

• docs ~ add CHANGELOG spell-checker exceptions ∾ e4a51e3
• docs ~ README polish ∾ c017d0b
• docs ~ correct spell-check errors ∾ 37a31bd
• docs ~ simplify examples (removing extra developer deps) ∾ 3000c70

Maintenance

• maint ~ reconfigure for git-changelog (from GH:rivy-go) ∾ d3bd66d
• maint (CICD): add GitHub Actions (GHA) CI ∾ a292f58
• maint (build): add CHANGELOG.mkd to distribution file list ∾ f187500
• maint (build): update CHANGELOG template with markdown-lint and spell-checker signals ∾ cfa2185
• maint (build): polish package.json formatting ∾ e81e8f3
• maint (build): reorganize ‘package.json’ ∾ ff7988a
• maint (build): refine package manifest ∾ f5acb16
• maint (build): revise and polish npm scripts ∾ c6ed305
• maint (build): add explanation for NPMrc package-lock=false ∾ 570f464
• maint (build): update EditorConfig (include more file types and commentary) ∾ 6428093
• maint (build): expand/polish npm run ... scripts (with dep updates) ∾ 26f6c52
• maint (build): fix tsd complaint (types specification missing from package “files” list) ∾ 5570547
• maint (build): fix package keywords ∾ 446854f
• maint (dev): update ‘eslintrc.js’ configuration file ∾ 601de10
• maint (dev): remove XO (xo) ∾ 4d47f8a
• maint (dev): revise gitignore files to include build artifacts ∾ 8f9a93e
• maint (dev): revise gitattributes ∾ a291753
• maint (dev): fix ESLint configuration file format (JSON => JS) ∾ b06aa7c
• maint (dev): add Prettier (prettier) ∾ 506493b
• maint (dev): add Prettier configuration ∾ 70b003b
• maint (dev): add Prettier ignore file (to simplify automation) ∾ 1c13258
• maint (dev): add notation about ava and nyc version restrictions with NodeJS-v6 ∾ 18567d0
• maint (dev): add VSCode settings (ENABLE auto-format on save) ∾ 1b42a25
• maint (dev): add .history (for VSCode plugin) to .gitignore ∾ 65b33ee
• maint (dev): add ‘.history’ (used by VSCode extension) to .prettierignore ∾ 792b967
• maint (dev): npm script polish ∾ 0e5ddc0
• maint (dev): add ESLint (eslint) ∾ e689bde

Refactoring

• refactor ~ consolidate source code into ‘src’ directory ∾ d4e4ba5
• refactor ~ consolidate testing code into ‘test’ directory ∾ cdabf1c
• refactor (polish): fix ESLint complaints ∾ da3bedb
• refactor (polish): npx prettier . --write re-format ∾ a4fe2f4

Documentation

• docs ~ update module keywords ∾ 2959218

Maintenance

• maint (build): fix missing dev dependencies ∾ 4ba5ac4

Documentation

• docs ~ update README badges ∾ 8d2ca20
• docs ~ add CHANGELOG ∾ 14f2fe6

Maintenance

• maint (CI): add testing for NodeJS v6 ∾ be98a00
• maint (build): refactor lint/test run-scripts ∾ 5b5b151
• maint (build): add CHANGELOG (using git-chglog) configuration ∾ f4b46e1

Refactoring

• refactor ~ support module use back to NodeJS v6 ∾ ff43b02

Fixes

• fix typescript definitions and testing ∾ 8c3c6d8

Documentation

• docs ~ fix broken CI README badges by pointing to repo master branch ∾ 8af5009

Documentation

• docs ~ fix README usage example ∾ 963fcd4

Documentation

• docs ~ add example with more object detail ∾ 338ca45
• docs ~ polish README ∾ 5e76c92

Maintenance

• maint ~ add alternate construction test ∾ 980f267

Refactoring

• refactor ~ clean up internal naming ∾ 68100c0

Documentation

• docs ~ fix and polish README ∾ 8da6270

Maintenance

• maint ~ add OSX CI testing ∾ a80dc4c
• maint ~ improve code coverage testing and reporting ∾ 89b2655

Refactoring

• refactor platform testing code ∾ d34f19f

Changes

• add npm cover script ∾ 8764397
• add AppVeyor CI ∾ 8c7741a
• change from property to method interface ∾ 7b29508
• change ~ remove ‘.default’ export ∾ 655453f

Documentation

• docs ~ add/update README badges ∾ 4f03c45
• docs ~ README update ∾ 58133d6

Refactoring

• refactor ~ hoist common code from platforms into main module ∾ 90aa8bc
• refactor ~ improve tests ∾ 5cb8616

Fixes

• fix os.tmpdir() fallback logic ∾ c1ee2ea

Changes

• add eslint support ∾ f91b369
• add os.tmpdir() as a fallback for os.homedir() ∾ 47cb028
• change ~ cleanup type info and tests ∾ 6bbd9f3
• add STATE directory support ∾ 1023d63
• add example ∾ 189b29e

Documentation

• docs ~ polish README ∾ d678235
• docs ~ update description and README ∾ 8e11070

Refactoring

• refactor ~ fix lint warnings ∾ 15555e1
• refactor ~ reorder tests ∾ dc035e5
• refactor ~ reorder/sort function definitions ∾ 52ef262

Changes

• add cross-platform compatiblity ∾ cfb3467

Maintenance

• maint ~ ‘5.0.0’; uploaded to npmjs on 2019-06-22 ∾ c4993e6

No changelog for this release.

Dependency Updates

• update tests for latest AVA version ∾ 85a4aaa

Fixes

• fix XDG_CACHE_HOME + tests ∾ d75b14d

Dependency Updates

• update .travis.yml ∾ cd4a8b3

Pull Requests

• Merge pull request #1 from chocolateboy/fix_xdg_cache_home_and_tests

No changelog for this release.

No changelog for this release.