pax_global_header00006660000000000000000000000064141030155670014514gustar00rootroot0000000000000052 comment=8cceade858e4da18cb971bf1844f086e9e213563 xdg-basedir-5.1.0/000077500000000000000000000000001410301556700137105ustar00rootroot00000000000000xdg-basedir-5.1.0/.editorconfig000066400000000000000000000002571410301556700163710ustar00rootroot00000000000000root = true [*] indent_style = tab end_of_line = lf charset = utf-8 trim_trailing_whitespace = true insert_final_newline = true [*.yml] indent_style = space indent_size = 2 xdg-basedir-5.1.0/.gitattributes000066400000000000000000000000231410301556700165760ustar00rootroot00000000000000* text=auto eol=lf xdg-basedir-5.1.0/.github/000077500000000000000000000000001410301556700152505ustar00rootroot00000000000000xdg-basedir-5.1.0/.github/funding.yml000066400000000000000000000001651410301556700174270ustar00rootroot00000000000000github: sindresorhus open_collective: sindresorhus tidelift: npm/xdg-basedir custom: https://sindresorhus.com/donate xdg-basedir-5.1.0/.github/security.md000066400000000000000000000002631410301556700174420ustar00rootroot00000000000000# Security Policy To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure. xdg-basedir-5.1.0/.github/workflows/000077500000000000000000000000001410301556700173055ustar00rootroot00000000000000xdg-basedir-5.1.0/.github/workflows/main.yml000066400000000000000000000006451410301556700207610ustar00rootroot00000000000000name: CI on: - push - pull_request jobs: test: name: Node.js ${{ matrix.node-version }} runs-on: ubuntu-latest strategy: fail-fast: false matrix: node-version: - 14 - 12 steps: - uses: actions/checkout@v2 - uses: actions/setup-node@v1 with: node-version: ${{ matrix.node-version }} - run: npm install - run: npm test xdg-basedir-5.1.0/.gitignore000066400000000000000000000000271410301556700156770ustar00rootroot00000000000000node_modules yarn.lock xdg-basedir-5.1.0/.npmrc000066400000000000000000000000231410301556700150230ustar00rootroot00000000000000package-lock=false xdg-basedir-5.1.0/index.d.ts000066400000000000000000000033751410301556700156210ustar00rootroot00000000000000/** Directory for user-specific data files. @example ``` import {xdgData} from 'xdg-basedir'; console.log(xdgData); //=> '/home/sindresorhus/.local/share' ``` */ export const xdgData: string | undefined; /** Directory for user-specific configuration files. @example ``` import {xdgConfig} from 'xdg-basedir'; console.log(xdgConfig); //=> '/home/sindresorhus/.config' ``` */ export const xdgConfig: string | undefined; /** Directory for user-specific state files. @example ``` import {xdgState} from 'xdg-basedir'; console.log(xdgState); //=> '/home/sindresorhus/.local/state' ``` */ export const xdgState: string | undefined; /** Directory for user-specific non-essential data files. @example ``` import {xdgCache} from 'xdg-basedir'; console.log(xdgCache); //=> '/home/sindresorhus/.cache' ``` */ export const xdgCache: string | undefined; /** Directory for user-specific non-essential runtime files and other file objects (such as sockets, named pipes, etc). @example ``` import {xdgRuntime} from 'xdg-basedir'; console.log(xdgRuntime); //=> '/run/user/sindresorhus' ``` */ export const xdgRuntime: string | undefined; /** Preference-ordered array of base directories to search for data files in addition to `xdgData`. @example ``` import {xdgDataDirectories} from 'xdg-basedir'; console.log(xdgDataDirectories); //=> ['/home/sindresorhus/.local/share', '/usr/local/share/', '/usr/share/'] ``` */ export const xdgDataDirectories: readonly string[]; /** Preference-ordered array of base directories to search for configuration files in addition to `xdgConfig`. @example ``` import {xdgConfigDirectories} from 'xdg-basedir'; console.log(xdgConfigDirectories); //=> ['/home/sindresorhus/.config', '/etc/xdg'] ``` */ export const xdgConfigDirectories: readonly string[]; xdg-basedir-5.1.0/index.js000066400000000000000000000016621410301556700153620ustar00rootroot00000000000000import os from 'os'; import path from 'path'; const homeDirectory = os.homedir(); const {env} = process; export const xdgData = env.XDG_DATA_HOME || (homeDirectory ? path.join(homeDirectory, '.local', 'share') : undefined); export const xdgConfig = env.XDG_CONFIG_HOME || (homeDirectory ? path.join(homeDirectory, '.config') : undefined); export const xdgState = env.XDG_STATE_HOME || (homeDirectory ? path.join(homeDirectory, '.local', 'state') : undefined); export const xdgCache = env.XDG_CACHE_HOME || (homeDirectory ? path.join(homeDirectory, '.cache') : undefined); export const xdgRuntime = env.XDG_RUNTIME_DIR || undefined; export const xdgDataDirectories = (env.XDG_DATA_DIRS || '/usr/local/share/:/usr/share/').split(':'); if (xdgData) { xdgDataDirectories.unshift(xdgData); } export const xdgConfigDirectories = (env.XDG_CONFIG_DIRS || '/etc/xdg').split(':'); if (xdgConfig) { xdgConfigDirectories.unshift(xdgConfig); } xdg-basedir-5.1.0/index.test-d.ts000066400000000000000000000013301410301556700165630ustar00rootroot00000000000000import {expectType, expectError} from 'tsd'; import {xdgData, xdgConfig, xdgState, xdgCache, xdgRuntime, xdgConfigDirectories, xdgDataDirectories} from './index.js'; expectType(xdgData); expectError(xdgData); expectType(xdgConfig); expectError(xdgConfig); expectType(xdgState); expectError(xdgState); expectType(xdgCache); expectError(xdgCache); expectType(xdgRuntime); expectError(xdgRuntime); expectType(xdgConfigDirectories); expectError(xdgConfigDirectories); expectType(xdgDataDirectories); expectError(xdgDataDirectories); xdg-basedir-5.1.0/license000066400000000000000000000021351410301556700152560ustar00rootroot00000000000000MIT License Copyright (c) Sindre Sorhus (https://sindresorhus.com) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. xdg-basedir-5.1.0/package.json000066400000000000000000000014171410301556700162010ustar00rootroot00000000000000{ "name": "xdg-basedir", "version": "5.1.0", "description": "Get XDG Base Directory paths", "license": "MIT", "repository": "sindresorhus/xdg-basedir", "funding": "https://github.com/sponsors/sindresorhus", "author": { "name": "Sindre Sorhus", "email": "sindresorhus@gmail.com", "url": "https://sindresorhus.com" }, "type": "module", "exports": "./index.js", "engines": { "node": ">=12" }, "scripts": { "test": "xo && ava && tsd" }, "files": [ "index.js", "index.d.ts" ], "keywords": [ "xdg", "base", "directory", "basedir", "path", "data", "config", "cache", "linux", "unix", "spec" ], "devDependencies": { "ava": "^1.4.1", "import-fresh": "^3.0.0", "tsd": "^0.7.2", "xo": "^0.24.0" }, "ava": { "serial": true } } xdg-basedir-5.1.0/readme.md000066400000000000000000000042021410301556700154650ustar00rootroot00000000000000# xdg-basedir > Get [XDG Base Directory](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html) paths This package is meant for Linux. You should not use XDG on macOS or Windows. Instead, you should follow their platform conventions. You can use [`env-paths`](https://github.com/sindresorhus/env-paths) for that. ## Install ``` $ npm install xdg-basedir ``` ## Usage ```js import {xdgData, xdgConfig, xdgDataDirectories} from 'xdg-basedir'; console.log(xdgData); //=> '/home/sindresorhus/.local/share' console.log(xdgConfig); //=> '/home/sindresorhus/.config' console.log(xdgDataDirectories); //=> ['/home/sindresorhus/.local/share', '/usr/local/share/', '/usr/share/'] ``` ## API The exports `xdgData`, `xdgConfig`, `xdgCache`, `xdgRuntime` will return `undefined` in the uncommon case that both the XDG environment variable is not set and the users home directory can't be found. You need to handle this case. A common solution is to [fall back to a temporary directory](https://github.com/yeoman/configstore/blob/b82690fc401318ad18dcd7d151a0003a4898a314/index.js#L15). ### xdgData Directory for user-specific data files. ### xdgConfig Directory for user-specific configuration files. ### xdgState Directory for user-specific state files. ### xdgCache Directory for user-specific non-essential data files. ### xdgRuntime Directory for user-specific non-essential runtime files and other file objects (such as sockets, named pipes, etc). ### xdgDataDirectories Preference-ordered array of base directories to search for data files in addition to `xdgData`. ### xdgConfigDirectories Preference-ordered array of base directories to search for configuration files in addition to `xdgConfig`. ---
Get professional support for this package with a Tidelift subscription
Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.
xdg-basedir-5.1.0/test.js000066400000000000000000000027221410301556700152300ustar00rootroot00000000000000import test from 'ava'; /// import importFresh from 'import-fresh'; // TODO: Enable tests again when `import-fresh` supports ESM. test('x', t => { t.pass(); }); /// test('xdgData', t => { // process.env.XDG_DATA_HOME = 'data'; // const {xdgData} = importFresh('.'); // t.is(xdgData, 'data'); // }); // // test('xdgConfig', t => { // process.env.XDG_CONFIG_HOME = 'config'; // const {xdgConfig} = importFresh('.'); // t.is(xdgConfig, 'config'); // }); // // test('xdgState', t => { // process.env.XDG_CONFIG_HOME = 'state'; // const {xdgState} = importFresh('.'); // t.is(xdgState, 'state'); // }); // // test('xdgCache', t => { // process.env.XDG_CACHE_HOME = 'cache'; // const {xdgCache} = importFresh('.'); // t.is(xdgCache, 'cache'); // }); // // test('xdgRuntime', t => { // process.env.XDG_RUNTIME_DIR = 'runtime'; // const {xdgRuntime} = importFresh('.'); // t.is(xdgRuntime, 'runtime'); // }); // // test('xdgDataDirectories', t => { // process.env.XDG_DATA_DIRS = 'dirs:data_dirs'; // const {xdgDataDirectories} = importFresh('.'); // t.is(xdgDataDirectories[0], 'data'); // t.is(xdgDataDirectories[1], 'dirs'); // t.is(xdgDataDirectories[2], 'data_dirs'); // }); // // test('xdgConfigDirectories', t => { // process.env.XDG_CONFIG_DIRS = 'dirs:config_dirs'; // const {xdgConfigDirectories} = importFresh('.'); // t.is(xdgConfigDirectories[0], 'config'); // t.is(xdgConfigDirectories[1], 'dirs'); // t.is(xdgConfigDirectories[2], 'config_dirs'); // });