CHANGELOG
os-paths

This project adheres to Semantic Versioning.
The changelog format is based on Keep a Changelog using conventional/semantic commits.^@

v7.4.0 (2023-02-06)

[v7.4.0; details]

Fixes

bugfix ~ (package) work-around for npm publish bug (see GH:npm/cli#6137) ∾ d6bedcc

Documentation

docs ~ fix updated ESLint complaints (eslint-comments/no-unused-disable) ∾ a725016
docs ~ (README) revise setup/build/test instructions ∾ 8e44fb8
docs ~ (README) refine install instructions and URLs ∾ 174d857
docs ~ polish/update cspell dictionary words ∾ 8c3e117
docs ~ (README) fix GitHub CI badge (shields.io change; see GH:badges/shields/issues/8671) ∾ ae9954d
docs ~ (README) remove TravisCI badges ∾ ee8b9d5
docs ~ update cspell dictionary words ∾ b4a41f6

Maintenance

maint (CICD): (TravisCI) remove TravisCI (TravisCI no longer supports FOSS) ∾ 6bfd098
maint (CICD): (TravisCI) suppress NodeJS-v18 testing (TravisCI install is defective) ∾ e8556d9
maint (build): (package) add color to 'help' output ∾ 672a31e
maint (build): (package) enable handling of scoped package names ∾ f32d346
maint (build): prepare support for 'modern' v2+ yarn ∾ 53e94be
maint (build): (package) fix coverage logic and move storage to less visible location ∾ 57d3113
maint (build): (package) fix coverage HTML output target ∾ 489ebfb
maint (build): (package) add final NL for non-WinOS output equivalence ∾ 0574294
maint (build): (package) add npm audit linter ∾ a89d8ae
maint (build): (package) remove 'rimraf' (use shx rm -fr ...) ∾ 0e0b6df
maint (build): add bmp configuration ∾ 8ea780f
maint (build): revise various configs for 'modern' v2+ yarn use ∾ 483b4a5
maint (deps): update deps locks (NodeJS v10.23.1, npm v7.24.2, yarn v1.22.19) ∾ b8cc4d3
maint (dev): (markdown-lint/Remark) update config; adds dual use (Deno or NodeJS projects) ∾ 9f8eac3
maint (dev): (Prettier) update config; adds dual use (Deno or NodeJS projects) ∾ 21fc281
maint (dev): (ESLint) update config; merge Deno and JS configs ∾ d5d73f5
maint (dev): (CommitLint) update config; add relaxed linting for development + rule tweaks ∾ 7d28a76
maint (dev): (git-changelog) configuration and template updates ∾ 095d2ea
maint (dev): (ESLint) enable built-in 'reportUnusedDisableDirectives' ∾ 24403a4
maint (dev): (deps) revise/loosen eslint related deps ∾ ba718a2
maint (dev): (gitignore) update notes ∾ 96264b7

v7.3.0 (2022-08-13)

[v7.3.0; details]

Documentation

docs ~ update cspell dictionary words ∾ 0254c06
docs ~ (README) revise Package/Publish notes (removing tag/version check) ∾ 65133ce

Maintenance

maint (CICD): (GHA) expand NodeJS test versions ∾ 6f5f382
maint (CICD): (GHA) add platform label to coverage uploads (via --flags=...) ∾ 434037d
maint (build): (package) revise 'cov:send' to support user-defined options ∾ b813de9
maint (build): (package) add '_:debug:env' run target ∾ f6ed4c6
maint (build): (package) revise help generation to match HELP_TEXT more narrowly; add commentary ∾ dfbccbc
maint (build): (package) revise and surface availability of test harness options to user ∾ 171d193
maint (build): (package) commit linters now check more deeply/robustly into past commits ∾ d7f01c7
maint (dev): add CodeCov config (reports will be solely informational/no-fail) ∾ 143e7b1
maint (dev): revise cspell to allow local exceptions ∾ 7436a9b
maint (dev): update CommitLint configuration ∾ b523f92

Test Improvements

test (refactor): move version consistency checks from package lint to distribution test ∾ 6db56d6

v7.2.0 (2022-08-09)

[v7.2.0; details]

Dependency Updates

update Deno deps (down-to std@0.134.0; pin); avoid permission prompt(s) ∾ dc1091c

Documentation

docs ~ (README) revise package locks update instructions ∾ fc55f1f

Maintenance

maint (CICD): (TravisCI) expand NodeJS test versions ∾ b28cae5
maint (build): add refresh (aka rebuild:all) and refresh:dist run targets ∾ 9e3a1d2
maint (dev): expand/revise coverage exclusion regex ∾ a6f9783
maint (dev): update CI/dev deps-lock ∾ 01b9b11
maint (dev): (gitattributes) remove top-level .deps-lock specifics (favor local config) ∾ d7a12d5

Test Improvements

tests ~ refactor var naming for clarity/consistency ∾ 7b8478d
tests ~ revise skip text for clarity ∾ 3122ede
tests ~ restyle spell-checker exceptions for clarity ∾ 0f9bf69

v7.1.1 (2022-08-06)

[v7.1.1; details]

Documentation

docs ~ (README) improve Packaging/Publishing instructions ∾ d69a42d
docs ~ (eg) update os-paths import versions ∾ 3b2ce8a

Maintenance

maint (dev): (package) refactor 'prerelease' and 'prepublishOnly' for clarity ∾ a703135

v7.1.0 (2022-08-06)

[v7.1.0; details]

Dependency Updates

update Deno deps (up-to std@0.150.0) ∾ 23a8bc6

Documentation

docs ~ (eg) update os-paths import versions ∾ d916d0e

Maintenance

maint (dev): (package) fix 'rebuild:lab' to include a copy of esm-wrapper ∾ 53e7941

Test Improvements

tests ~ add any STDERR output to test logs ∾ 1979af4
tests ~ version gate Deno tests ∾ a90b501

v7.0.0 (2022-07-31)

[v7.0.0; details]

Changes

change (!): add graceful degradation for missing permission(s) (avoiding Deno panic or prompt) ∾ bb49eaf

Fixes

fix (deps): hack around early version npm ci failure ∾ 4907941

Dependency Updates

update Deno deps (up-to std@0.143.0) ∾ 31d9600

Documentation

docs ~ (README) update versions for import examples ∾ f3d8ccd
docs ~ (README) add minimum Deno version requirement note ∾ c9360ad
docs ~ (README) polish wording ∾ 5e63c14
docs ~ (README) stabilize formatting against changes by deno and/or dprint formatters ∾ d87a6f0
docs ~ (README) updated build/contribution documentation ∾ 4884af6
docs ~ (README) add packaging and publishing notes ∾ 4b86808
docs ~ (gitignore) mention gitignore.io for templated generation ∾ 99ee208
docs ~ (eg) add Deno permission check/feedback to examples ∾ 521608c
docs ~ note possible alternative to search list for POSIX temp dir discovery ∾ 8d00cb0
docs ~ update spell-checker exception dictionaries ∾ e37e8bb
docs ~ (README) revise spell-checker exceptions ∾ 13d8b01
docs ~ (README) avoid unwanted formatting with directives ∾ 328564f
docs ~ (README) fix markdown-lint complaint (first-line-heading) ∾ d821f6c

Maintenance

maint (CI): (Travis) test on both 'linux' and 'osx' platforms ∾ 639a8d5
maint (CI): update CI config (adds version stamp) ∾ b40a7ed
maint (build): refactor with 'cross-env' to increase yarn compatibility ∾ d08684a
maint (build): add rebuild:all run target ∾ d470224
maint (build): fix --dry-run flag manipulation for dist packaging ∾ 79d607d
maint (build): add prerelease run target ∾ 9fe50fe
maint (build): improve Prettier lint feedback ∾ dd0585b
maint (build): (package.json) add verbose test support and revise 'prerelease' ∾ 2e9e190
maint (build): improve run target feedback (include both stderr/stdout for error reports) ∾ 0c21e08
maint (build): (coverage) ignore intermediate build artifacts when calculating coverage ∾ f23fafc
maint (build): suppress extraneous Prettier fix and lint output ∾ 807fee3
maint (build): move 'update-dist.succeeded' target to 'build' intermediate directory ∾ 6005669
maint (build): name revision (testbed => lab) ∾ 992e13d
maint (deps): narrow version of 'typescript' (to satisfy 'typedoc'/'typescript-eslint') ∾ db0ac06
maint (deps): remove unused 'coveralls' ∾ ced7a15
maint (deps): store package locks (for CI/dev reproducibility) ∾ b042578
maint (deps): pin 'open-cli' to v6.0 (o/w v7.0 requires NodeJS v14+) ∾ b7b4bf6
maint (deps): update to 'exec-if-updated' v2.2.0 (via jsDelivr) ∾ c3d1d51
maint (deps): pin 'remark-cli' to v9.0.0 (o/w v10+ requires NodeJS v12+) ∾ 3c73a11
maint (dev): update vendored deno types (up-to Deno v1.8.0) ∾ 96a2280
maint (dev): merge and update CommitLint configuration files ∾ 05ca208
maint (dev): (QA) update Codacy configuration ∾ 5588550
maint (dev): update git-changelog configuration (add version stamp) ∾ cefcc3e
maint (dev): update ESLint configuration (polish) ∾ 002da0c
maint (dev): update Prettier configuration (polish) ∾ e529af4
maint (dev): update rollup configuration (polish) ∾ 875e8c0
maint (dev): configure git for storage of package lock files within '.deps-lock' ∾ 5febc49
maint (dev): update EditorConfig (fix spelling + support nushell configs) ∾ 5ccfa2d
maint (dev): (QA/Scrutinizer) ignore 'vendor' (third-party content) ∾ 6928201
maint (dev): (gitattributes) fix spell-checker complaints ∾ 9a86220
maint (dev): (gitignore) fix spell-checker complaints ∾ 54e5646
maint (dev): (git-changelog) fix/revise config to show test improvements ∾ efa2ba2
maint (dev): (QA) update CodeClimate configuration ∾ f83f74f
maint (dev): (git-changelog) remove extra leading newlines for 'Notes' construction ∾ 476d2c0
maint (dev): (QA) update CodeClimate config ∾ 26244b7
maint (dev): (QA) update Codacy config ∾ 67560f3
maint (dev): update Remark (markdown-linting) configuration (adds version stamp) ∾ aa864dc
maint (dev): add (and use) EditorConfig-checker configuration ∾ c1aa7c3
maint (dev): revise rollup type bundling process ∾ 8e26398
maint (dev): update git-changelog configuration ∾ 7bcee03
maint (dev): update Prettier config and ignore settings ∾ ee23319
maint (dev): update ESLint configuration (adds version stamp) ∾ f07e13f
maint (dev): update EditorConfig ∾ 81a0a5e
maint (dev): update VSCode settings ∾ 26ed28e
maint (dev): revise/update TypeScript 'tsconfig' files ∾ b3e0378
maint (dev): (git-changelog) add support for Type followed by '!' ∾ 79bff10
maint (dev): (gitignore) add ignored files and version stamp ∾ 26fc9f4
maint (dev): (gitattributes) revise commentary and add version stamp ∾ 2b76c0d
maint (dev): (git-changelog) add 'lint disable' (disabling remark linting) to CHANGELOG ∾ 5c1f586
maint (dev): (markdown-linting) update Remark config (ignore list spacing) + comment polish ∾ cf11c1e
maint (dev): (ESLint) ignore 'vendor' files ∾ 0d407d5
maint (dev): (vendor) treat all vendor code as 'binary' to reduce useless diff output ∾ 7721f70

Refactoring

refactor ~ (OSPaths) minor revision for correctness and conformity ∾ 3066f1a

Test Improvements

tests ~ refactor to remove need for lint exception ∾ cb103ef
tests ~ revise Deno module load test(s) ∾ ab82353
tests ~ improve 'skip' user feedback ∾ 6e0d491
tests ~ deno loads module without panic or prompt (while using no permissions) ∾ 7967ad4
tests ~ refactor - rename module_ => mod ∾ 7a830db
tests ~ restyle spell-checker exceptions for visibility ∾ 558cf81
tests ~ (dist) improve testing feedback ∾ 9ebf5d3
tests ~ improve 'integration.test.js' error feedback ∾ 443fac5
tests ~ refactor 'integration.test.js' (improved clarity/DRY and polish commentary) ∾ 9750653
tests ~ fix ESM module name generation (URL from path) ∾ d221660
tests ~ fix --test-dist flag detection ∾ ff87e65

BREAKING CHANGE

Adds a Deno v1.8.0+ minimum version requirement.

v6.9.0 (2021-02-27)

[v6.9.0; details]

Documentation

docs ~ JSDocs polish ∾ dda3d38

v6.8.0 (2021-02-27)

[v6.8.0; details]

Documentation

docs ~ JSDocs polish ∾ 8e05fd9

v6.7.0 (2021-02-22)

[v6.7.0; details]

Documentation

docs ~ add cspell dictionary word(s) ∾ 2ac8802

Maintenance

maint (build): silence '@rollup/plugin-replace' complaint about 'preventAssignment' default ∾ 93ad138
maint (deps): add typedoc (dev; for future use) ∾ 6c87af5

Refactoring

refactor ~ replace intermediate default export object to improve deno doc results ∾ b103503

v6.6.0 (2021-02-21)

[v6.6.0; details]

Documentation

docs ~ redefine OSPaths as interface for better automatic doc generation ∾ 2fd774c
docs ~ revise JSDocs descriptions ∾ 79a49ba
docs ~ disable remark lint complaint (maximum-heading-length) ∾ f0d6a04
docs ~ README corrections ∾ b62e901
docs ~ CHANGELOG update (new template) ∾ 6d6dae1

Maintenance

maint (build): name revision (tests_ => testbed) ∾ 2c14d1d
maint (build): revise CJS type rewrite to handle unnamed default export ∾ 2aa4c52

Refactoring

refactor ~ remove unneeded intermediate 'default' export object ∾ c321862

v6.5.0 (2021-02-14)

[v6.5.0; details]

Documentation

docs ~ add words to cSpell workspace dictionaries ∾ 0ae36e7
docs ~ README revisions ∾ 6d1c676
docs ~ (README) revise spell-checker exceptions ∾ 8b5db5a
docs ~ README update for git-changelog v1.1+ requirement ∾ 7789246
docs ~ remove now-extraneous stringify code from Deno example ∾ 46ee549
docs ~ README polish (Deno permissions) ∾ e269a48
docs ~ README polish (git version shield) ∾ 0d8128e

Maintenance

maint (build): normalize 'build' directory structure ∾ b14340d
maint (dev): fix EditorConfig lint complaints ∾ a48ace0
maint (dev): reorganize third-party code/types into 'vendor' ∾ a1508d7
maint (dev): (scripts) fix CHANGELOG updates for version changes (requires git-changelog v1.1+) ∾ de3438c
maint (dev): (scripts) polish comments ∾ f52ac7f
maint (dev): (scripts) add EditorConfig linter ∾ 539a2fb
maint (dev): (scripts) build in series (await parallel shx mkdir fix) ∾ 54e5177
maint (dev): remove now-unneeded rollup configs for CJS and ESM ∾ 0ab8eca
maint (dev): (scripts) add 'dist' alias for 'update' ∾ 386b49f
maint (dev): (package.json) add package tags showing Node-v4 support ∾ 933253d
maint (dev): (npm) suppress annoying update messages ∾ 3cc76d0
maint (dist): restructure package 'exports' ∾ 3157e9f

Test Improvements

tests ~ use --test-dist instead of --test-for-dist to enable distribution tests ∾ 5a9bd9c
tests ~ add distribution tests ∾ df474a6

v6.4.0 (2021-02-09)

[v6.4.0; details]

Documentation

docs ~ polish README (import/require notes and suggestions) ∾ 312af3d
docs ~ JSDocs polish ∾ a0205e0
docs ~ add additional output (showing/testing API functions) to examples ∾ 85ecab0
docs ~ add ESM dynamic import example ∾ 87709f0
docs ~ add CJS example with dynamic require (using package 'main') ∾ e4c692d
docs ~ add maint note detail ∾ 0af6ebc
docs ~ refactor examples for new source organization ∾ f75bbdd
docs ~ fix TS example to work with fully-specified imports and ts-node ∾ 1e5c548
docs ~ update CHANGELOG ∾ ff5161b

Maintenance

maint (build): add './cjs' subpath export with correct types for CJS ∾ 5b184df
maint (build): refactor/reorganize package exports config ∾ 17b903f
maint (build): relocate Prettier config from 'package.json' to external file ∾ 8c91851
maint (build): (git) ignore build/update target 'success' signal files ∾ 536a3db
maint (build): (package.json) use build target signal files (improves build dependency logic) ∾ 8762cb6
maint (build): add 'cjs' directory to distribution for tools w/o 'exports' support ∾ d34d3cf
maint (build): enable TSconfig 'isolatedModules' (helps avoid type import/export errors) ∾ c0b04cc
maint (dev): (package.json) fix npm dev script "publish" for (--dry-run use) ∾ 75155d3
maint (dist): update ∾ cdbee22

Refactoring

refactor ~ separate CJS/ESM module code (and rename source files) ∾ 604e0a6
refactor all internal module imports to use fully-specified paths (with extensions) ∾ ae017d4

Test Improvements

tests ~ replace and increase 'ava' global test timeout ∾ 96cd446
tests ~ specify increased timeouts per test (instead of globally) ∾ 178da83
tests ~ refactor tests for new source organization ∾ b92a075

v6.3.0 (2021-01-31)

[v6.3.0; details]

Documentation

docs ~ add more detail to default deno stringification of function objects ∾ 33233d4
docs ~ update cspell dictionary ∾ a524ef0
docs ~ update Deno possible import target URLs ∾ 4462656
docs ~ README polish (add Deno and JSDelivr shields + color refinements) ∾ 92ee429

Maintenance

maint (build): refactor - use forked exec-if-updated (awaiting project fixes) ∾ 1f6ef2a
maint (build): refactor type export/import ∾ 71f9cd5
maint (build): add rollup configuration to bundle typings ∾ 7a8a5bf
maint (build): npm dev script fixes + polish (includes exec-if-updated fork changes) ∾ 08070d9
maint (dev): (package.json) npm dev script fixes and polish ∾ 2e72a3b
maint (dev): update Remark markdown-linting configuration and plugins ∾ 23c8f8d
maint (dist): update ∾ 45522ba

Refactoring

refactor Adapt as a function (with OSPaths property) ∾ 04509bb
refactor ~ remove unused/placeholder 'browser' adapter ∾ faab2ac
refactor ~ convert anonymous to named functions/methods ∾ d0d78c8
refactor ~ reduce const isWinOS to a function call (improves DRY, reduces duplication) ∾ 4106f0b

Test Improvements

tests ~ refactor signal values (DRY improvements) ∾ eafe6cb
tests ~ fix 'process.env' and 'os' reset logic ∾ a55c971

v6.2.0 (2021-01-17)

[v6.2.0; details]

Documentation

docs ~ README polish ∾ 81934c1
docs ~ update Deno examples ∾ ddaeb97

v6.1.0 (2021-01-17)

[v6.1.0; details]

Documentation

docs ~ update package description ∾ fbb10bd
docs ~ JSDocs polish ∾ 2bcd311
docs ~ add JSDoc comments ∾ 23765e7
docs ~ refactor Deno example to reduce code duplication ∾ 8901b74

Maintenance

maint (build): preserve JSDoc comments for types ∾ 96278e1
maint (build): restructure TS config files for better intellisense ∾ 3713d56
maint (build): refactor commitlint commit tag specification (lowercase from upper) ∾ 2c7ac3a
maint (dev): (QA/CodeClimate) ignore code duplication in examples ('eg/') ∾ fa794e7
maint (dev): update EditorConfig (specify CJS/MJS to support JS ESM) ∾ ed5af63
maint (dev): (QA/Scrutinizer) ignore 'src/types' (generated/third-party content) ∾ dbe4474
maint (dist): update ∾ b5edf8f

Refactoring

refactor ~ (package.json) normalize export paths ∾ 3496f66
refactor ~ retouch method names (for debugging/dev) ∾ f0e803f
refactor ~ alter OSPaths type for better VSCode intellisense (describe as methods, not properties) ∾ ab673fa
refactor ~ improve readability ∾ ff7ad32
refactor ~ consolidate/group adapting functions using a namespace ∾ 3d9e02d
refactor ~ reduce per function complexity ∾ a966d13

Test Improvements

tests ~ fix occasional ava timeouts for integration CLI tests ∾ 67ddd71

v6.0.0 (2021-01-14)

[v6.0.0; details]

Changes

change ~ remove experimental 'meta.mainFilename' prior to publish ∾ 461f9ac
add Platform.Adapter implementation (factory method closure variant) ∾ cf6d6c4
change ~ experimental inclusion of meta.mainFilename (+ test mods) ∾ b7c05a9
add Platform.Adapter interface ∾ 6ee064e
add Deno types ∾ 0150666
change ~ show NodeJS-v4+ compatibility ∾ 3bff2d4
change (API!): add ESM module packaging (adds 'exports' to package) ∾ 3481efd

Fixes

fix ~ avoid spread operator b/c of Rollup+TS code generation bug ∾ 26b9fee
fix ~ refer deno module to published 'dist' instead of internal 'build' ESM ∾ 9e692e9
fix ~ remove /// <reference path... references to deno types ∾ 2bdd8f0

Documentation

docs ~ README polish ∾ e2029bc
docs ~ update public/remote project dep for Deno example ∾ c728352
docs ~ update CHANGELOG ∾ ce5c824
docs ~ update spell-checker exceptions and dictionary wordlists ∾ d59472d
docs ~ add Deno examples ∾ bf4bba6
docs ~ polish/update README ∾ dc5656b
docs ~ polish TS example ∾ 9aeffc0
docs ~ import 'OSPaths' from 'dist' instead of 'build' ∾ 3656bab
docs ~ add spell-checker exceptions to CHANGELOG + update CHANGELOG ∾ d8423bf
docs ~ add ESM example ∾ b610f1f

Maintenance

maint (CICD): update CICD platforms to use Node-v10+ builders ∾ 57d7bba
maint (build): disable faulty commitlint rule (with a 'maint' note) ∾ 3ab80e8
maint (build): add 'deno' to package exports ∾ 6d58d39
maint (build): compile down to ES3 to assure Node-v4+ compatibility ∾ ca03342
maint (build): cleanup Rollup+TS EOL issues + dist build ∾ acb7dd4
maint (build): add conditional build logic with 'exec-if-updated' ∾ 27d6a7c
maint (build): npm dev script polish ∾ 6a21ae9
maint (build): add rollup for ESM generation ∾ 1f81a59
maint (build): ignore deno files for TypeScript compilations ∾ 92038db
maint (dev): (deps) update to 'eslint-plugin-functional' v3.2.1 ∾ 1931183
maint (dev): add VSCode plugin for deno support (disabled; for future use) ∾ b971d74
maint (dev): update VSCode settings (ToDO-Tree) ∾ 8d52796
maint (dev): npm dev script fixes and polish ∾ f7c9c93
maint (dev): update Prettier ignore file for VSCode cspell config ∾ f417a12
maint (dev): add commit linting (with dev scripts) ∾ 77b1b30
maint (dev): refactor cspell config to use dictionary wordlists ∾ 3d105f1
maint (dev): update VSCode settings (with workspace cspell exceptions) ∾ 2698524
maint (dev!): update dev deps (adds new minimum NodeJS-v10+ build requirement) ∾ 66417b6
maint (dist): update ∾ f5c8354
maint (dist): update ∾ 582c989
maint (test): add ava configuration to ignore type tests ∾ 73410d1

Refactoring

refactor ~ improve OSPaths factory naming/semantics ∾ a43f4b6
refactor ~ use late/lazy evaluation to avoid ENV{} and path.join() calls ∾ a2900a3

Test Improvements

tests ~ add testing of Deno examples (when deno is available) ∾ 586ad61
tests ~ only test examples prior to version changes and during prepublication testing ∾ 3ed1801
tests ~ refine file set of CLI example scripts for TypeScript testing ∾ 3ddef36
tests ~ fix CodeFactor complaint (never-used) ∾ ce7a6d0
test (refactor): improve variable name semantics ∾ 30724ef

v5.1.0 (2021-01-01)

[v5.1.0; details]

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

Test Improvements

tests ~ DRY changes + test alternate ENV empty types ∾ f16a74e

v5.0.1 (2020-12-28)

[v5.0.1; details]

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)

[v5.0.0; details]

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

Test Improvements

tests ~ add testing of TypeScript-based examples ∾ aa0078e
tests ~ narrowly select examples for testing (with planning for future ESM support) ∾ 2f2ebeb
tests ~ reset process.env between tests ∾ d4bad79
tests ~ refactor expected API testing ∾ e920907
tests ~ update tests for changed API ∾ d7b9619
tests ~ expand and tighten unit test specs ∾ de4a53a
tests ~ consolidate ESLint directives ∾ 22beeb8
tests ~ add exemplar side-by-side unit test for OSPaths ∾ 8104bfd
tests ~ required updates for new 'dist' targeting ∾ e1c858a
tests ~ fix and refactor tests ∾ 6b3371b
tests ~ make required changes for newly TypeScript-based package ∾ a58b6ef

v4.4.0 (2020-12-15)

[v4.4.0; details]

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)

[v4.3.0; details]

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

Test Improvements

tests ~ change unit.test.js to CJS (CommonJS; from ESM [ECMAScript Module]) ∾ 0079d14
tests ~ add integration tests ∾ 6a37445
tests ~ refine test categorization (using filename hints) ∾ a2df256
tests ~ remove duplicative code from type testing ∾ 9a8d132

v4.2.0 (2019-10-17)

[v4.2.0; details]

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)

[v4.1.0; details]

Documentation

docs ~ improve README badges ∾ a354862

Maintenance

maint (build): fix/update dev dependencies ∾ de871cb

v4.0.1 (2019-10-04)

[v4.0.1; details]

Documentation

docs ~ fix CHANGELOG title and URLs ∾ 5458236

Maintenance

maint (build): fix CHANGELOG generator configuration ∾ acb315d

v4.0.0 (2019-10-02)

[v4.0.0; details]

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)

[v3.0.2; details]

Documentation

docs ~ polish and add XDG references ∾ 1696b46

v3.0.1 (2019-06-29)

[v3.0.1; details]

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)

[v2.2.0; details]

Refactoring

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

v2.1.0 (2019-03-04)

[v2.1.0; details]

Changes

add TypeScript definition (#11) ∾ 949cd22

v2.0.0 (2018-11-05)

[v2.0.0; details]

No changelog for this release.

v1.0.0 (2017-01-10)

[v1.0.0; details]

Fixes

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

v0.3.1 (2016-10-18)

[v0.3.1; details]

No changelog for this release.

v0.3.0 (2016-07-02)

[v0.3.0; details]

Fixes

fix usage example ∾ 88a5908

v0.2.0 (2016-06-24)

[v0.2.0; details]

Changes

add suffix to prevent possible conflict with native apps ∾ c2fda19

v0.1.0 (2016-06-21)

[v0.1.0; details]

No changelog for this release.

Files

CHANGELOG.mkd

Latest commit

History

CHANGELOG.mkd

File metadata and controls

CHANGELOG os-paths

v7.4.0 (2023-02-06)

Fixes

Documentation

Maintenance

v7.3.0 (2022-08-13)

Documentation

Maintenance

Test Improvements

v7.2.0 (2022-08-09)

Dependency Updates

Documentation

Maintenance

Test Improvements

v7.1.1 (2022-08-06)

Documentation

Maintenance

v7.1.0 (2022-08-06)

Dependency Updates

Documentation

Maintenance

Test Improvements

v7.0.0 (2022-07-31)

Changes

Fixes

Dependency Updates

Documentation

Maintenance

Refactoring

Test Improvements

BREAKING CHANGE

v6.9.0 (2021-02-27)

Documentation

v6.8.0 (2021-02-27)

Documentation

v6.7.0 (2021-02-22)

Documentation

Maintenance

Refactoring

v6.6.0 (2021-02-21)

Documentation

Maintenance

Refactoring

v6.5.0 (2021-02-14)

Documentation

Maintenance

Test Improvements

v6.4.0 (2021-02-09)

Documentation

Maintenance

Refactoring

Test Improvements

v6.3.0 (2021-01-31)

Documentation

Maintenance

Refactoring

Test Improvements

v6.2.0 (2021-01-17)

Documentation

v6.1.0 (2021-01-17)

Documentation

Maintenance

Refactoring

Test Improvements

v6.0.0 (2021-01-14)

Changes

Fixes

Documentation

Maintenance

Refactoring

Test Improvements

v5.1.0 (2021-01-01)

Fixes

Documentation

CHANGELOG
os-paths