otty / dotfiles

All tools/Yarn

Yarn

yarn

A package manager that doubles down as project manager.

Detected by yarn, yarnpkg | macOS, Linux, Windows |yarnpkg.com

Sync it yarn.toml

Sync rules

What travels, what stays, what never leaves

Yarn in your home directory Every rule on this page, by file

…

enableGlobalCache: true

npmRegistryServer: "https://registry.yarnpkg.com"

cacheFolder: /Users/octocat/Library/Caches/Yarnmachine-local

globalFolder: /Users/octocat/.yarn/berrymachine-local

npmAuthToken: npm_FAKE00000000000000000000000000000000

npmAuthIdent: octocat:FAKEpassword0000

…

Each machine keeps its own copy of these.

npmAuthTokennpmAuthIdentnpmRegistries.*.npmAuthTokennpmRegistries.*.npmAuthIdentnpmScopes.*.npmAuthTokennpmScopes.*.npmAuthIdent

Lifted into your secret store; the rest of the file syncs.

registry "https://registry.yarnpkg.com"

yarn-path "/Users/octocat/.yarn/releases/yarn-1.22.22.cjs"machine-local

disable-self-update-check true

--cache-folder "/Users/octocat/Library/Caches/Yarn"machine-local

--install.check-files true

Each machine keeps its own copy of these.

· ~/.yarn/berry/ Exclude

Only what the catalog names. A directory that syncs brings everything inside it except what is listed as excluded here.

apps/yarn.tomlThe file this page is generated from

id = "yarn"

name = "Yarn"

homepage = "https://yarnpkg.com"

description = "A package manager that doubles down as project manager."

icon = "SimpleIcons:yarn"

# Yarn 1 installs a `yarnpkg` alias alongside `yarn`, because Debian's cmdtest

# already owned the shorter name.

detect = ["yarn", "yarnpkg"]

# Yarn 2+ (Berry): Configuration.find() reads the rc file of the home folder,

# `ppath.join(folderUtils.getHomeFolder(), Filename.rc)` with

# DEFAULT_RC_FILENAME = `.yarnrc.yml`

# (packages/yarnpkg-core/sources/Configuration.ts).

# Yarn 1: YarnRegistry's constructor sets

# `this.homeConfigLoc = path.join(userHome, '.yarnrc')`

# (src/registries/yarn-registry.js), which is what `yarn config set` writes.

# Both are listed: a consumer skips whichever the machine does not have.

# ~/.npmrc is npm's file and belongs to the npm entry, even though Yarn 1

# reads registry auth out of it.

paths = [

"~/.yarnrc.yml",

"~/.yarnrc",

]

# https://yarnpkg.com/configuration/yarnrc — globalFolder defaults to

# ${HOME}/.yarn/berry and holds the global cache and install state.

exclude = ["~/.yarn/berry/"]

# Neither rc file is a whole-file credential: registries, linker choice and

# plugin lists are worth syncing. Only the auth fields are lifted out.

secret = []

# Read at startup by a process that then exits.

side_effect = false

# cacheFolder and globalFolder name directories on this machine's disk

# (https://yarnpkg.com/configuration/yarnrc). Everything else in a home

# .yarnrc.yml — nodeLinker, npmRegistryServer, plugins — is a preference.

# Yarn picks the defaults itself, so a line here is the user having moved them:

# kept for rebuilding this machine, applied to no other.

[[machine_lines]]

file = "~/.yarnrc.yml"

match = { key_path = ["cacheFolder", "globalFolder"] }

scope = "backup"

# https://classic.yarnpkg.com/lang/en/docs/yarnrc/ — `yarn-path` points at a

# Yarn release on this disk, and CLI flag defaults are written as `--flag`

# lines, of which `--cache-folder` is an absolute local path.

# Both are locations on this disk the user wrote out, so they are kept for

# rebuilding this machine and applied to no other.

[[machine_lines]]

file = "~/.yarnrc"

match = { prefix = ["yarn-path", "--cache-folder"] }

scope = "backup"

# https://yarnpkg.com/configuration/yarnrc — npmAuthToken and npmAuthIdent are

# the top-level defaults, and npmRegistries / npmScopes each take their own

# copy of both. All six shapes are listed: a token under any of them is a

# registry credential.

[[secret_paths]]

file = "~/.yarnrc.yml"

match = { key_path = [

"npmAuthToken",

"npmAuthIdent",

"npmRegistries.*.npmAuthToken",

"npmRegistries.*.npmAuthIdent",

"npmScopes.*.npmAuthToken",

"npmScopes.*.npmAuthIdent",

] }

Use it with your dotfile manager

Same data, in the shape your tool already reads

Opens Otty and adds this tool to what it syncs

Opens otty://sync/add/yarn. Otty ships with this catalog, so the link only has to name the tool — nothing is downloaded.

Every one of these is generated from the same rules as this page. None of them splits cacheFolder and globalFolder for you — that part is Otty’s own sync, or a template you write by hand.