yarnpkg/yarn

XDG compliance

Open

#2,334 opened on Dec 23, 2016

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

Repository metrics

Stars
 (41,514 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Implement XDG Base Directory support by overriding Yarn's default directory paths to use XDG environment variables with fallback to default paths. Modify configuration loading and cache/data directory creation accordingly.
Tech stack
javascript
Domain
clideveloper experience
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.
1-3 hours
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
Node.jsYarn
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60