CHANGELOG
os-paths

Documentation

• docs ~ JSDocs polish ∾ dda3d38

Documentation

• docs ~ JSDocs polish ∾ 8e05fd9

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

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

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

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

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

Documentation

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

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

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

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

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

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

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

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

Documentation

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

Maintenance

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

Documentation

• docs ~ improve README badges ∾ a354862

Maintenance

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

Documentation

• docs ~ fix CHANGELOG title and URLs ∾ 5458236

Maintenance

• maint (build): fix CHANGELOG generator configuration ∾ acb315d

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

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.