platformdirs 4.3.6-rc1

package/dist/windows.js

@@ -0,0 +1,226 @@
+/**
+ * @module
+ * Windows.
+ */
+import * as path from "node:path";
+import process from "node:process";
+import { PlatformDirsABC } from "./api.js";
+/**
+ * [MSDN on where to store app data
+ * files](https://learn.microsoft.com/en-us/windows/win32/shell/knownfolderid)
+ *
+ * Makes use of the {@link PlatformDirsABC.appname},
+ * {@link PlatformDirsABC.appauthor}, {@link PlatformDirsABC.version},
+ * {@link PlatformDirsABC.roaming}, {@link PlatformDirsABC.opinion},
+ * {@link PlatformDirsABC.ensureExists}.
+ */
+export class Windows extends PlatformDirsABC {
+    /**
+     * @return data directory tied to the user, e.g. `%USERPROFILE%\AppData\Local\$appauthor\$appname` (not roaming) or `%USERPROFILE%\AppData\Roaming\$appauthor\$appname` (roaming)
+     */
+    get userDataDir() {
+        const const2 = this.roaming ? "CSIDL_APPDATA" : "CSIDL_LOCAL_APPDATA";
+        const path2 = path.normalize(getWinFolder(const2));
+        return this._appendParts(path2);
+    }
+    _appendParts(path2, { opinionValue } = {}) {
+        const params = [];
+        if (this.appname) {
+            if (this.appauthor !== false) {
+                const author = this.appauthor || this.appname;
+                params.push(author);
+            }
+            params.push(this.appname);
+            if (opinionValue !== undefined && this.opinion) {
+                params.push(opinionValue);
+            }
+            if (this.version) {
+                params.push(this.version);
+            }
+        }
+        const path3 = path.join(path2, ...params);
+        this._optionallyCreateDirectory(path3);
+        return path3;
+    }
+    /**
+     * @return data directory shared by users, e.g. `C:\ProgramData\$appauthor\$appname`
+     */
+    get siteDataDir() {
+        const path2 = path.normalize(getWinFolder("CSIDL_COMMON_APPDATA"));
+        return this._appendParts(path2);
+    }
+    /**
+     * @return config directory tied to the user, same as `userDataDir`
+     */
+    get userConfigDir() {
+        return this.userDataDir;
+    }
+    /**
+     * @return config directory shared by users, same as `siteDataDir`
+     */
+    get siteConfigDir() {
+        return this.siteDataDir;
+    }
+    /**
+     * @return cache directory tied to the user (if opinionated with `Cache` folder within `$appname`) e.g. `%USERPROFILE%\AppData\Local\$appauthor\$appname\Cache\$version`
+     */
+    get userCacheDir() {
+        const path2 = path.normalize(getWinFolder("CSIDL_LOCAL_APPDATA"));
+        return this._appendParts(path2, { opinionValue: "Cache" });
+    }
+    /**
+     * @return cache directory shared by users, e.g. `C:\ProgramData\$appauthor\$appname\Cache\$version`
+     */
+    get siteCacheDir() {
+        const path2 = path.normalize(getWinFolder("CSIDL_COMMON_APPDATA"));
+        return this._appendParts(path2, { opinionValue: "Cache" });
+    }
+    /**
+     * @return state directory tied to the user, same as `userDataDir`
+     */
+    get userStateDir() {
+        return this.userDataDir;
+    }
+    /**
+     * @return log directory tied to the user, same as `userCacheDir` if not opinionated else `log` in it
+     */
+    get userLogDir() {
+        let path2 = this.userDataDir;
+        if (this.opinion) {
+            path2 = path.join(path2, "Logs");
+            this._optionallyCreateDirectory(path2);
+        }
+        return path2;
+    }
+    /**
+     * @return documents directory tied to the user, e.g. `%USERPROFILE%\Documents`
+     */
+    get userDocumentsDir() {
+        return path.normalize(getWinFolder("CSIDL_PERSONAL"));
+    }
+    /**
+     * @return downloads directory tied to the user, e.g. `%USERPROFILE%\Downloads`
+     */
+    get userDownloadsDir() {
+        return path.normalize(getWinFolder("CSIDL_DOWNLOADS"));
+    }
+    /**
+     * @return pictures directory tied to the user, e.g. `%USERPROFILE%\Pictures`
+     */
+    get userPicturesDir() {
+        return path.normalize(getWinFolder("CSIDL_MYPICTURES"));
+    }
+    /**
+     * @return videos directory tied to the user, e.g. `%USERPROFILE%\Videos`
+     */
+    get userVideosDir() {
+        return path.normalize(getWinFolder("CSIDL_MYVIDEO"));
+    }
+    /**
+     * @return music directory tied to the user, e.g. `%USERPROFILE%\Music`
+     */
+    get userMusicDir() {
+        return path.normalize(getWinFolder("CSIDL_MYMUSIC"));
+    }
+    /**
+     * @return desktop directory tied to the user, e.g. `%USERPROFILE%\Desktop`
+     */
+    get userDesktopDir() {
+        return path.normalize(getWinFolder("CSIDL_DESKTOPDIRECTORY"));
+    }
+    /**
+     * @return runtime directory tied to the user, e.g. `%USERPROFILE%\AppData\Local\Temp\$appauthor\$appname`
+     */
+    get userRuntimeDir() {
+        const path2 = path.normalize(path.join(getWinFolder("CSIDL_LOCAL_APPDATA"), "Temp"));
+        return this._appendParts(path2);
+    }
+    /**
+     * @return runtime directory shared by users, same as `userRuntimeDir`
+     */
+    get siteRuntimeDir() {
+        return this.userRuntimeDir;
+    }
+}
+/**
+ * Get folder from environment variable
+ */
+function getWinFolderFromEnvVars(csidlName) {
+    let result = getWinFolderIfCSIDLNameNotEnvVar(csidlName);
+    if (result !== undefined) {
+        return result;
+    }
+    if (csidlName === "CSIDL_APPDATA") {
+        result = process.env.APPDATA;
+        if (result === undefined) {
+            throw new Error("Unset environment variable: APPDATA");
+        }
+    }
+    else if (csidlName === "CSIDL_COMMON_APPDATA") {
+        result = process.env.ALLUSERSPROFILE;
+        if (result === undefined) {
+            throw new Error("Unset environment variable: ALLUSERSPROFILE");
+        }
+    }
+    else if (csidlName === "CSIDL_LOCAL_APPDATA") {
+        result = process.env.LOCALAPPDATA;
+        if (result === undefined) {
+            throw new Error("Unset environment variable: LOCALAPPDATA");
+        }
+    }
+    else {
+        throw new Error(`Unknown CSIDL name: ${csidlName}`);
+    }
+    return result;
+}
+/**
+ * Get a folder for a CSIDL name that does not exist as an environment variable.
+ */
+function getWinFolderIfCSIDLNameNotEnvVar(csidlName) {
+    if (csidlName === "CSIDL_PERSONAL") {
+        const p = process.env.USERPROFILE;
+        if (p === undefined) {
+            throw new Error("Unset environment variable: USERPROFILE");
+        }
+        return path.join(path.normalize(p), "Documents");
+    }
+    if (csidlName === "CSIDL_DOWNLOADS") {
+        const p = process.env.USERPROFILE;
+        if (p === undefined) {
+            throw new Error("Unset environment variable: USERPROFILE");
+        }
+        return path.join(path.normalize(p), "Downloads");
+    }
+    if (csidlName === "CSIDL_MYPICTURES") {
+        const p = process.env.USERPROFILE;
+        if (p === undefined) {
+            throw new Error("Unset environment variable: USERPROFILE");
+        }
+        return path.join(path.normalize(p), "Pictures");
+    }
+    if (csidlName === "CSIDL_MYVIDEO") {
+        const p = process.env.USERPROFILE;
+        if (p === undefined) {
+            throw new Error("Unset environment variable: USERPROFILE");
+        }
+        return path.join(path.normalize(p), "Videos");
+    }
+    if (csidlName === "CSIDL_MYMUSIC") {
+        const p = process.env.USERPROFILE;
+        if (p === undefined) {
+            throw new Error("Unset environment variable: USERPROFILE");
+        }
+        return path.join(path.normalize(p), "Music");
+    }
+    return undefined;
+}
+// function getWinFolderFromRegistry(csidlName: string): string {
+//   throw new Error("Not implemented");
+// }
+// function getWinFolderViaCTypes(csidlName: string): string {
+//   throw new Error("Not implemented");
+// }
+function pickGetWinFolder() {
+    return getWinFolderFromEnvVars;
+}
+const getWinFolder = pickGetWinFolder();

package/package.json

@@ -0,0 +1,53 @@
+{
+	"name": "platformdirs",
+	"version": "4.3.6-rc1",
+	"description": "📂 Unified interface to get platform-specific directories",
+	"keywords": [
+		"nodejs",
+		"port",
+		"xdg",
+		"xdg-basedir",
+		"bun",
+		"deno",
+		"appdirs",
+		"known-folders",
+		"platformdirs"
+	],
+	"homepage": "https://www.jsdocs.io/package/platformdirs",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/jcbhmr/platformdirs.js.git"
+	},
+	"license": "MIT",
+	"author": "Jacob Hummer <jcbhmr@outlook.com> (https://jcbhmr.me)",
+	"type": "module",
+	"exports": {
+		".": "./dist/index.js",
+		"./android": "./dist/android.js",
+		"./api": "./dist/api.js",
+		"./macos": "./dist/macos.js",
+		"./unix": "./dist/unix.js",
+		"./version": "./dist/version.js"
+	},
+	"bin": {
+		"platformdirs": "dist/main.js"
+	},
+	"files": ["dist"],
+	"scripts": {
+		"build": "tsc --noCheck",
+		"format": "biome format --write .",
+		"lint": "biome check --write . && tsc --noEmit",
+		"run": "tsx src/main.ts",
+		"test": "tsx --test"
+	},
+	"devDependencies": {
+		"@biomejs/biome": "1.9.4",
+		"@types/node": "^22.9.0",
+		"execa": "^9.5.1",
+		"tsx": "^4.19.2",
+		"typescript": "^5.6.3"
+	},
+	"engines": {
+		"node": ">=18"
+	}
+}