@vltpkg/xdg 0.0.0-3 → 0.0.0-30
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -2
- package/dist/esm/index.js +2 -2
- package/dist/esm/index.js.map +1 -1
- package/package.json +9 -8
package/README.md
CHANGED
|
@@ -2,12 +2,14 @@
|
|
|
2
2
|
|
|
3
3
|
# @vltpkg/xdg
|
|
4
4
|
|
|
5
|
-
Get appropriate data, cache, and config directories following the
|
|
5
|
+
Get appropriate data, cache, and config directories following the
|
|
6
|
+
[XDG spec](https://wiki.archlinux.org/title/XDG_Base_Directory),
|
|
7
|
+
namespaced to a specific app-name subfolder.
|
|
6
8
|
|
|
7
9
|
## Usage
|
|
8
10
|
|
|
9
11
|
```js
|
|
10
|
-
import XDG from '@vltpkg/xdg'
|
|
12
|
+
import { XDG } from '@vltpkg/xdg'
|
|
11
13
|
|
|
12
14
|
// instantiate with the name of your thing.
|
|
13
15
|
const xdg = new XDG('vlt')
|
package/dist/esm/index.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { homedir, tmpdir } from 'os';
|
|
2
|
-
import { resolve } from 'path';
|
|
1
|
+
import { homedir, tmpdir } from 'node:os';
|
|
2
|
+
import { resolve } from 'node:path';
|
|
3
3
|
const root = homedir();
|
|
4
4
|
const path = (p) => resolve(root, p);
|
|
5
5
|
const defaults = process.platform === 'darwin' ?
|
package/dist/esm/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AACzC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAEnC,MAAM,IAAI,GAAG,OAAO,EAAE,CAAA;AACtB,MAAM,IAAI,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAA;AAS5C,MAAM,QAAQ,GACZ,OAAO,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC;IAC7B,CAAC,KAAe,EAAU,EAAE;QAC1B,QAAQ,KAAK,EAAE,CAAC;YACd,KAAK,QAAQ;gBACX,OAAO,IAAI,CAAC,qBAAqB,CAAC,CAAA;YACpC,KAAK,OAAO;gBACV,OAAO,IAAI,CAAC,gBAAgB,CAAC,CAAA;YAC/B,KAAK,MAAM;gBACT,OAAO,IAAI,CAAC,6BAA6B,CAAC,CAAA;YAC5C,KAAK,OAAO;gBACV,OAAO,IAAI,CAAC,eAAe,CAAC,CAAA;YAC9B,KAAK,SAAS;gBACZ,OAAO,OAAO,CACZ,MAAM,EAAE;gBACR,oBAAoB;gBACpB,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,CAAC,EAChC,MAAM,CACP,CAAA;QACL,CAAC;IACH,CAAC;IACH,CAAC,CAAC,OAAO,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC;QAC9B,CAAC,KAAe,EAAU,EAAE;YAC1B,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,IAAI,IAAI,CAAC,iBAAiB,CAAC,CAAA;YACzD,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,YAAY,IAAI,IAAI,CAAC,eAAe,CAAC,CAAA;YAC7D,QAAQ,KAAK,EAAE,CAAC;gBACd,KAAK,QAAQ;oBACX,OAAO,OAAO,CAAC,EAAE,EAAE,YAAY,CAAC,CAAA;gBAClC,KAAK,OAAO;oBACV,OAAO,OAAO,CAAC,GAAG,EAAE,WAAW,CAAC,CAAA;gBAClC,KAAK,MAAM;oBACT,OAAO,OAAO,CAAC,EAAE,EAAE,UAAU,CAAC,CAAA;gBAChC,KAAK,OAAO;oBACV,OAAO,OAAO,CAAC,GAAG,EAAE,WAAW,CAAC,CAAA;gBAClC,KAAK,SAAS;oBACZ,OAAO,OAAO,CAAC,MAAM,EAAE,EAAE,SAAS,CAAC,CAAA;YACvC,CAAC;QACH,CAAC;QACH,CAAC,CAAC,CAAC,KAAe,EAAU,EAAE;YAC1B,QAAQ,KAAK,EAAE,CAAC;gBACd,KAAK,QAAQ;oBACX,OAAO,IAAI,CAAC,SAAS,CAAC,CAAA;gBACxB,KAAK,OAAO;oBACV,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAA;gBACvB,KAAK,MAAM;oBACT,OAAO,IAAI,CAAC,cAAc,CAAC,CAAA;gBAC7B,KAAK,OAAO;oBACV,OAAO,IAAI,CAAC,cAAc,CAAC,CAAA;gBAC7B,KAAK,SAAS;oBACZ,OAAO,OAAO,CACZ,MAAM,EAAE;oBACR,oBAAoB;oBACpB,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,CAAC,EAChC,MAAM,CACP,CAAA;YACL,CAAC;QACH,CAAC,CAAA;AAEL,MAAM,EACJ,eAAe,GAAG,QAAQ,CAAC,QAAQ,CAAC,EACpC,cAAc,GAAG,QAAQ,CAAC,OAAO,CAAC,EAClC,aAAa,GAAG,QAAQ,CAAC,MAAM,CAAC,EAChC,cAAc,GAAG,QAAQ,CAAC,OAAO,CAAC,EAClC,eAAe,GAAG,QAAQ,CAAC,SAAS,CAAC,GACtC,GAAG,OAAO,CAAC,GAAG,CAAA;AAEf,MAAM,OAAO,GAAG;IACd,IAAI,CAAQ;IACZ,IAAI,GAAgC;QAClC,MAAM,EAAE,eAAe;QACvB,KAAK,EAAE,cAAc;QACrB,IAAI,EAAE,aAAa;QACnB,KAAK,EAAE,cAAc;QACrB,OAAO,EAAE,eAAe;KACzB,CAAA;IACD,YAAY,IAAY;QACtB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IAClB,CAAC;IACD,MAAM,CAAC,CAAC,GAAG,EAAE;QACX,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAA;IAChD,CAAC;IACD,KAAK,CAAC,CAAC,GAAG,EAAE;QACV,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAA;IAC/C,CAAC;IACD,IAAI,CAAC,CAAC,GAAG,EAAE;QACT,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAA;IAC9C,CAAC;IACD,KAAK,CAAC,CAAC,GAAG,EAAE;QACV,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAA;IAC/C,CAAC;IACD,OAAO,CAAC,CAAC,GAAG,EAAE;QACZ,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAA;IACjD,CAAC;CACF","sourcesContent":["import { homedir, tmpdir } from 'node:os'\nimport { resolve } from 'node:path'\n\nconst root = homedir()\nconst path = (p: string) => resolve(root, p)\n\nexport type PathType =\n | 'cache'\n | 'config'\n | 'data'\n | 'runtime'\n | 'state'\n\nconst defaults =\n process.platform === 'darwin' ?\n (which: PathType): string => {\n switch (which) {\n case 'config':\n return path('Library/Preferences')\n case 'cache':\n return path('Library/Caches')\n case 'data':\n return path('Library/Application Support')\n case 'state':\n return path('Library/State')\n case 'runtime':\n return resolve(\n tmpdir(),\n /* c8 ignore next */\n String(process.getuid?.() ?? ''),\n '.run',\n )\n }\n }\n : process.platform === 'win32' ?\n (which: PathType): string => {\n const ad = process.env.APPDATA ?? path('AppData/Roaming')\n const lad = process.env.LOCALAPPDATA ?? path('AppData/Local')\n switch (which) {\n case 'config':\n return resolve(ad, 'xdg.config')\n case 'cache':\n return resolve(lad, 'xdg.cache')\n case 'data':\n return resolve(ad, 'xdg.data')\n case 'state':\n return resolve(lad, 'xdg.state')\n case 'runtime':\n return resolve(tmpdir(), 'xdg.run')\n }\n }\n : (which: PathType): string => {\n switch (which) {\n case 'config':\n return path('.config')\n case 'cache':\n return path('.cache')\n case 'data':\n return path('.local/share')\n case 'state':\n return path('.local/state')\n case 'runtime':\n return resolve(\n tmpdir(),\n /* c8 ignore next */\n String(process.getuid?.() ?? ''),\n '.run',\n )\n }\n }\n\nconst {\n XDG_CONFIG_HOME = defaults('config'),\n XDG_CACHE_HOME = defaults('cache'),\n XDG_DATA_HOME = defaults('data'),\n XDG_STATE_HOME = defaults('state'),\n XDG_RUNTIME_DIR = defaults('runtime'),\n} = process.env\n\nexport class XDG {\n name: string\n base: { [k in PathType]: string } = {\n config: XDG_CONFIG_HOME,\n cache: XDG_CACHE_HOME,\n data: XDG_DATA_HOME,\n state: XDG_STATE_HOME,\n runtime: XDG_RUNTIME_DIR,\n }\n constructor(name: string) {\n this.name = name\n }\n config(p = '') {\n return resolve(this.base.config, this.name, p)\n }\n cache(p = '') {\n return resolve(this.base.cache, this.name, p)\n }\n data(p = '') {\n return resolve(this.base.data, this.name, p)\n }\n state(p = '') {\n return resolve(this.base.state, this.name, p)\n }\n runtime(p = '') {\n return resolve(this.base.runtime, this.name, p)\n }\n}\n"]}
|
package/package.json
CHANGED
|
@@ -1,12 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vltpkg/xdg",
|
|
3
3
|
"description": "platform-specific app directories following XDG spec",
|
|
4
|
-
"version": "0.0.0-
|
|
4
|
+
"version": "0.0.0-30",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
7
7
|
"url": "git+https://github.com/vltpkg/vltpkg.git",
|
|
8
8
|
"directory": "src/xdg"
|
|
9
9
|
},
|
|
10
|
+
"author": "vlt technology inc. <support@vlt.sh> (http://vlt.sh)",
|
|
10
11
|
"tshy": {
|
|
11
12
|
"selfLink": false,
|
|
12
13
|
"liveDev": true,
|
|
@@ -19,16 +20,15 @@
|
|
|
19
20
|
}
|
|
20
21
|
},
|
|
21
22
|
"devDependencies": {
|
|
22
|
-
"@eslint/js": "^9.
|
|
23
|
-
"@types/
|
|
24
|
-
"
|
|
25
|
-
"
|
|
26
|
-
"prettier": "^3.4.2",
|
|
23
|
+
"@eslint/js": "^9.34.0",
|
|
24
|
+
"@types/node": "^22.17.2",
|
|
25
|
+
"eslint": "^9.34.0",
|
|
26
|
+
"prettier": "^3.6.2",
|
|
27
27
|
"tap": "^21.1.0",
|
|
28
28
|
"tshy": "^3.0.2",
|
|
29
|
-
"typedoc": "0.27.
|
|
29
|
+
"typedoc": "~0.27.9",
|
|
30
30
|
"typescript": "5.7.3",
|
|
31
|
-
"typescript-eslint": "^8.
|
|
31
|
+
"typescript-eslint": "^8.40.0"
|
|
32
32
|
},
|
|
33
33
|
"license": "BSD-2-Clause-Patent",
|
|
34
34
|
"engines": {
|
|
@@ -60,6 +60,7 @@
|
|
|
60
60
|
"snap": "tap",
|
|
61
61
|
"test": "tap",
|
|
62
62
|
"posttest": "tsc --noEmit",
|
|
63
|
+
"tshy": "tshy",
|
|
63
64
|
"typecheck": "tsc --noEmit"
|
|
64
65
|
}
|
|
65
66
|
}
|