Merge branch '4.0.0'

Author: jonschlinkert

README.md

@@ -1,12 +1,12 @@
-# @folder/xdg [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=W8YFZ425KND68) [![NPM version](https://img.shields.io/npm/v/@folder/xdg.svg?style=flat)](https://www.npmjs.com/package/@folder/xdg) [![NPM monthly downloads](https://img.shields.io/npm/dm/@folder/xdg.svg?style=flat)](https://npmjs.org/package/@folder/xdg) [![NPM total downloads](https://img.shields.io/npm/dt/@folder/xdg.svg?style=flat)](https://npmjs.org/package/@folder/xdg)
+# @folder/xdg [![NPM version](https://img.shields.io/npm/v/@folder/xdg.svg?style=flat)](https://www.npmjs.com/package/@folder/xdg) [![NPM monthly downloads](https://img.shields.io/npm/dm/@folder/xdg.svg?style=flat)](https://npmjs.org/package/@folder/xdg) [![NPM total downloads](https://img.shields.io/npm/dt/@folder/xdg.svg?style=flat)](https://npmjs.org/package/@folder/xdg)
 
-> Get cross-platform XDG Base Directories or their equivalents. Works with Linux, Windows, or MacOS. No dependencies.
+> Get cross-platform XDG Base Directories or their equivalents. Works with Linux, Windows, or MacOS.
 
 Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.
 
 ## Install
 
-Install with [npm](https://www.npmjs.com/) (requires [Node.js](https://nodejs.org/en/) >=8):
+Install with [npm](https://www.npmjs.com/):
 
 ```sh
 $ npm install --save @folder/xdg
@@ -260,7 +260,7 @@ Get the XDG Base Directory paths for Linux, or equivalent paths for Windows or M
 * `options` **{Object}**
 * `returns` **{Object}**: Returns an object of paths for the current platform.
 
-### [.darwin](index.js#L43)
+### [.darwin](index.js#L44)
 
 Get XDG equivalent paths for MacOS. Used by the main export when `process.platform` is `darwin`. Aliased as `xdg.macos()`.
 
@@ -277,7 +277,7 @@ const dirs = xdg.darwin();
 const dirs = xdg.macos();
 ```
 
-### [.linux](index.js#L83)
+### [.linux](index.js#L89)
 
 Get XDG equivalent paths for Linux. Used by the main export when `process.platform` is `linux`.
 
@@ -290,7 +290,7 @@ Get XDG equivalent paths for Linux. Used by the main export when `process.platfo
 const dirs = xdg.linux();
 ```
 
-### [.win32](index.js#L124)
+### [.win32](index.js#L136)
 
 Get XDG equivalent paths for MacOS. Used by the main export when `process.platform` is `win32`. Aliased as `xdg.windows()`.
 
@@ -327,7 +327,7 @@ load each file.
 * `paths` **{Object}**: Optionally pass the paths from the `userdirs()` function to avoid creating them again.
 * `returns` **{Object}**: Returns an object with a `paths` object, and `config`, `defaults`, `dirs`, and `create` functions for actually loading the user-dir files.
 
-### [.userdirs.conf()](lib/userdirs.js#L77)
+### [.userdirs.conf()](lib/userdirs.js#L76)
 
 Loads and parses the contents of `user-dirs.conf`, if one exists in user home.
 
@@ -344,7 +344,7 @@ console.log(config);
 //=> { enabled: true, filename_encoding: 'UTF-8' }
 ```
 
-### [.userdirs.defaults()](lib/userdirs.js#L106)
+### [.userdirs.defaults()](lib/userdirs.js#L105)
 
 Loads and parses the contents of `user-dirs.defaults`, if one exists in user home.
 
@@ -372,7 +372,7 @@ const defaults = userdirs.defaults();
 console.log(defaults);
 ```
 
-### [.userdirs.dirs()](lib/userdirs.js#L133)
+### [.userdirs.dirs()](lib/userdirs.js#L132)
 
 Loads and parses the contents of `user-dirs.dirs`, if one exists in user home.
 
@@ -395,7 +395,7 @@ console.log(dirs);
 // }
 ```
 
-### [.userdirs.create()](lib/userdirs.js#L166)
+### [.userdirs.create()](lib/userdirs.js#L165)
 
 Get the actual XDG User Directories to use for MacOS. Gets the `user-dirs.conf`, `user-dirs.defaults`, and the `user-dirs.dirs` files and, if not disabled in `user-dirs.conf`, merges the values in defaults and dirs to create the paths to use.
 
@@ -422,7 +422,7 @@ console.log(dirs);
 // }
 ```
 
-### [.userdirs.darwin()](lib/userdirs.js#L182)
+### [.userdirs.darwin()](lib/userdirs.js#L181)
 
 Get the XDG User Directories for MacOS. This method is used by the main function when `process.platform` is `darwin`. Exposed as a method so you can call it directly if necessary. Also aliased as `userdirs.macos()`.
 
@@ -437,7 +437,7 @@ Get the XDG User Directories for MacOS. This method is used by the main function
 const { dirs, conf, defaults } = userdirs.darwin(); // or userdirs.macos();
 ```
 
-### [.userdirs.linux()](lib/userdirs.js#L210)
+### [.userdirs.linux()](lib/userdirs.js#L209)
 
 Gets the XDG User Directories for Linux. Used by the main export when `process.platform` is `linux`.
 
@@ -450,7 +450,7 @@ Gets the XDG User Directories for Linux. Used by the main export when `process.p
 const { dirs, conf, defaults } = userdirs.linux();
 ```
 
-### [.userdirs.win32()](lib/userdirs.js#L236)
+### [.userdirs.win32()](lib/userdirs.js#L235)
 
 Gets the XDG User Directories for MacOS. Used by the `userdirs()` function when `process.platform` is `win32`. Also aliased as `userdirs.windows()`.
 
@@ -558,9 +558,9 @@ You might also be interested in these projects:
 
 ### License
 
-Copyright © 2020, [Jon Schlinkert](https://github.com/jonschlinkert).
+Copyright © 2023, [Jon Schlinkert](https://github.com/jonschlinkert).
 Released under the MIT License.
 
 ***
 
-_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on July 13, 2020._
+_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on July 22, 2023._

index.js

@@ -3,7 +3,7 @@
 const os = require('os');
 const path = require('path');
 const join = path.join;
-const expand = require('./lib/expand');
+const { create, expand, loadFile } = require('./lib/expand');
 const { homedir, load, resolve, split } = require('./lib/utils');
 
 /**
@@ -68,9 +68,13 @@ xdg.darwin = (options = {}) => {
   };
 
   if (options.expanded === true) {
-    return expand(dirs, options);
+    const expanded = expand(dirs, options);
+    expanded.create = create;
+    expanded.load = (pathname, config, options) => loadFile(config)(pathname, options);
+    return expanded;
   }
 
+  dirs.create = create;
   return dirs;
 };
 
@@ -116,7 +120,9 @@ xdg.linux = (options = {}) => {
   };
 
   if (options.expanded === true) {
-    return expand(dirs, options);
+    const expanded = expand(dirs, options);
+    expanded.create = create;
+    return expanded;
   }
 
   return dirs;
@@ -173,7 +179,9 @@ xdg.win32 = (options = {}) => {
   };
 
   if (options.expanded === true) {
-    return expand(dirs, options);
+    const expanded = expand(dirs, options);
+    expanded.create = create;
+    return expanded;
   }
 
   return dirs;

lib/expand.js

@@ -1,3 +1,4 @@
+/* eslint-disable no-multi-assign */
 'use strict';
 
 const os = require('os');
@@ -9,7 +10,7 @@ const ini = require('ini');
 const toml = require('toml');
 const yaml = require('yaml');
 const userdirs = require('./userdirs');
-const { dir, homedir, read, resolve } = require('./utils');
+const { dir, homedir, isObject, read, resolve } = require('./utils');
 
 const readfile = config => (pathname, find = false) => {
   try {
@@ -23,35 +24,71 @@ const readfile = config => (pathname, find = false) => {
   }
 };
 
-const loadFile = config => (pathname, find = true) => {
+const parseNpmrc = data => {
+  const init = {};
+
+  for (const [key, value] of Object.entries(data)) {
+    if (key.startsWith('init-')) {
+      const segs = key.split('-');
+      let k = segs[0];
+      let o = init;
+
+      while (segs.length) {
+        k = segs.shift();
+        o = o[k] = segs.length ? o[k] || {} : value;
+      }
+
+      delete data[key];
+    }
+  }
+
+  if (init?.init) {
+    data.init ||= init?.init;
+  }
+
+  return data;
+};
+
+const loadFile = config => (pathname, { find = true, ext } = {}) => {
+  const basename = path.basename(pathname);
   const contents = config.read(pathname, find !== false);
-  const extname = pathname.startsWith('.env') ? '.env' : path.extname(pathname);
+  const extname = ext || (basename.startsWith('.env') ? '.env' : path.extname(basename));
 
   if (!contents) {
     return {};
   }
 
-  switch (extname) {
-    case '.env':
-    case '.ini':
-      return ini.parse(contents);
-    case '.json':
-      return JSON.parse(contents);
-    case '.toml':
-      return toml.parse(contents);
-    case '.yaml':
-    case '.yml':
-      return yaml.parse(contents);
-    case '.js':
-      return require(pathname);
-    default: {
-      return contents;
+  const load = () => {
+    switch (extname) {
+      case '.env':
+      case '.ini':
+        return ini.parse(contents);
+      case '.json':
+        return JSON.parse(contents);
+      case '.toml':
+        return toml.parse(contents);
+      case '.yaml':
+      case '.yml':
+        return yaml.parse(contents);
+      case '.js':
+        return require(pathname);
+      default: {
+        return contents;
+      }
     }
+  };
+
+  const data = load();
+
+  if (basename === '.npmrc') {
+    return parseNpmrc(data);
   }
+
+  return data;
 };
 
-const search = (dirs = []) => (pattern, folder) => {
-  const isMatch = pico(pattern, { dot: true, basename: true });
+const search = (dirs = []) => (patterns, folder) => {
+  const isMatch = pico(patterns, { dot: true });
   const matches = [];
 
   for (const dir of dirs) {
@@ -60,8 +97,9 @@ const search = (dirs = []) => (pattern, folder) => {
 
     for (const dirent of dirents) {
       dirent.path = path.resolve(dir, dirent.name);
+      dirent.relative = path.relative(dir, dirent.path);
 
-      if (isMatch(dirent.path)) {
+      if (isMatch(dirent.relative)) {
         matches.push(dirent);
       }
     }
@@ -74,26 +112,47 @@ const writefile = dir => (pathname, ...args) => {
   return write(path.resolve(dir, pathname), ...args);
 };
 
-const find = dirs => (pathname, ...args) => {
-  return dirs.map(dir => path.resolve(dir, pathname)).find(fp => fs.existsSync(fp));
+const find = config => pathname => {
+  // const cwd = config.parent?.cwd;
+
+  for (const dir of config.dirs) {
+    const filepath = path.resolve(dir, pathname);
+
+    // if (dir === cwd) {
+    //   console.log({ dir, pathname, filepath });
+    // }
+
+    if (fs.existsSync(filepath)) {
+      return filepath;
+    }
+  }
+  return null;
 };
 
-const decorateMethods = dirs => {
+const create = config => {
+  if (Array.isArray(config.dirs)) {
+    config.find = find(config);
+    config.search = search(config);
+  }
+
+  config.read = readfile(config);
+  config.load = loadFile(config);
+  config.parse = loadFile(config);
+  config.write = writefile(config.home);
+  return config;
+};
+
+const createDirs = dirs => {
   for (const key of Object.keys(dirs)) {
     const config = dirs[key];
 
-    if (config && typeof config !== 'string') {
-      if (Array.isArray(config.dirs)) {
-        config.find = find(config.dirs);
-        config.search = search(config.dirs);
-      }
-
-      config.read = readfile(config);
-      config.load = loadFile(config);
-      config.parse = loadFile(config);
-      config.write = writefile(config.home);
+    if (isObject(config)) {
+      Reflect.defineProperty(config, 'parent', { value: dirs, enumerable: false });
+      create(config);
     }
   }
+
+  return dirs;
 };
 
 // eslint-disable-next-line complexity
@@ -133,8 +192,17 @@ const expand = (paths, options = {}) => {
     }
   };
 
-  decorateMethods(dirs);
+  createDirs(dirs);
   return dirs;
 };
 
-module.exports = expand;
+module.exports = {
+  expand,
+  create,
+  createDirs,
+  readfile,
+  loadFile,
+  search,
+  writefile,
+  find
+};

lib/utils.js

@@ -11,6 +11,8 @@ const XDG_DIR_REGEX = /^(?:XDG_)?(.+)(?:_DIR)?$/i;
 const split = str => str ? str.split(path.delimiter) : [];
 const title = str => str ? str[0].toUpperCase() + str.slice(1) : '';
 
+const isObject = v => v !== null && typeof v === 'object' && !Array.isArray(v);
+
 const read = filepath => {
   if (filepath) {
     return fs.readFileSync(filepath, 'utf8').replace(BOM_REGEX, '');
@@ -162,5 +164,6 @@ module.exports = {
   title,
   unformatKey,
   parseIni,
-  cast
+  cast,
+  isObject
 };