yarnpkg/yarn

XDG compliance

Open

#2,334 opened on Dec 23, 2016

View on GitHub
 (23 comments) (173 reactions) (0 assignees)JavaScript (41,514 stars) (2,731 forks)batch import
good first issuehelp wanted

Description

Hi :)

I noted that Yarn doesn't fit the XDG basedir specification. It could be nice to support it.

What is the current behavior?

Currently Yarn creates its own data / cache / config directories:

  • $HOME/.yarn
  • $HOME/.yarn-cache
  • $HOME/.yarn-config

What is the expected behavior?

Next the desired replacement (or fallback) of each directory.

  • $HOME/.yarn: ${XDG_DATA_HOME:-$HOME/.local/share}/yarn
  • $HOME/.yarn-cache: ${XDG_CACHE_HOME:-$HOME/.cache}/yarn
  • $HOME/.yarn-config: ${XDG_CONFIG_HOME:-$HOME/.config}/yarn

OS: Linux

Contributor guide

Tech stack
javascript
Domain
cli
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic knowledge of Node.jsfamiliarity with environment variablesunderstanding of XDG Base Directory specification
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
The issue requires modifying the default directory paths in Yarn to adhere to the XDG Base Directory Specification. The main files to look at are likely in the 'src' directory where configuration, cache, and data paths are defined. Search for usage of process.env.HOME and constants like YARN DIR, CACHE DIR, etc. The expected behavior is to use environment variables XDG DATA HOME, XDG CACHE HOME, XDG CONFIG HOME with fallbacks to $HOME/.local/share, $HOME/.cache, and $HOME/.config respectively. Review comments on the issue for any suggested implementation approaches or partial work already done.
XDG compliance · yarnpkg/yarn#2334 | Good First Issue