os-user-dirs 2.2.0 → 2.4.0

package/README.md

@@ -1,6 +1,6 @@
 # os-user-dirs [![CI](https://github.com/velocitylabo/os-user-dirs/actions/workflows/ci.yml/badge.svg)](https://github.com/velocitylabo/os-user-dirs/actions/workflows/ci.yml)
 
-Get OS-specific user directories (Downloads, Desktop, Documents, Music, Pictures, Videos) with zero dependencies.
+Get OS-specific user directories (Downloads, Desktop, Documents, etc.) and XDG base directories (config, data, cache, state, log, runtime) with zero dependencies. Also provides `projectDirs()` for app-scoped directories (similar to `env-paths`).
 
 > **Note:** This package was previously published as [`os-downloads`](https://www.npmjs.com/package/os-downloads). The old package is deprecated — please use `os-user-dirs` instead.
 
@@ -21,7 +21,7 @@ $ npm install os-user-dirs
 ### ESM (recommended)
 
 ```javascript
-import { downloads, desktop, documents, music, pictures, videos, getPath } from "os-user-dirs";
+import { downloads, desktop, documents, music, pictures, videos, templates, publicshare, getPath } from "os-user-dirs";
 
 downloads();
 //=> '/home/user/Downloads'
@@ -29,17 +29,66 @@ downloads();
 desktop();
 //=> '/home/user/Desktop'
 
-documents();
-//=> '/home/user/Documents'
+templates();
+//=> '/home/user/Templates'
+
+publicshare();
+//=> '/home/user/Public'
 
 getPath("music");
 //=> '/home/user/Music'
 ```
 
+#### Base directories
+
+```javascript
+import { configDir, dataDir, cacheDir, stateDir, logDir, runtimeDir, getBasePath } from "os-user-dirs";
+
+configDir();
+//=> '/home/user/.config'
+
+dataDir();
+//=> '/home/user/.local/share'
+
+cacheDir();
+//=> '/home/user/.cache'
+
+stateDir();
+//=> '/home/user/.local/state'
+
+logDir();
+//=> '/home/user/.local/state' (Linux), '~/Library/Logs' (macOS)
+
+runtimeDir();
+//=> '/run/user/1000' (or null)
+
+getBasePath("config");
+//=> '/home/user/.config'
+```
+
+#### Project directories
+
+```javascript
+import { projectDirs } from "os-user-dirs";
+
+const dirs = projectDirs("my-app");
+dirs.config  //=> '/home/user/.config/my-app'
+dirs.data    //=> '/home/user/.local/share/my-app'
+dirs.cache   //=> '/home/user/.cache/my-app'
+dirs.state   //=> '/home/user/.local/state/my-app'
+dirs.log     //=> '/home/user/.local/state/my-app'
+dirs.temp    //=> '/tmp/my-app'
+dirs.runtime //=> '/run/user/1000/my-app' (or null)
+
+// With suffix option
+const dirs2 = projectDirs("my-app", { suffix: "-nodejs" });
+dirs2.config //=> '/home/user/.config/my-app-nodejs'
+```
+
 ### CommonJS
 
 ```javascript
-const { downloads, desktop, documents, music, pictures, videos, getPath } = require("os-user-dirs");
+const { downloads, desktop, documents, music, pictures, videos, templates, publicshare, getPath } = require("os-user-dirs");
 
 downloads();
 //=> '/home/user/Downloads'
@@ -65,9 +114,10 @@ Full type definitions are included. `getPath()` accepts a union type for auto-co
 ```typescript
 import { getPath } from "os-user-dirs";
 
-getPath("downloads"); // OK
-getPath("desktop");   // OK
-getPath("unknown");   // Type error
+getPath("downloads");  // OK
+getPath("desktop");    // OK
+getPath("templates");  // OK
+getPath("unknown");    // Type error
 ```
 
 ## API
@@ -90,8 +140,50 @@ Returns the path to the Pictures directory.
 ### `videos()`
 Returns the path to the Videos directory (Movies on macOS).
 
+### `templates()`
+Returns the path to the Templates directory.
+
+### `publicshare()`
+Returns the path to the Public Share directory.
+
 ### `getPath(name)`
-Returns the path to the specified directory. Valid names: `desktop`, `downloads`, `documents`, `music`, `pictures`, `videos`.
+Returns the path to the specified user directory. Valid names: `desktop`, `downloads`, `documents`, `music`, `pictures`, `videos`, `templates`, `publicshare`.
+
+### Base Directories
+
+#### `configDir()`
+Returns the path to the config directory (`~/.config` on Linux, `~/Library/Application Support` on macOS, `%APPDATA%` on Windows).
+
+#### `dataDir()`
+Returns the path to the data directory (`~/.local/share` on Linux, `~/Library/Application Support` on macOS, `%LOCALAPPDATA%` on Windows).
+
+#### `cacheDir()`
+Returns the path to the cache directory (`~/.cache` on Linux, `~/Library/Caches` on macOS, `%LOCALAPPDATA%` on Windows).
+
+#### `stateDir()`
+Returns the path to the state directory (`~/.local/state` on Linux, `~/Library/Application Support` on macOS, `%LOCALAPPDATA%` on Windows).
+
+#### `logDir()`
+Returns the path to the log directory (`~/.local/state` on Linux, `~/Library/Logs` on macOS, `%LOCALAPPDATA%` on Windows).
+
+#### `runtimeDir()`
+Returns the path to the runtime directory (`$XDG_RUNTIME_DIR` on Linux), or `null` if unavailable.
+
+#### `getBasePath(name)`
+Returns the path to the specified base directory. Valid names: `config`, `data`, `cache`, `state`, `log`, `runtime`.
+
+### Project Directories
+
+#### `projectDirs(name, options?)`
+Returns an object with app-scoped directories for the given application name. This is a zero-dependency alternative to [`env-paths`](https://github.com/sindresorhus/env-paths).
+
+**Parameters:**
+- `name` (string) — Application name
+- `options.suffix` (string, optional) — Suffix appended to the app name (e.g. `"-nodejs"`)
+
+**Returns:** `{ config, data, cache, state, log, temp, runtime }`
+
+On Windows, each directory uses a subdirectory structure (e.g. `%LOCALAPPDATA%/my-app/Config`, `%LOCALAPPDATA%/my-app/Data`).
 
 ## License
 

package/index.d.ts

@@ -1,4 +1,4 @@
-type DirName = "desktop" | "downloads" | "documents" | "music" | "pictures" | "videos";
+type DirName = "desktop" | "downloads" | "documents" | "music" | "pictures" | "videos" | "templates" | "publicshare";
 
 /** Returns the path to the Desktop directory. */
 export function desktop(): string;
@@ -18,9 +18,66 @@ export function pictures(): string;
 /** Returns the path to the Videos directory (Movies on macOS). */
 export function videos(): string;
 
+/** Returns the path to the Templates directory. */
+export function templates(): string;
+
+/** Returns the path to the Public Share directory. */
+export function publicshare(): string;
+
 /** Returns the path to the specified user directory. */
 export function getPath(name: DirName): string;
 
+type BaseDirName = "config" | "data" | "cache" | "state" | "log" | "runtime";
+
+/** Returns the path to the XDG config directory. */
+export function configDir(): string;
+
+/** Returns the path to the XDG data directory. */
+export function dataDir(): string;
+
+/** Returns the path to the XDG cache directory. */
+export function cacheDir(): string;
+
+/** Returns the path to the XDG state directory. */
+export function stateDir(): string;
+
+/** Returns the path to the log directory. */
+export function logDir(): string;
+
+/** Returns the path to the XDG runtime directory, or null if unavailable. */
+export function runtimeDir(): string | null;
+
+/** Returns the path to the specified base directory. */
+export function getBasePath(name: "config"): string;
+export function getBasePath(name: "data"): string;
+export function getBasePath(name: "cache"): string;
+export function getBasePath(name: "state"): string;
+export function getBasePath(name: "log"): string;
+export function getBasePath(name: "runtime"): string | null;
+export function getBasePath(name: BaseDirName): string | null;
+
+interface ProjectDirsOptions {
+    /** Suffix appended to the app name (default: ""). */
+    suffix?: string;
+}
+
+interface ProjectDirsResult {
+    config: string;
+    data: string;
+    cache: string;
+    state: string;
+    log: string;
+    temp: string;
+    runtime: string | null;
+}
+
+/**
+ * Returns application-scoped directories for the given app name.
+ * @param name - Application name used to derive directory paths
+ * @param options - Optional settings (e.g. suffix)
+ */
+export function projectDirs(name: string, options?: ProjectDirsOptions): ProjectDirsResult;
+
 /**
  * Reads an XDG user-dirs.dirs config and returns the directory for the given key.
  * @param key - XDG key (e.g. "XDG_DOWNLOAD_DIR")
@@ -41,7 +98,17 @@ declare const osUserDirs: typeof downloads & {
     music: typeof music;
     pictures: typeof pictures;
     videos: typeof videos;
+    templates: typeof templates;
+    publicshare: typeof publicshare;
     getPath: typeof getPath;
+    configDir: typeof configDir;
+    dataDir: typeof dataDir;
+    cacheDir: typeof cacheDir;
+    stateDir: typeof stateDir;
+    logDir: typeof logDir;
+    runtimeDir: typeof runtimeDir;
+    getBasePath: typeof getBasePath;
+    projectDirs: typeof projectDirs;
     getXDGUserDir: typeof getXDGUserDir;
     getXDGDownloadDir: typeof getXDGDownloadDir;
 };

package/index.js

@@ -9,6 +9,8 @@ const XDG_KEYS = {
     music: "XDG_MUSIC_DIR",
     pictures: "XDG_PICTURES_DIR",
     videos: "XDG_VIDEOS_DIR",
+    templates: "XDG_TEMPLATES_DIR",
+    publicshare: "XDG_PUBLICSHARE_DIR",
 };
 
 const MACOS_DEFAULTS = {
@@ -18,6 +20,8 @@ const MACOS_DEFAULTS = {
     music: "Music",
     pictures: "Pictures",
     videos: "Movies",
+    templates: "Templates",
+    publicshare: "Public",
 };
 
 const DEFAULT_DIRS = {
@@ -27,6 +31,8 @@ const DEFAULT_DIRS = {
     music: "Music",
     pictures: "Pictures",
     videos: "Videos",
+    templates: "Templates",
+    publicshare: "Public",
 };
 
 function getXDGUserDir(key, configPath) {
@@ -74,6 +80,133 @@ function documents() { return resolve("documents"); }
 function music() { return resolve("music"); }
 function pictures() { return resolve("pictures"); }
 function videos() { return resolve("videos"); }
+function templates() { return resolve("templates"); }
+function publicshare() { return resolve("publicshare"); }
+
+const BASE_DIR_CONFIG = {
+    config:  { env: "XDG_CONFIG_HOME",  linux: ".config",        darwin: "Library/Application Support", win32: "APPDATA" },
+    data:    { env: "XDG_DATA_HOME",    linux: ".local/share",   darwin: "Library/Application Support", win32: "LOCALAPPDATA" },
+    cache:   { env: "XDG_CACHE_HOME",   linux: ".cache",         darwin: "Library/Caches",              win32: "LOCALAPPDATA" },
+    state:   { env: "XDG_STATE_HOME",   linux: ".local/state",   darwin: "Library/Application Support", win32: "LOCALAPPDATA" },
+    log:     { env: "XDG_STATE_HOME",   linux: ".local/state",   darwin: "Library/Logs",                win32: "LOCALAPPDATA" },
+    runtime: { env: "XDG_RUNTIME_DIR",  linux: null,             darwin: null,                          win32: null },
+};
+
+function resolveBase(name) {
+    const cfg = BASE_DIR_CONFIG[name];
+    if (!cfg) {
+        throw new Error("Unknown base directory: " + name + ". Valid names: " + Object.keys(BASE_DIR_CONFIG).join(", "));
+    }
+
+    const homedir = os.homedir();
+    const platform = process.platform;
+
+    // On Linux, check the XDG environment variable first
+    if (platform === "linux") {
+        const envVal = process.env[cfg.env];
+        if (envVal) {
+            return path.resolve(envVal);
+        }
+        // Fall back to default suffix, or null for runtime
+        return cfg.linux ? path.join(homedir, cfg.linux) : null;
+    }
+
+    if (platform === "darwin") {
+        return cfg.darwin ? path.join(homedir, cfg.darwin) : null;
+    }
+
+    // Windows: read from environment variable, with hardcoded fallback
+    if (platform === "win32") {
+        if (cfg.win32) {
+            const winVal = process.env[cfg.win32];
+            if (winVal) {
+                return path.resolve(winVal);
+            }
+            // Fallback when env var is missing
+            if (cfg.win32 === "APPDATA") {
+                return path.join(homedir, "AppData", "Roaming");
+            }
+            if (cfg.win32 === "LOCALAPPDATA") {
+                return path.join(homedir, "AppData", "Local");
+            }
+        }
+        return null;
+    }
+
+    // Unknown platform: use XDG-style defaults (same as Linux without env var)
+    return cfg.linux ? path.join(homedir, cfg.linux) : null;
+}
+
+function configDir() { return resolveBase("config"); }
+function dataDir() { return resolveBase("data"); }
+function cacheDir() { return resolveBase("cache"); }
+function stateDir() { return resolveBase("state"); }
+function logDir() { return resolveBase("log"); }
+function runtimeDir() { return resolveBase("runtime"); }
+
+function getBasePath(name) {
+    return resolveBase(name);
+}
+
+const PROJECT_DIR_WIN32_SUB = {
+    config: "Config",
+    data:   "Data",
+    cache:  "Cache",
+    state:  "State",
+    log:    "Log",
+};
+
+function projectDirs(name, options) {
+    if (!name || typeof name !== "string") {
+        throw new Error("projectDirs requires a non-empty string name");
+    }
+
+    const suffix = (options && options.suffix != null) ? options.suffix : "";
+    const appName = name + suffix;
+
+    const homedir = os.homedir();
+    const platform = process.platform;
+
+    function resolveProject(kind) {
+        if (kind === "temp") {
+            if (platform === "win32") {
+                const localAppData = process.env.LOCALAPPDATA || path.join(homedir, "AppData", "Local");
+                return path.join(localAppData, "Temp", appName);
+            }
+            return path.join(os.tmpdir(), appName);
+        }
+
+        if (kind === "runtime") {
+            if (platform === "linux") {
+                const envVal = process.env.XDG_RUNTIME_DIR;
+                if (envVal) {
+                    return path.join(path.resolve(envVal), appName);
+                }
+            }
+            return null;
+        }
+
+        const base = resolveBase(kind);
+        if (!base) { return null; }
+
+        const sub = PROJECT_DIR_WIN32_SUB[kind];
+        if (platform === "win32" && sub) {
+            return path.join(base, appName, sub);
+        }
+
+        return path.join(base, appName);
+    }
+
+    return {
+        config:  resolveProject("config"),
+        data:    resolveProject("data"),
+        cache:   resolveProject("cache"),
+        state:   resolveProject("state"),
+        log:     resolveProject("log"),
+        temp:    resolveProject("temp"),
+        runtime: resolveProject("runtime"),
+    };
+}
 
 // Backward compatibility: require("os-user-dirs")() returns Downloads path
 module.exports = downloads;
@@ -84,6 +217,16 @@ module.exports.documents = documents;
 module.exports.music = music;
 module.exports.pictures = pictures;
 module.exports.videos = videos;
+module.exports.templates = templates;
+module.exports.publicshare = publicshare;
+module.exports.configDir = configDir;
+module.exports.dataDir = dataDir;
+module.exports.cacheDir = cacheDir;
+module.exports.stateDir = stateDir;
+module.exports.logDir = logDir;
+module.exports.runtimeDir = runtimeDir;
+module.exports.getBasePath = getBasePath;
+module.exports.projectDirs = projectDirs;
 module.exports.getXDGUserDir = getXDGUserDir;
 
 // Deprecated: kept for backward compatibility

package/index.mjs

@@ -7,6 +7,16 @@ export const documents = osUserDirs.documents;
 export const music = osUserDirs.music;
 export const pictures = osUserDirs.pictures;
 export const videos = osUserDirs.videos;
+export const templates = osUserDirs.templates;
+export const publicshare = osUserDirs.publicshare;
 export const getPath = osUserDirs.getPath;
+export const configDir = osUserDirs.configDir;
+export const dataDir = osUserDirs.dataDir;
+export const cacheDir = osUserDirs.cacheDir;
+export const stateDir = osUserDirs.stateDir;
+export const logDir = osUserDirs.logDir;
+export const runtimeDir = osUserDirs.runtimeDir;
+export const getBasePath = osUserDirs.getBasePath;
+export const projectDirs = osUserDirs.projectDirs;
 export const getXDGUserDir = osUserDirs.getXDGUserDir;
 export const getXDGDownloadDir = osUserDirs.getXDGDownloadDir;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "os-user-dirs",
-  "version": "2.2.0",
-  "description": "Get OS-specific user directories (Downloads, Desktop, Documents, Music, Pictures, Videos) with zero dependencies.",
+  "version": "2.4.0",
+  "description": "Get OS-specific user directories and XDG base directories (config, data, cache, runtime) with zero dependencies.",
   "main": "index.js",
   "types": "index.d.ts",
   "exports": {
@@ -32,6 +32,11 @@
     "music",
     "pictures",
     "videos",
+    "templates",
+    "public",
+    "config",
+    "data",
+    "cache",
     "xdg",
     "user-dirs",
     "platform-folders"