CHANGELOG
os-paths

---

v5.1.0 (2021-01-01)

Fixes

• fix Codacy/ESLint complaint (require:camelCase) ∾ 6f72de3

Documentation

• docs ~ CHANGELOG update ∾ 7e1c55e
• docs ~ add spell-checker exceptions to CHANGELOG ∾ 3864554
• docs ~ README fixes and polish ∾ a5c729c
• docs ~ update CDN installation URL in README (use ‘latest’ instead of ‘master’) ∾ af3be58
• docs ~ update example ESLint directives for Codacy QA compatibility ∾ eb394db
• docs ~ refactor/consolidate ESLint directives for examples ∾ c826d6b

Maintenance

• maint/CI: show list of all deps after npm install ∾ a877a5c
• maint/dev: (QA) add Codacy configuration ∾ e252e69
• maint/dev: add ‘show:deps’ script for deps display during CI ∾ 1853b98
• maint/dev: fix ‘help’ script ∾ 8438dff
• maint/dev: add VSCode wanted/un-wanted recommendations for extensions ∾ a2d9b74
• maint/dev: (deps) bypass broken ‘eslint-plugin-functional’ v3.2.0 ∾ 4974a9d
• maint/dev: fix npm dev ‘update’, ‘prepublishOnly’, and ‘preversion’ scripts ∾ 59a2b52
• maint/dev: change ESLint config to align with Prettier style (for Codacy QA) ∾ 22f3971
• maint/dev: (fix) align ESLint config with Codacy QA rules ∾ a5ec1b5
• maint/dev: (ESLint) add upper-bound for cyclomatic complexity of functions ∾ 98020dc
• maint/dev: add ESLint ‘security’ and ‘security-node’ plugins ∾ 28849a0
• maint/dev: ‘warn’ (instead of ‘error’) on unused ESLint comments ∾ 2229e6e
• maint/dev: (QA) add Scrutinizer config ∾ da032a4
• maint/dev: (QA) add CodeClimate config ∾ 908a0dd
• maint/dist: update ∾ 58f2706

Refactoring

• refactor ~ improve name semantics ∾ dece1a4
• refactor ~ extract common module reference ∾ 5ce6945
• refactor ~ use functional replacements for complicated ternary expressions ∾ e591e96

---

v5.0.1 (2020-12-28)

Fixes

• fix code coverage for current problems with instrumenting ESM modules under nyc ∾ d78b19d

Documentation

• docs ~ fix CDN installation URL in README ∾ fc510cf
• docs ~ update CHANGELOG ∾ c92ed1b

Maintenance

• maint/dist: update ∾ fd36a34

---

v5.0.0 (2020-12-28)

Changes

• change/API!: home() returns undefined when path is indeterminate ∾ 39c5d6a
• change/API!: robustly fall back to env vars if empty returns by ‘standard’ functions ∾ 6c9e8b8
• change/API!: return empty strings for indeterminate directories (instead of current directory) ∾ cfa78e9

Fixes

• fix Codacy/ESLint complaint (no-undefined) ∾ c246d38
• fix ‘codacy’ complaints (use ===) ∾ 1a9a99d
• fix npx eslint test complaints ∾ 6a40429
• fix npx eslint src complaints ∾ a056c41

Documentation

• docs ~ update CHANGELOG ∾ 45a298f
• docs ~ add spell-checker exceptions ∾ f70e550
• docs ~ fix CHANGELOG references ∾ 5f84663
• docs ~ add/remove spell-checker exceptions ∾ e9aa62e
• docs ~ polish README ∾ 6aea752
• docs ~ fix CHANGELOG repository reference ∾ 3b34301
• docs ~ refactor common code in examples ∾ 9858599
• docs ~ refactor JS example ∾ 3f0fad5
• docs ~ fix npx eslint eg complaints ∾ 71daafb
• docs ~ add TypeScript-based example ∾ 17282b6
• docs ~ change example to use TypeScript-built library ∾ 1922935
• docs ~ fix bug/typo in example code ∾ 90f42bf

Maintenance

• maint/build: convert build to target ‘dist’ (includes dev script updates) ∾ 0c7c6c7
• maint/build: (gitignore) recognize ‘dist’ ∾ 0d9dbed
• maint/build: change to CJS as default TypeScript output ∾ c1597f1
• maint/build: add ‘node-v6’ tag ∾ 86638e4
• maint/dev: refactor/polish ESLint configuration ∾ 77d6e0d
• maint/dev: change default TAB size to 2 ∾ 8a1625c
• maint/dev: teach ESLint to overlook “ignored” args/vars with leading underscores (‘_’) ∾ 5e4480c
• maint/dev: add Remark-based markdown linting ∾ 288c552
• maint/dev: add commentary regarding ESLint rules ∾ 5599a28
• maint/dev: update VSCode settings (hide distracting dev-only info) ∾ 4a30125
• maint/dev: fix prepublishOnly dev script dependency order (update after build/test) ∾ e30bfbf
• maint/dev: fix ‘preversion’ as duplicate of ‘prepublishOnly’ to avoid missing/stale artifacts ∾ 7f0d7ae
• maint/dev: consolidate and update TS config files ∾ d762e97
• maint/dev: fix publish dev scripts ∾ c846cb6
• maint/dev: add/improve package dev scripts (with required dev deps) ∾ 2983f4c
• maint/dev: convert to TypeScript ∾ 3cf0552
• maint/dev: enable ESLint TypeScript configuration ∾ 55e5d0c
• maint/dev: add TypeScript dev deps ∾ 9f38817
• maint/dist: update distribution ∾ a6dac95
• maint/dist: update prior to version update ∾ 19135f3

Refactoring

• refactor ~ remove disabled/redundant code, ‘use strict’, and ESLint directives ∾ 43e9361
• refactor ~ use usual ‘path’ as the name for import ... 'path' ∾ 664db74
• refactor ~ explicitly test for os.homedir/tmpdir as functions ∾ 42c3f41
• refactor ~ simplify OSPaths construction/constructor ∾ 8e55fa3
• refactor ~ re-organize source code (within ‘src’) ∾ 205e726

---

v4.4.0 (2020-12-15)

Changes

• change ~ normalize all paths and strip any trailing path separators ∾ 943a0ac

Fixes

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

Documentation

• docs ~ update README (mention path normalization) ∾ b9d1b55
• docs ~ refactor example ∾ 214873f
• docs ~ polish README ∾ 9d70297
• docs ~ simplify example (removing extra developer deps) ∾ 2be36d3

Maintenance

• maint/build: fix package keywords ∾ 3c06c4a
• maint/build: add CHANGELOG.mkd to distribution file list ∾ 888775c

Refactoring

• refactor ~ use common normalizing function for returned paths ∾ c56de7a

---

v4.3.0 (2020-12-13)

Documentation

• docs ~ polish README ∾ ac1e371
• docs ~ add spell-checker exceptions ∾ dce522c
• docs ~ README fix and polish ∾ 43bc088
• docs ~ git-changelog > CHANGELOG.mkd ∾ 19520e5

Maintenance

• maint/CICD: add GitHub Actions (GHA) CI ∾ 4202298
• maint/build: update eslintrc (and convert to JS file) ∾ 06e0167
• maint/build: add explanation for NPMrc package-lock=false ∾ ada889c
• maint/build: add LICENSE + README to set of distributed files ∾ e020a4a
• maint/build: remove ESlint config forcing ESM-type unit.test.js ∾ 69b155b
• maint/build: fix tsd complaint (types specification missing from package “files” list) ∾ fd87126
• maint/build: revise and polish npm scripts (include deps) ∾ 2b23875
• maint/build: refactor/reorganize package.json ∾ 2d6f509
• maint/build: refine package ‘engine’ value (best legibility/specificity) ∾ be185d0
• maint/dev: npm script polish ∾ a7212d5
• maint/dev: add Prettier ignore file (to simplify automation) ∾ fb7b8c6
• maint/dev: add Prettier configuration ∾ c5819ed
• maint/dev: add Prettier ∾ 94ffae4
• maint/dev: add notation about ava and nyc version restrictions with NodeJS-v6 ∾ 71ed02a
• maint/dev: add .history (for VSCode plugin) to ESlint config ignore list ∾ 039acdb
• maint/dev: add ESLint (with plugins) ∾ 3f82e96
• maint/dev: remove XO ∾ b4db615
• maint/dev: add .history (for VSCode plugin) to Prettier ignore list ∾ e4eff74
• maint/dev: add VSCode settings (ENABLE auto-format on save) ∾ 74d2ef5
• maint/dev: polish package.json format ∾ 52d4f0c
• maint/dev: add pre-test and CHANGELOG update to npm version ... ∾ 2553998
• maint/dev: npm version ... CHANGELOG update only if git-changelog available ∾ c6cddab
• maint/dev: revise gitignore files to include build artifacts ∾ 95db0d4
• maint/dev: revise gitattributes ∾ dd6647a
• maint/dev: update EditorConfig (include more file types and commentary) ∾ 3ae7869
• maint/dev: add .history (for VSCode plugin) to .gitignore ∾ 0251a8b
• maint/dev: reconfigure for git-changelog (from GH:rivy-go) ∾ 4f96b41

Refactoring

• refactor ~ change LICENSE and README file names to UPPERCASE for improved discoverability ∾ 68904bb
• refactor ~ partition code into ‘src’ and ‘test’ directories ∾ 1f93e19
• refactor/polish: fix ESLint complaint (‘no-unused-disable’) ∾ d5b9386
• refactor/polish: prettier reformat ∾ 5680208

---

v4.2.0 (2019-10-17)

Documentation

• docs ~ polish keywords, comments, and README documentation ∾ 348d5a7

Maintenance

• maint/build: add local coverage and prepublish test scripts ∾ 7c16178

---

v4.1.0 (2019-10-04)

Documentation

• docs ~ improve README badges ∾ a354862

Maintenance

• maint/build: fix/update dev dependencies ∾ de871cb

---

v4.0.1 (2019-10-04)

Documentation

• docs ~ fix CHANGELOG title and URLs ∾ 5458236

Maintenance

• maint/build: fix CHANGELOG generator configuration ∾ acb315d

---

v4.0.0 (2019-10-02)

Changes

• change/API!: change module focus to only OS-associated paths, using a method-based API ∾ a18b948

Documentation

• docs ~ add example script ∾ 43ea4ca
• docs ~ update README ∾ ea09e79
• docs ~ change package description and keywords ∾ f993fb9
• docs ~ add CHANGELOG ∾ d8b964c

Maintenance

• maint ~ improve linting support for IDEs (using ‘eslint’) ∾ c64ce55
• maint ~ update EditorConfig configuration for better TAB display ∾ 15ac24f
• maint/CI: add AppVeyor CI configuration ∾ 4f3b933
• maint/CI: add Travis CI configuration ∾ 0c5dfb7
• maint/CI: add code coverage support and reporting ∾ 27f5df4
• maint/build: add tests for correct spelling ∾ ab911b1
• maint/build: refactor testing commands ∾ e962f1d
• maint/build: add CHANGELOG (git-chglog) configuration ∾ e5bb024
• maint/build: add ‘lint’ run-script command ∾ 6d279b8
• maint/build: refactor run-scripts to use npm-run-all ∾ 2ca1ddf
• maint/build: expand file set for spell checking ∾ 334683b
• maint/build: gate spell-check to NodeJS >= v8 ∾ f737d15
• maint/build: refactor run-scripts ∾ c453ad7

---

v3.0.2 (2019-06-29)

Documentation

• docs ~ polish and add XDG references ∾ 1696b46

---

v3.0.1 (2019-06-29)

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

---

v2.2.0 (2019-04-01)

Refactoring

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

---

v2.1.0 (2019-03-04)

Changes

• Add TypeScript definition (#11) ∾ 949cd22

---

v2.0.0 (2018-11-05)

No changelog for this release.

---

v1.0.0 (2017-01-10)

Fixes

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

---

v0.3.1 (2016-10-18)

No changelog for this release.

---

v0.3.0 (2016-07-02)

Fixes

• fix usage example ∾ 88a5908

---

v0.2.0 (2016-06-24)

Changes

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

---

v0.1.0 (2016-06-21)

No changelog for this release.