Gathering detailed insights and metrics for xdg-basedir
Gathering detailed insights and metrics for xdg-basedir
Installations
npm install xdg-basedirDeveloper
sindresorhus
Developer Guide
BETA
Module System
ESM
Min. Node Version
>=12
Typescript Support
No
Node Version
12.22.1
NPM Version
7.10.0
Statistics
82 Stars
27 Commits
10 Forks
6 Watching
1 Branches
5 Contributors
Updated on 07 Oct 2024
Bundle Size
1.00 kB
Minified
470.00 B
Minified + Gzipped
Languages
JavaScript (76.99%)
TypeScript (23.01%)
Total Downloads
Cumulative downloads
Total Downloads
2,769,306,160
Last day
-5.2%
2,049,251
Compared to previous day
Last week
3.6%
11,214,100
Compared to previous week
Last month
20.1%
45,514,112
Compared to previous month
Last year
-4.1%
449,631,960
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dev Dependencies
4
Versions
xdg-basedir
Get XDG Base Directory 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 for that.
Install
$ npm install xdg-basedir
Usage
1import {xdgData, xdgConfig, xdgDataDirectories} from 'xdg-basedir'; 2 3console.log(xdgData); 4//=> '/home/sindresorhus/.local/share' 5 6console.log(xdgConfig); 7//=> '/home/sindresorhus/.config' 8 9console.log(xdgDataDirectories); 10//=> ['/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.
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.
Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.
No vulnerabilities found.
Reason
security policy file detected
Details
- Info: security policy file detected: .github/security.md:1
- Info: Found linked content: .github/security.md:1
- Info: Found disclosure, vulnerability, and/or timelines in security policy: .github/security.md:1
- Info: Found text in security policy: .github/security.md:1
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: license:0
- Info: FSF or OSI recognized license: MIT License: license:0
Reason
0 existing vulnerabilities detected
Reason
Found 4/27 approved changesets -- score normalized to 1
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/sindresorhus/xdg-basedir/main.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/sindresorhus/xdg-basedir/main.yml/main?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/main.yml:21
- Info: 0 out of 2 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 1 npmCommand dependencies pinned
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/main.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'main'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 4 are checked with a SAST tool
Score
4.2
/10
Last Scanned on 2024-11-18
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More