os-user-dirs 3.1.0 → 3.2.0

package/README.md

@@ -10,7 +10,7 @@
 
 > All-in-one OS directory paths — user directories, XDG base directories, and app-scoped project directories — with zero dependencies.
 
-- Node.js 20 or later
+- Node.js 20+, Deno 2+, Bun 1+
 
 Replaces [`env-paths`](https://github.com/sindresorhus/env-paths), [`xdg-basedir`](https://github.com/sindresorhus/xdg-basedir), and [`platform-folders`](https://github.com/nicbarker/platform-folders) in a single package. CJS + ESM dual support, TypeScript included.
 
@@ -29,6 +29,7 @@ Replaces [`env-paths`](https://github.com/sindresorhus/env-paths), [`xdg-basedir
 | XDG search paths | **Yes** | - | **Yes** | - |
 | Project directories | **Yes** | **Yes** | - | - |
 | CJS + ESM | **Both** | ESM only (v3) | ESM only (v5) | CJS |
+| Deno / Bun | **Yes** | - | - | - |
 | TypeScript | **Included** | Included | Included | - |
 
 ## Install
@@ -37,7 +38,7 @@ Replaces [`env-paths`](https://github.com/sindresorhus/env-paths), [`xdg-basedir
 $ npm install os-user-dirs
 ```
 
-Requires Node.js 20 or later. Works on Windows, macOS, and Linux.
+Requires Node.js 20 or later. Works on Windows, macOS, and Linux. Also compatible with [Deno](https://deno.land/) and [Bun](https://bun.sh/).
 
 ## Quick Start
 
@@ -68,6 +69,25 @@ CommonJS is also supported:
 const { downloads, configDir, projectDirs } = require("os-user-dirs");
 ```
 
+### Deno
+
+```typescript
+import { downloads, configDir } from "npm:os-user-dirs";
+
+downloads();  //=> '/home/user/Downloads'
+configDir();  //=> '/home/user/.config'
+```
+
+### Bun
+
+```javascript
+import { downloads, configDir } from "os-user-dirs";
+// or: const { downloads, configDir } = require("os-user-dirs");
+
+downloads();  //=> '/home/user/Downloads'
+configDir();  //=> '/home/user/.config'
+```
+
 ### TypeScript
 
 Full type definitions are included. `getPath()` accepts a union type for auto-completion:
@@ -167,6 +187,7 @@ Returns the path to the specified base directory. Valid names: `config`, `data`,
 | Get user's Downloads folder | `downloads()` |
 | Get user's Documents folder | `documents()` |
 | Get all app-scoped dirs at once | `projectDirs("my-app")` |
+| Dump all directory paths | `getAllDirs()` |
 | Find system-wide config locations | `configDirs()` |
 | Ensure a directory exists | `ensureDir(path)` / `ensureDirSync(path)` |
 | Get user's home directory | `homeDir()` |
@@ -246,10 +267,44 @@ const dirs = projectUserDirs("my-app");
 dirs.downloads //=> '/home/user/Downloads/my-app'
 ```
 
+### Namespace Exports
+
+For better organization, functions are also available via namespace objects:
+
+```javascript
+import { user, base, project } from "os-user-dirs";
+
+// User directories
+user.downloads()   //=> '/home/user/Downloads'
+user.desktop()     //=> '/home/user/Desktop'
+user.homeDir()     //=> '/home/user'
+
+// XDG base directories
+base.configDir()   //=> '/home/user/.config'
+base.dataDir()     //=> '/home/user/.local/share'
+base.configDirs()  //=> ['/etc/xdg']
+
+// Project directories
+const dirs = project.dirs("my-app");
+dirs.config  //=> '/home/user/.config/my-app'
+
+const userDirs = project.userDirs("my-app");
+userDirs.downloads  //=> '/home/user/Downloads/my-app'
+```
+
+| Namespace | Functions |
+|---|---|
+| `user` | `desktop`, `downloads`, `documents`, `music`, `pictures`, `videos`, `templates`, `publicshare`, `homeDir`, `binDir`, `fontsDir`, `trashDir`, `applicationsDir` |
+| `base` | `configDir`, `dataDir`, `cacheDir`, `stateDir`, `logDir`, `runtimeDir`, `configDirs`, `dataDirs` |
+| `project` | `dirs` (= `projectDirs`), `userDirs` (= `projectUserDirs`) |
+
+All flat exports remain available for backward compatibility.
+
 ### Utilities
 
 | Function | Description |
 |---|---|
+| `getAllDirs()` | Returns all directory paths as a single object |
 | `ensureDirSync(dirPath)` | Creates directory recursively if needed (sync) |
 | `ensureDir(dirPath)` | Creates directory recursively if needed (async) |
 | `getXDGUserDir(key)` | Parse XDG user-dirs.dirs config |
@@ -271,6 +326,8 @@ getBasePath("unknown"); // Type error
 ## Integration guides
 
 - **[Electron Guide](docs/guide-electron.md)** — Using os-user-dirs in Electron apps: `app.getPath()` mapping, main/renderer process patterns, vendor-scoped directories
+- **[Tauri Guide](docs/guide-tauri.md)** — Using os-user-dirs in Tauri apps: path API mapping, sidecar patterns, shared config with CLI companions
+- **[VS Code Extension Guide](docs/guide-vscode-extension.md)** — Using os-user-dirs in VS Code extensions: `globalStorageUri` comparison, file export patterns, shared config with CLI tools
 - **[CLI Tools Guide](docs/guide-cli-tools.md)** — Using `projectDirs()` with commander, yargs, and oclif for config, cache, and log management
 
 ## Migration Guides
@@ -305,6 +362,14 @@ downloads();                              // recommended: cross-platform Downloa
 getXDGUserDir("XDG_DOWNLOAD_DIR");        // direct replacement if you need XDG config parsing
 ```
 
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup, coding conventions, and pull request guidelines.
+
+## Security
+
+See [SECURITY.md](SECURITY.md) for the security policy and vulnerability reporting instructions.
+
 ## License
 
 MIT

package/index.d.ts

@@ -429,6 +429,110 @@ export function ensureDirSync(dirPath: string): string;
  */
 export function ensureDir(dirPath: string): Promise<string>;
 
+interface GetAllDirsResult {
+    downloads: string;
+    desktop: string;
+    documents: string;
+    music: string;
+    pictures: string;
+    videos: string;
+    templates: string;
+    publicshare: string;
+    configDir: string;
+    dataDir: string;
+    cacheDir: string;
+    stateDir: string;
+    logDir: string;
+    runtimeDir: string | null;
+    fontsDir: string;
+    binDir: string | null;
+    applicationsDir: string;
+    trashDir: string | null;
+    homeDir: string;
+}
+
+/**
+ * Returns all directory paths as a single object.
+ * Useful for debugging, configuration dumps, or diagnostics.
+ * Does not include array-returning functions (`configDirs`, `dataDirs`)
+ * or functions requiring arguments (`projectDirs`, `projectUserDirs`).
+ * @example
+ * ```ts
+ * import { getAllDirs } from 'os-user-dirs';
+ * const dirs = getAllDirs();
+ * console.log(dirs.downloads);  // '/home/user/Downloads'
+ * console.log(dirs.configDir);  // '/home/user/.config'
+ * console.log(dirs.homeDir);    // '/home/user'
+ * ```
+ */
+export function getAllDirs(): GetAllDirsResult;
+
+/**
+ * Namespace grouping user directory functions.
+ * Provides organized access to user-specific directory functions.
+ * @example
+ * ```ts
+ * import { user } from 'os-user-dirs';
+ * user.downloads();   // '/home/user/Downloads'
+ * user.desktop();     // '/home/user/Desktop'
+ * user.homeDir();     // '/home/user'
+ * ```
+ */
+export const user: {
+    desktop: typeof desktop;
+    downloads: typeof downloads;
+    documents: typeof documents;
+    music: typeof music;
+    pictures: typeof pictures;
+    videos: typeof videos;
+    templates: typeof templates;
+    publicshare: typeof publicshare;
+    homeDir: typeof homeDir;
+    binDir: typeof binDir;
+    fontsDir: typeof fontsDir;
+    trashDir: typeof trashDir;
+    applicationsDir: typeof applicationsDir;
+};
+
+/**
+ * Namespace grouping XDG base directory functions.
+ * Provides organized access to base directory and search path functions.
+ * @example
+ * ```ts
+ * import { base } from 'os-user-dirs';
+ * base.configDir();   // '/home/user/.config'
+ * base.dataDir();     // '/home/user/.local/share'
+ * base.configDirs();  // ['/etc/xdg']
+ * ```
+ */
+export const base: {
+    configDir: typeof configDir;
+    dataDir: typeof dataDir;
+    cacheDir: typeof cacheDir;
+    stateDir: typeof stateDir;
+    logDir: typeof logDir;
+    runtimeDir: typeof runtimeDir;
+    configDirs: typeof configDirs;
+    dataDirs: typeof dataDirs;
+};
+
+/**
+ * Namespace grouping project-scoped directory functions.
+ * Provides organized access to application-scoped directory functions.
+ * @example
+ * ```ts
+ * import { project } from 'os-user-dirs';
+ * const dirs = project.dirs('my-app');
+ * dirs.config;  // '/home/user/.config/my-app'
+ * const userDirs = project.userDirs('my-app');
+ * userDirs.downloads;  // '/home/user/Downloads/my-app'
+ * ```
+ */
+export const project: {
+    dirs: typeof projectDirs;
+    userDirs: typeof projectUserDirs;
+};
+
 declare const osUserDirs: typeof downloads & {
     downloads: typeof downloads;
     desktop: typeof desktop;
@@ -458,6 +562,10 @@ declare const osUserDirs: typeof downloads & {
     getXDGUserDir: typeof getXDGUserDir;
     ensureDirSync: typeof ensureDirSync;
     ensureDir: typeof ensureDir;
+    getAllDirs: typeof getAllDirs;
+    user: typeof user;
+    base: typeof base;
+    project: typeof project;
 };
 
 export default osUserDirs;

package/index.js

@@ -374,6 +374,30 @@ function homeDir() {
     return os.homedir();
 }
 
+function getAllDirs() {
+    return {
+        downloads: downloads(),
+        desktop: desktop(),
+        documents: documents(),
+        music: music(),
+        pictures: pictures(),
+        videos: videos(),
+        templates: templates(),
+        publicshare: publicshare(),
+        configDir: configDir(),
+        dataDir: dataDir(),
+        cacheDir: cacheDir(),
+        stateDir: stateDir(),
+        logDir: logDir(),
+        runtimeDir: runtimeDir(),
+        fontsDir: fontsDir(),
+        binDir: binDir(),
+        applicationsDir: applicationsDir(),
+        trashDir: trashDir(),
+        homeDir: homeDir(),
+    };
+}
+
 function ensureDirSync(dirPath) {
     if (!dirPath || typeof dirPath !== "string") {
         throw new Error("ensureDirSync requires a non-empty string path");
@@ -391,6 +415,39 @@ function ensureDir(dirPath) {
     });
 }
 
+// Namespace exports
+const user = {
+    desktop: desktop,
+    downloads: downloads,
+    documents: documents,
+    music: music,
+    pictures: pictures,
+    videos: videos,
+    templates: templates,
+    publicshare: publicshare,
+    homeDir: homeDir,
+    binDir: binDir,
+    fontsDir: fontsDir,
+    trashDir: trashDir,
+    applicationsDir: applicationsDir,
+};
+
+const base = {
+    configDir: configDir,
+    dataDir: dataDir,
+    cacheDir: cacheDir,
+    stateDir: stateDir,
+    logDir: logDir,
+    runtimeDir: runtimeDir,
+    configDirs: configDirs,
+    dataDirs: dataDirs,
+};
+
+const project = {
+    dirs: projectDirs,
+    userDirs: projectUserDirs,
+};
+
 // Backward compatibility: require("os-user-dirs")() returns Downloads path
 module.exports = downloads;
 module.exports.getPath = getPath;
@@ -421,3 +478,7 @@ module.exports.getXDGUserDir = getXDGUserDir;
 module.exports.ensureDirSync = ensureDirSync;
 module.exports.trashDir = trashDir;
 module.exports.ensureDir = ensureDir;
+module.exports.getAllDirs = getAllDirs;
+module.exports.user = user;
+module.exports.base = base;
+module.exports.project = project;

package/index.mjs

@@ -29,3 +29,7 @@ export const getXDGUserDir = osUserDirs.getXDGUserDir;
 export const trashDir = osUserDirs.trashDir;
 export const ensureDirSync = osUserDirs.ensureDirSync;
 export const ensureDir = osUserDirs.ensureDir;
+export const getAllDirs = osUserDirs.getAllDirs;
+export const user = osUserDirs.user;
+export const base = osUserDirs.base;
+export const project = osUserDirs.project;

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "os-user-dirs",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "description": "Get OS-specific user directories and XDG base directories (config, data, cache, runtime) with zero dependencies.",
   "main": "index.js",
+  "type": "commonjs",
   "types": "index.d.ts",
   "exports": {
     ".": {