mod.ts

import home_dir from "./home_dir/mod.ts";
import cache_dir from "./cache_dir/mod.ts";
import config_dir from "./config_dir/mod.ts";
import data_dir from "./data_dir/mod.ts";
import data_local_dir from "./data_local_dir/mod.ts";
import download_dir from "./download_dir/mod.ts";
import tmp_dir from "./tmp_dir/mod.ts";

export type DirKind =
  | "home"
  | "cache"
  | "config"
  | "data"
  | "data_local"
  | "download"
  | "tmp";

// | "executable"
// | "audio"
// | "desktop"
// | "document"
// | "font"
// | "picture"
// | "public"
// | "template"
// | "tmp"
// | "video";

/** Returns the user and platform specific directories.
 *
 * ```ts
 * import { dir } from "https://deno.land/x/dir/mod.ts";
 * const homeDirectory = dir("home");
 * ```
 *
 * Requires `allow-env` permission.
 *
 * Returns `null` if there is no applicable directory or if any other error
 * occurs.
 *
 * Argument values: `"home"`, `"cache"`, `"config"`, `"data"`, `"data_local"`, `"download"`,
 *
 * `"home"`
 *
 * |Platform | Value                                    | Example                |
 * | ------- | -----------------------------------------| -----------------------|
 * | Linux   | `$HOME`                                  | /home/justjavac        |
 * | macOS   | `$HOME`                                  | /Users/justjavac       |
 * | Windows | `{FOLDERID_Profile}`                     | C:\Users\justjavac     |
 *
 * `"cache"`
 *
 * |Platform | Value                               | Example                          |
 * | ------- | ----------------------------------- | -------------------------------- |
 * | Linux   | `$XDG_CACHE_HOME` or `$HOME`/.cache | /home/justjavac/.cache           |
 * | macOS   | `$HOME`/Library/Caches              | /Users/justjavac/Library/Caches  |
 * | Windows | `{FOLDERID_LocalAppData}`           | C:\Users\justjavac\AppData\Local |
 *
 * `"config"`
 *
 * |Platform | Value                                 | Example                              |
 * | ------- | ------------------------------------- | ------------------------------------ |
 * | Linux   | `$XDG_CONFIG_HOME` or `$HOME`/.config | /home/justjavac/.config              |
 * | macOS   | `$HOME`/Library/Preferences           | /Users/justjavac/Library/Preferences |
 * | Windows | `{FOLDERID_RoamingAppData}`           | C:\Users\justjavac\AppData\Roaming   |
 *
 * `"executable"`
 *
 * |Platform | Value                                                           | Example                    |
 * | ------- | --------------------------------------------------------------- | ---------------------------|
 * | Linux   | `XDG_BIN_HOME` or `$XDG_DATA_HOME`/../bin or `$HOME`/.local/bin | /home/justjavac/.local/bin |
 * | macOS   | -                                                               | -                          |
 * | Windows | -                                                               | -                          |
 *
 * `"data"`
 *
 * | Platform | Value                                    | Example                                      |
 * | -------- | ---------------------------------------- | -------------------------------------------- |
 * | Linux    | `$XDG_DATA_HOME` or `$HOME`/.local/share | /home/justjavac/.local/share                 |
 * | macOS    | `$HOME`/Library/Application Support      | /Users/justjavac/Library/Application Support |
 * | Windows  | `$APPDATA`                               | C:\Users\justjavac\AppData\Roaming           |
 *
 * `"data_local"`
 *
 * | Platform | Value                                    | Example                                      |
 * | -------- | ---------------------------------------- | -------------------------------------------- |
 * | Linux    | `$XDG_DATA_HOME` or `$HOME`/.local/share | /home/justjavac/.local/share                 |
 * | macOS    | `$HOME`/Library/Application Support      | /Users/justjavac/Library/Application Support |
 * | Windows  | `$LOCALAPPDATA`                          | C:\Users\justjavac\AppData\Local             |
 *
 * `"audio"`
 *
 * |Platform | Value              | Example                  |
 * | ------- | ------------------ | ------------------------ |
 * | Linux   | `XDG_MUSIC_DIR`    | /home/justjavac/Music    |
 * | macOS   | `$HOME`/Music      | /Users/justjavac/Music   |
 * | Windows | `{FOLDERID_Music}` | C:\Users\justjavac\Music |
 *
 * `"desktop"`
 *
 * |Platform | Value                | Example                    |
 * | ------- | -------------------- | -------------------------- |
 * | Linux   | `XDG_DESKTOP_DIR`    | /home/justjavac/Desktop    |
 * | macOS   | `$HOME`/Desktop      | /Users/justjavac/Desktop   |
 * | Windows | `{FOLDERID_Desktop}` | C:\Users\justjavac\Desktop |
 *
 * `"document"`
 *
 * |Platform | Value                  | Example                      |
 * | ------- | ---------------------- | ---------------------------- |
 * | Linux   | `XDG_DOCUMENTS_DIR`    | /home/justjavac/Documents    |
 * | macOS   | `$HOME`/Documents      | /Users/justjavac/Documents   |
 * | Windows | `{FOLDERID_Documents}` | C:\Users\justjavac\Documents |
 *
 * `"download"`
 *
 * |Platform | Value                  | Example                      |
 * | ------- | ---------------------- | ---------------------------- |
 * | Linux   | `XDG_DOWNLOAD_DIR`     | /home/justjavac/Downloads    |
 * | macOS   | `$HOME`/Downloads      | /Users/justjavac/Downloads   |
 * | Windows | `{FOLDERID_Downloads}` | C:\Users\justjavac\Downloads |
 *
 * `"font"`
 *
 * |Platform | Value                                                | Example                            |
 * | ------- | ---------------------------------------------------- | ---------------------------------- |
 * | Linux   | `$XDG_DATA_HOME`/fonts or `$HOME`/.local/share/fonts | /home/justjavac/.local/share/fonts |
 * | macOS   | `$HOME/Library/Fonts`                                | /Users/justjavac/Library/Fonts     |
 * | Windows | –                                                    | –                                  |
 *
 * `"picture"`
 *
 * |Platform | Value                 | Example                     |
 * | ------- | --------------------- | --------------------------- |
 * | Linux   | `XDG_PICTURES_DIR`    | /home/justjavac/Pictures    |
 * | macOS   | `$HOME`/Pictures      | /Users/justjavac/Pictures   |
 * | Windows | `{FOLDERID_Pictures}` | C:\Users\justjavac\Pictures |
 *
 * `"public"`
 *
 * |Platform | Value                 | Example                 |
 * | ------- | --------------------- | ----------------------- |
 * | Linux   | `XDG_PUBLICSHARE_DIR` | /home/justjavac/Public  |
 * | macOS   | `$HOME`/Public        | /Users/justjavac/Public |
 * | Windows | `{FOLDERID_Public}`   | C:\Users\Public         |
 *
 * `"template"`
 *
 * |Platform | Value                  | Example                                                        |
 * | ------- | ---------------------- | -------------------------------------------------------------- |
 * | Linux   | `XDG_TEMPLATES_DIR`    | /home/justjavac/Templates                                      |
 * | macOS   | –                      | –                                                              |
 * | Windows | `{FOLDERID_Templates}` | C:\Users\justjavac\AppData\Roaming\Microsoft\Windows\Templates |
 *
 * `"tmp"`
 *
 * |Platform | Value                  | Example                                                    |
 * | ------- | ---------------------- | ---------------------------------------------------------- |
 * | Linux   | `TMPDIR`               | /tmp                                                       |
 * | macOS   | `TMPDIR`               | /tmp                                                       |
 * | Windows | `{TMP}`                | C:\Users\justjavac\AppData\Local\Temp                      |
 *
 * `"video"`
 *
 * |Platform | Value               | Example                  |
 * | ------- | ------------------- | ------------------------- |
 * | Linux   | `XDG_VIDEOS_DIR`    | /home/justjavac/Videos    |
 * | macOS   | `$HOME`/Movies      | /Users/justjavac/Movies   |
 * | Windows | `{FOLDERID_Videos}` | C:\Users\justjavac\Videos |
 */
export default function dir(kind: DirKind): string | null {
  switch (kind) {
    case "home":
      return home_dir();
    case "cache":
      return cache_dir();
    case "config":
      return config_dir();
    case "data":
      return data_dir();
    case "data_local":
      return data_local_dir();
    case "download":
      return download_dir();
    case "tmp":
      return tmp_dir();
    default:
      return null;
  }
}