schema stringclasses 471
values | key stringlengths 0 203 | description stringlengths 0 4.37k | object stringlengths 2 322k |
|---|---|---|---|
config-file.v1.json | proseWrap | Define how prose should be wrapped in Markdown files. | {"default": "always", "enum": ["always", "never", "preserve"]} |
config-file.v1.json | semiColons | Whether to prefer using semicolons. | {"type": "boolean", "default": true} |
config-file.v1.json | nodeModulesDir | Enables or disables the use of a local node_modules folder for npm packages. Alternatively, use the `--node-modules-dir` flag or override the config via `--node-modules-dir=false`. Requires Deno 1.34 or later. | {"type": "boolean"} |
config-file.v1.json | vendor | UNSTABLE: Enables or disables the use of a local vendor folder as a local cache for remote modules and node_modules folder for npm packages. Alternatively, use the `--vendor` flag or override the config via `--vendor=false`. Requires Deno 1.36.1 or later. | {"type": "boolean"} |
config-file.v1.json | tasks | Configuration for deno task | {"type": "object", "patternProperties": {"^[A-Za-z][A-Za-z0-9_\\-:]*$": {"type": "string"}}, "additionalProperties": false} |
config-file.v1.json | ^[A-Za-z][A-Za-z0-9_\-:]*$ | Command to execute for this task name. | {"type": "string"} |
config-file.v1.json | test | Configuration for deno test | {"type": "object", "properties": {"include": {"type": "array", "items": {"type": "string"}}, "exclude": {"type": "array", "items": {"type": "string"}}, "files": {"type": "object", "properties": {"include": {"type": "array", "items": {"type": "string"}}, "exclude": {"type": "array", "items": {"type": "string"}}}}}} |
config-file.v1.json | include | List of files, directories or globs that will be searched for tests. | {"type": "array", "items": {"type": "string"}} |
config-file.v1.json | exclude | List of files, directories or globs that will not be searched for tests. | {"type": "array", "items": {"type": "string"}} |
config-file.v1.json | include | List of files, directories or globs that will be searched for tests. | {"type": "array", "items": {"type": "string"}} |
config-file.v1.json | exclude | List of files, directories or globs that will not be searched for tests. | {"type": "array", "items": {"type": "string"}} |
config-file.v1.json | bench | Configuration for deno bench | {"type": "object", "properties": {"include": {"type": "array", "items": {"type": "string"}}, "exclude": {"type": "array", "items": {"type": "string"}}, "files": {"type": "object", "properties": {"include": {"type": "array", "items": {"type": "string"}}, "exclude": {"type": "array", "items": {"type": "string"}}}}}} |
config-file.v1.json | include | List of files, directories or globs that will be searched for benchmarks. | {"type": "array", "items": {"type": "string"}} |
config-file.v1.json | exclude | List of files, directories or globs that will not be searched for benchmarks. | {"type": "array", "items": {"type": "string"}} |
config-file.v1.json | include | List of files, directories or globs that will be searched for benchmarks. | {"type": "array", "items": {"type": "string"}} |
config-file.v1.json | exclude | List of files, directories or globs that will not be searched for benchmarks. | {"type": "array", "items": {"type": "string"}} |
config-file.v1.json | lock | Whether to use a lock file or the path to use for the lock file. Can be overridden by CLI arguments. | {"type": ["string", "boolean"], "default": true} |
vsix-manifestinjection.json | contentType | Content type of the file with this extension. | {"type": "string"} |
vsix-manifestinjection.json | defaultProgramRegistrationPath | The registry path to where this file association should be registered with default program. | {"type": "string"} |
vsix-manifestinjection.json | extension | The file extension. | {"type": "string", "minLength": 1} |
vsix-manifestinjection.json | isIconOnly | Indicates whether this file association is used for display icons only. | {"type": "boolean"} |
vsix-manifestinjection.json | perceivedType | Perceived type of the file with this extension. | {"type": "string"} |
vsix-manifestinjection.json | progId | The matching /progId/id that's associated with this file extension. | {"type": "string", "minLength": 1} |
vsix-manifestinjection.json | defaultProgramRegistrationPath | The registry path to where this url association should be registered with default program. | {"type": "string"} |
vsix-manifestinjection.json | displayName | The name of the association. | {"type": "string", "minLength": 1} |
vsix-manifestinjection.json | locId | Id for localization purpose only. | {"type": "string"} |
vsix-manifestinjection.json | progId | The matching /progId/id that's associated with this protocol. | {"type": "string", "minLength": 1} |
vsix-manifestinjection.json | protocol | The URL protocol to associate. | {"type": "string", "minLength": 1} |
vsix-manifestinjection.json | allowSilentDefaultTakeOver | Indicates whether silent default takeover is allowed. | {"type": "boolean"} |
vsix-manifestinjection.json | alwaysShowExtension | Indicates if extensions should always be shown in Windows Explorer. | {"type": "boolean"} |
vsix-manifestinjection.json | appUserModelId | App user model ID for taskbar and jump list grouping. | {"type": "string"} |
vsix-manifestinjection.json | arguments | Arguments to pass to the executable. | {"type": "string", "default": ""} |
vsix-manifestinjection.json | clsid | CLSID for the progId | {"type": "string"} |
vsix-manifestinjection.json | dde | Indicates whether application needs to support DDE. | {"type": "boolean"} |
vsix-manifestinjection.json | ddeApplication | DDE application name. | {"type": "string"} |
vsix-manifestinjection.json | ddeTopic | DDE topic name. | {"type": "string"} |
vsix-manifestinjection.json | defaultIconPath | Default icon resource DLL path. | {"type": "string"} |
vsix-manifestinjection.json | defaultIconPosition | Default icon position. | {"type": "integer"} |
vsix-manifestinjection.json | displayName | The name of progId. | {"type": "string", "minLength": 1} |
vsix-manifestinjection.json | iconHandler | Icon handler GUID. | {"type": "string"} |
vsix-manifestinjection.json | id | The unique identifier. | {"type": "string", "minLength": 1} |
vsix-manifestinjection.json | locId | Id for localization purpose only. | {"type": "string"} |
vsix-manifestinjection.json | path | The path to the executable. | {"type": "string"} |
vsix-manifestinjection.json | fileAssociations | A list of file associations (protocol handlers). | {"type": "array", "items": {}} |
vsix-manifestinjection.json | urlAssociations | A list of URL associations (protocol handlers). | {"type": "array", "items": {}} |
vsix-manifestinjection.json | progIds | A list of URL associations (protocol handlers). | {"type": "array", "items": {}} |
jdt.json | @jdt.path | Use JSONPath syntax to navigate to the node where the transform should be applied. | {"type": "string"} |
jdt.json | @jdt.value | The transformation value that should be applied. | {"type": "string"} |
jdt.json | @jdt.rename | Renames nodes | {"type": "object", "properties": {"@jdt.path": {}, "@jdt.value": {}}} |
jdt.json | @jdt.rename | Renames nodes | {"type": "array", "items": {"properties": {"@jdt.path": {}, "@jdt.value": {}}}} |
jdt.json | @jdt.replace | Replaces the current node with the given value. | {"type": ["array", "object"], "properties": {"@jdt.path": {}, "@jdt.value": {}}, "items": {"properties": {"@jdt.path": {}, "@jdt.value": {}}}} |
jdt.json | @jdt.remove | Removes the node with the given name from the current level. | {"type": ["array", "boolean", "object", "string"], "properties": {"@jdt.path": {}}, "items": {"type": ["boolean", "integer", "null", "number", "object", "string"]}} |
jdt.json | @jdt.merge | Merges the current node value with the given object. | {"type": ["object", "array"], "properties": {"@jdt.path": {}, "@jdt.value": {}}, "items": {"properties": {"@jdt.path": {}, "@jdt.value": {}}}} |
yarnrc.json | Yarnrc files (named this way because they must be called `.yarnrc.yml`) are the one place where you'll be able to configure Yarn's internal settings. While Yarn will automatically find them in the parent directories, they should usually be kept at the root of your project (often your repository). **Starting from the v2, they must be written in valid Yaml and have the right extension** (simply calling your file `.yarnrc` won't do).
Environment variables can be accessed from setting definitions by using the `${NAME}` syntax when defining the values. By default Yarn will require the variables to be present, but this can be turned off by using either `${NAME-fallback}` (which will return `fallback` if `NAME` isn't set) or `${NAME:-fallback}` (which will return `fallback` if `NAME` isn't set, or is an empty string).
Finally, note that most settings can also be defined through environment variables (at least for the simpler ones; arrays and objects aren't supported yet). To do this, just prefix the names and write them in snake case: `YARN_CACHE_FOLDER` will set the cache folder (such values will overwrite any that might have been defined in the RC files - use them sparingly). | {"$schema": "https://json-schema.org/draft/2019-09/schema#", "__info": ["This file contains the JSON Schema for Yarnrc files and is:", "1) Hosted on the Yarn Website at http://yarnpkg.com/configuration/yarnrc.json", "2) Registered on the SchemaStore catalog so that editors can offer autocompletion and validation.", "3) Used to generate the documentation page at http://yarnpkg.com/configuration/yarnrc", "Note: Properties prefixed with a single underscore (e.g. _exampleItems, _exampleKeys)", "are unique to our documentation generation interpreter. All others will be picked up", "by most JSON schema interpreters.", "Rules:", "1) Don't set a default if it's null, dynamic, or an object.", "2) Use `examples` for scalars, `_exampleItems` for arrays, and `_exampleKeys` for objects.", "3) Always add a _package property to each configuration setting."], "type": "object", "properties": {"cacheFolder": {"_package": "@yarnpkg/core", "type": "string", "format": "uri-reference", "default": "./.yarn/cache"}, "cacheMigrationMode": {"_package": "@yarnpkg/core", "type": "string", "enum": ["required-only", "match-spec", "always", "auto"], "default": "auto"}, "httpsCaFilePath": {"_package": "@yarnpkg/core", "type": "string", "format": "uri-reference", "examples": ["./exampleCA.pem"]}, "changesetBaseRefs": {"_package": "@yarnpkg/plugin-git", "type": "array", "items": {"type": "string"}, "default": ["master", "origin/master", "upstream/master", "main", "origin/main", "upstream/main"]}, "changesetIgnorePatterns": {"_package": "@yarnpkg/plugin-git", "type": "array", "items": {"type": "string"}, "default": [], "_exampleItems": ["**/*.test.{js,ts}"]}, "checksumBehavior": {"_package": "@yarnpkg/core", "type": "string", "enum": ["throw", "update", "ignore", "reset"], "default": "throw"}, "cloneConcurrency": {"_package": "@yarnpkg/plugin-git", "type": "number", "default": 2}, "compressionLevel": {"_package": "@yarnpkg/core", "type": ["number", "string"], "enum": ["mixed", 0, 1, 2, 3, 4, 5, 6, 7, 8, 9], "default": "mixed"}, "constraintsPath": {"_package": "@yarnpkg/plugin-constraints", "type": "string", "format": "uri-reference", "default": "./constraints.pro"}, "defaultLanguageName": {"_package": "@yarnpkg/core", "type": "string", "default": "node"}, "defaultProtocol": {"_package": "@yarnpkg/core", "type": "string", "default": "npm:"}, "defaultSemverRangePrefix": {"_package": "@yarnpkg/plugin-essentials", "type": "string", "enum": ["^", "~", ""], "default": "^"}, "deferredVersionFolder": {"_package": "@yarnpkg/plugin-version", "type": "string", "format": "uri-reference", "default": "./.yarn/versions"}, "enableColors": {"_package": "@yarnpkg/core", "type": "boolean", "examples": [true]}, "enableGlobalCache": {"_package": "@yarnpkg/core", "type": "boolean", "default": true}, "enableHyperlinks": {"_package": "@yarnpkg/core", "type": "boolean", "examples": [true]}, "enableImmutableCache": {"_package": "@yarnpkg/core", "type": "boolean", "default": false}, "enableImmutableInstalls": {"_package": "@yarnpkg/plugin-essentials", "type": "boolean", "default": false}, "enableInlineBuilds": {"_package": "@yarnpkg/core", "type": "boolean", "examples": [false]}, "enableInlineHunks": {"_package": "@yarnpkg/plugin-patch", "type": "boolean", "examples": [false]}, "enableMessageNames": {"_package": "@yarnpkg/core", "type": "boolean", "default": true}, "enableMirror": {"_package": "@yarnpkg/core", "type": "boolean", "default": true}, "enableNetwork": {"_package": "@yarnpkg/core", "type": "boolean", "default": true}, "enableProgressBars": {"_package": "@yarnpkg/core", "type": "boolean", "examples": [true]}, "enableScripts": {"_package": "@yarnpkg/core", "titke": "Define whether to run postinstall scripts or not.", "type": "boolean", "default": true}, "enableStrictSsl": {"_package": "@yarnpkg/core", "type": "boolean", "default": true}, "enableTelemetry": {"_package": "@yarnpkg/core", "type": "boolean", "examples": [true]}, "enableTimers": {"_package": "@yarnpkg/core", "type": "boolean", "default": true}, "enableTransparentWorkspaces": {"_package": "@yarnpkg/core", "type": "boolean", "default": true}, "globalFolder": {"_package": "@yarnpkg/core", "type": "string", "format": "uri-reference", "examples": ["${HOME}/.yarn/berry/global"]}, "httpProxy": {"_package": "@yarnpkg/core", "type": "string", "format": "uri", "examples": ["http://proxy:4040"]}, "httpRetry": {"_package": "@yarnpkg/core", "type": "number", "default": 3}, "httpTimeout": {"_package": "@yarnpkg/core", "type": "number", "default": 60000}, "httpsCertFilePath": {"_package": "@yarnpkg/core", "type": "string", "format": "uri-reference", "examples": ["./exampleCert.pem"]}, "httpsKeyFilePath": {"_package": "@yarnpkg/core", "type": "string", "format": "uri-reference", "examples": ["./exampleKey.pem"]}, "httpsProxy": {"_package": "@yarnpkg/core", "type": "string", "format": "uri", "examples": ["http://proxy:4040"]}, "ignorePath": {"_package": "@yarnpkg/core", "type": "boolean", "default": false}, "immutablePatterns": {"_package": "@yarnpkg/core", "type": "array", "items": {"type": "string"}, "default": [], "_exampleItems": ["**/.pnp.*"]}, "initScope": {"_package": "@yarnpkg/plugin-init", "type": "string", "pattern": "^([^/]+?)$", "default": "yarnpkg"}, "initFields": {"_package": "@yarnpkg/plugin-init", "type": "object", "patternProperties": {"^(.+)$": {"type": ["string", "number", "boolean"], "examples": ["https://yarnpkg.com"]}}, "_exampleKeys": ["homepage"]}, "installStatePath": {"_package": "@yarnpkg/core", "type": "string", "format": "uri-reference", "default": "./.yarn/install-state.gz"}, "logFilters": {"type": "array", "items": {"type": "object", "properties": {"code": {"type": "string", "examples": ["YN0005"]}, "text": {"type": "string", "examples": ["lorem-ipsum@npm:1.2.3 lists build scripts, but its build has been explicitly disabled through configuration"]}, "pattern": {"type": "string", "examples": ["lorem-ipsum@* lists build scripts, but its build has been explicitly disabled through configuration"]}, "level": {"type": "string", "enum": ["info", "warning", "error", "discard"]}}}, "_exampleItems": [{"code": "YN0006", "level": "discard"}, {"text": "lorem-ipsum@npm:1.2.3 lists build scripts, but its build has been explicitly disabled through configuration", "level": "error"}, {"pattern": "lorem-ipsum@* lists build scripts, but its build has been explicitly disabled through configuration", "level": "error"}]}, "networkConcurrency": {"_package": "@yarnpkg/core", "type": "number", "default": 50}, "networkSettings": {"_package": "@yarnpkg/core", "type": "object", "patternProperties": {"^(.+)$": {"type": "object", "properties": {"httpsCaFilePath": {}, "enableNetwork": {}, "httpProxy": {}, "httpsCertFilePath": {}, "httpsKeyFilePath": {}, "httpsProxy": {}}}}, "_exampleKeys": ["*.example.com"]}, "nmHoistingLimits": {"_package": "@yarnpkg/plugin-nm", "type": "string", "enum": ["workspaces", "dependencies", "none"], "default": "none"}, "nmSelfReferences": {"_package": "@yarnpkg/plugin-nm", "type": "boolean", "default": true}, "nmMode": {"_package": "@yarnpkg/plugin-nm", "type": "string", "enum": ["classic", "hardlinks-local", "hardlinks-global"], "default": "classic"}, "nodeLinker": {"_package": "@yarnpkg/plugin-pnp", "anyOf": [{"type": "string"}, {"enum": ["pnp", "pnpm", "node-modules"]}], "type": "string", "default": "pnp"}, "winLinkType": {"_package": "@yarnpkg/core", "type": "string", "enum": ["junctions", "symlinks"]}, "npmAlwaysAuth": {"_package": "@yarnpkg/plugin-npm", "type": "boolean", "default": false}, "npmAuditRegistry": {"_package": "@yarnpkg/plugin-npm", "type": "string", "format": "uri", "examples": ["https://registry.npmjs.org"]}, "npmAuthIdent": {"_package": "@yarnpkg/plugin-npm", "type": "string", "examples": ["username:password"]}, "npmAuthToken": {"_package": "@yarnpkg/plugin-npm", "type": "string", "examples": ["ffffffff-ffff-ffff-ffff-ffffffffffff"]}, "npmPublishAccess": {"_package": "@yarnpkg/plugin-npm-cli", "type": "string", "enum": ["public", "restricted"]}, "npmAuditExcludePackages": {"_package": "@yarnpkg/plugin-npm-cli", "type": "array", "items": {"type": "string"}, "default": [], "examples": ["known_insecure_package"]}, "npmAuditIgnoreAdvisories": {"_package": "@yarnpkg/plugin-npm-cli", "type": "array", "items": {"type": "string"}, "default": [], "examples": ["1234567"]}, "npmPublishRegistry": {"_package": "@yarnpkg/plugin-npm", "type": "string", "format": "uri", "examples": ["https://npm.pkg.github.com"]}, "npmRegistries": {"_package": "@yarnpkg/plugin-npm", "type": "object", "patternProperties": {"^(?:^[a-zA-Z][a-zA-Z0-9+-.]*:)?[^\\s]*$": {"type": "object", "properties": {"npmAlwaysAuth": {}, "npmAuthIdent": {}, "npmAuthToken": {}}}}, "additionalProperties": false, "_exampleKeys": ["//npm.pkg.github.com"]}, "npmRegistryServer": {"_package": "@yarnpkg/plugin-npm", "type": "string", "format": "uri", "default": "https://registry.yarnpkg.com"}, "npmScopes": {"_package": "@yarnpkg/plugin-npm", "type": "object", "patternProperties": {"^\\S+$": {"type": "object", "properties": {"npmPublishRegistry": {"examples": ["https://registry.yarnpkg.com"]}, "npmRegistryServer": {}, "npmAlwaysAuth": {}, "npmAuthIdent": {}, "npmAuthToken": {}}}}, "additionalProperties": false, "_exampleKeys": ["my-company"]}, "packageExtensions": {"_package": "@yarnpkg/core", "type": "object", "patternProperties": {"^(?:@([^/]+?)/)?([^/]+?)(?:@(.+))$": {"type": "object", "properties": {"dependencies": {"type": "object", "patternProperties": {"^(?:@([^/]+?)/)?([^/]+?)$": {"type": "string", "pattern": "^(.+)$", "examples": ["^4.15.0"]}}, "additionalProperties": false, "_exampleKeys": ["lodash"]}, "peerDependencies": {"type": "object", "patternProperties": {"^(?:@([^/]+?)/)?([^/]+?)$": {"type": "string", "pattern": "^(.+)$", "examples": ["*"]}}, "additionalProperties": false, "_exampleKeys": ["webpack-cli"]}, "peerDependenciesMeta": {"type": "object", "patternProperties": {"^(?:@([^/]+?)/)?([^/]+?)$": {"type": "object", "properties": {"optional": {"type": "boolean", "examples": [true]}}}}, "additionalProperties": false, "_exampleKeys": ["webpack-cli"]}}, "_margin": false}}, "additionalProperties": false, "_exampleKeys": ["webpack@*"]}, "patchFolder": {"_package": "@yarnpkg/plugin-patch", "type": "string", "format": "uri-reference", "default": "./.yarn/patches"}, "pnpEnableEsmLoader": {"_package": "@yarnpkg/plugin-pnp", "type": "boolean", "default": false}, "pnpEnableInlining": {"_package": "@yarnpkg/plugin-pnp", "type": "boolean", "default": true}, "pnpFallbackMode": {"_package": "@yarnpkg/plugin-pnp", "type": "string", "enum": ["none", "dependencies-only", "all"], "default": "dependencies-only"}, "pnpIgnorePatterns": {"_package": "@yarnpkg/plugin-pnp", "type": "array", "items": {"type": "string"}, "default": [], "_exampleItems": ["./subdir/*"]}, "pnpMode": {"_package": "@yarnpkg/plugin-pnp", "enum": ["strict", "loose"], "type": "string", "default": "strict"}, "pnpShebang": {"_package": "@yarnpkg/plugin-pnp", "type": "string", "pattern": "^(#!.*\n?)+", "default": "#!/usr/bin/env node"}, "pnpUnpluggedFolder": {"_package": "@yarnpkg/plugin-pnp", "type": "string", "format": "uri-reference", "default": "./.yarn/unplugged"}, "preferDeferredVersions": {"_package": "@yarnpkg/plugin-version", "type": "boolean", "default": false}, "preferInteractive": {"_package": "@yarnpkg/core", "type": "boolean", "default": false}, "preferReuse": {"_package": "@yarnpkg/plugin-essentials", "type": "boolean", "default": false}, "preferTruncatedLines": {"_package": "@yarnpkg/core", "type": "boolean", "default": false}, "progressBarStyle": {"_package": "@yarnpkg/core", "type": "string", "enum": ["patrick", "simba", "jack", "hogsfather", "default"], "examples": ["default"]}, "supportedArchitectures": {"_package": "@yarnpkg/core", "type": "object", "properties": {"os": {"type": "array", "items": {"type": "string"}, "default": [], "_exampleItems": ["current", "darwin", "linux", "win32"]}, "cpu": {"type": "array", "items": {"type": "string"}, "default": [], "_exampleItems": ["current", "x64", "ia32"]}, "libc": {"type": "array", "items": {"type": "string"}, "default": [], "_exampleItems": ["current", "glibc", "musl"]}}}, "telemetryInterval": {"_package": "@yarnpkg/core", "type": "number", "default": 7}, "telemetryUserId": {"_package": "@yarnpkg/core", "type": "string", "examples": ["yarnpkg/berry"]}, "tsEnableAutoTypes": {"_package": "@yarnpkg/plugin-typescript", "type": "boolean", "examples": [true]}, "unsafeHttpWhitelist": {"_package": "@yarnpkg/core", "type": "array", "items": {"type": "string", "pattern": "[-a-zA-Z0-9@:%._\\+~#=]{1,256}\\.[a-zA-Z0-9()]{1,6}\\b([-a-zA-Z0-9()@:%_\\+.~#?&//=]*)"}, "default": [], "_exampleItems": ["*.example.org", "example.org"]}, "virtualFolder": {"_package": "@yarnpkg/core", "type": "string", "format": "uri-reference", "pattern": "^.*__virtual__$", "default": "./.yarn/__virtual__"}, "yarnPath": {"_package": "@yarnpkg/core", "type": "string", "format": "uri-reference", "examples": ["./scripts/yarn-2.0.0-rc001.js"]}}} | |
yarnrc.json | cacheFolder | They'll be normalized, compressed, and saved under the form of zip archives with standardized names. The cache is deemed to be relatively safe to be shared by multiple projects, even when multiple Yarn instances run at the same time on different projects. For setting a global cache folder, you should use `enableGlobalCache` instead. | {"_package": "@yarnpkg/core", "type": "string", "format": "uri-reference", "default": "./.yarn/cache"} |
yarnrc.json | cacheMigrationMode | Whether or not a cache entry is outdated depends on whether it has been built and checksumed by an earlier release of Yarn, or under a different compression settings. Possible behaviors are:
- If `required-only`, it'll keep using the file as-is, unless the version that generated it was decidedly too old.
- If `match-spec`, it'll also rebuild the file if the compression level has changed. If `always`, it'll always regenerate the cache files so they use the current cache version.
- If `auto` (the default), it'll act as either `required-only` or `always` depending on whether `enableGlobalCache` is enabled (with `always` being selected in that case). | {"_package": "@yarnpkg/core", "type": "string", "enum": ["required-only", "match-spec", "always", "auto"], "default": "auto"} |
yarnrc.json | changesetBaseRefs | Supports git branches, tags, and commits. The default configuration will compare against master, origin/master, upstream/master, main, origin/main, and upstream/main. | {"_package": "@yarnpkg/plugin-git", "type": "array", "items": {"type": "string"}, "default": ["master", "origin/master", "upstream/master", "main", "origin/main", "upstream/main"]} |
yarnrc.json | changesetIgnorePatterns | Files matching the following patterns (in terms of relative paths compared to the root of the project) will be ignored by every command checking whether files changed compared to the base ref (this include both `yarn version check` and `yarn workspaces foreach --since`). | {"_package": "@yarnpkg/plugin-git", "type": "array", "items": {"type": "string"}, "default": [], "_exampleItems": ["**/*.test.{js,ts}"]} |
yarnrc.json | checksumBehavior | Possible behaviors are:
- If `throw` (the default), Yarn will throw an exception.
- If `update`, the lockfile will be updated to match the cached checksum.
- If `reset`, the cache entry will be purged and fetched anew.
- If `ignore`, nothing will happen, Yarn will skip the check. | {"_package": "@yarnpkg/core", "type": "string", "enum": ["throw", "update", "ignore", "reset"], "default": "throw"} |
yarnrc.json | cloneConcurrency | We by default limit it to 2 concurrent clone operations. | {"_package": "@yarnpkg/plugin-git", "type": "number", "default": 2} |
yarnrc.json | compressionLevel | Possible values go from 0 ("no compression, faster") to 9 ("heavy compression, slower"). The default is 'mixed', which is a variant of 9 where files may be stored uncompressed if the builtin libzip heuristic thinks it will lead to a more sensible result. | {"_package": "@yarnpkg/core", "type": ["number", "string"], "enum": ["mixed", 0, 1, 2, 3, 4, 5, 6, 7, 8, 9], "default": "mixed"} |
yarnrc.json | constraintsPath | This only matters for Prolog constraints, which are being deprecated. JavaScript constraints will always be read from the `yarn.config.js` file. | {"_package": "@yarnpkg/plugin-constraints", "type": "string", "format": "uri-reference", "default": "./constraints.pro"} |
yarnrc.json | defaultLanguageName | This is an internal configuration setting that shouldn't be touched unless you really know what you're doing. | {"_package": "@yarnpkg/core", "type": "string", "default": "node"} |
yarnrc.json | defaultProtocol | This is an internal configuration setting that shouldn't be touched unless you really know what you're doing. | {"_package": "@yarnpkg/core", "type": "string", "default": "npm:"} |
yarnrc.json | defaultSemverRangePrefix | Possible values are `"^"` (the default), `"~"` or `""`. | {"_package": "@yarnpkg/plugin-essentials", "type": "string", "enum": ["^", "~", ""], "default": "^"} |
yarnrc.json | enableColors | The default is to check the terminal capabilities, but you can manually override it to either `true` or `false`. | {"_package": "@yarnpkg/core", "type": "boolean", "examples": [true]} |
yarnrc.json | enableGlobalCache | If true (the default), Yarn will store the cache files into a folder located within `globalFolder` instead of respecting `cacheFolder`. | {"_package": "@yarnpkg/core", "type": "boolean", "default": true} |
yarnrc.json | enableHyperlinks | The default is to check the terminal capabilities, but you can manually override it to either `true` or `false`. | {"_package": "@yarnpkg/core", "type": "boolean", "examples": [true]} |
yarnrc.json | enableImmutableCache | If true, Yarn will refuse to change the cache in any way, whether it would add files or remove them, and will abort installs instead of letting that happen. | {"_package": "@yarnpkg/core", "type": "boolean", "default": false} |
yarnrc.json | enableImmutableInstalls | If true (the default on CI), Yarn will refuse to change the lockfile in any way, whether it would add new entries or remove them. Other files can be added to the checklist via the `immutablePatterns` setting. | {"_package": "@yarnpkg/plugin-essentials", "type": "boolean", "default": false} |
yarnrc.json | enableInlineBuilds | If true (the default on CI environments), Yarn will print the build output directly within the terminal instead of buffering it in an external log file. Note that by default Yarn will attempt to use collapsible terminal sequences on supporting CI providers to make the output more legible. | {"_package": "@yarnpkg/core", "type": "boolean", "examples": [false]} |
yarnrc.json | enableInlineHunks | If true, Yarn will print any patch sections (hunks) that could not be applied successfully to the terminal. | {"_package": "@yarnpkg/plugin-patch", "type": "boolean", "examples": [false]} |
yarnrc.json | enableMessageNames | If true, Yarn will prefix most messages with codes suitable for search engines, with hyperlink support if your terminal allows it. | {"_package": "@yarnpkg/core", "type": "boolean", "default": true} |
yarnrc.json | enableMirror | If true (the default), Yarn will use the global folder as indirection between the network and the actual cache. This is only useful if `enableGlobalCache` is explicitly set to `false`, as otherwise the cache entries are persisted to the global cache no matter what. | {"_package": "@yarnpkg/core", "type": "boolean", "default": true} |
yarnrc.json | enableNetwork | If false, Yarn will never make any request to the network by itself, and will throw an exception rather than let it happen. It's a very useful setting for CI, which typically want to make sure they aren't loading their dependencies from the network by mistake. | {"_package": "@yarnpkg/core", "type": "boolean", "default": true} |
yarnrc.json | enableProgressBars | If true (the default outside of CI environments), Yarn will show progress bars for long-running events. | {"_package": "@yarnpkg/core", "type": "boolean", "examples": [true]} |
yarnrc.json | enableScripts | If false, Yarn will not execute the `postinstall` scripts from third-party packages when installing the project (workspaces will still see their postinstall scripts evaluated, as they're assumed to be safe if you're running an install within them).
Note that you also have the ability to disable scripts on a per-package basis using `dependenciesMeta`, or to re-enable a specific script by combining `enableScripts` and `dependenciesMeta`. | {"_package": "@yarnpkg/core", "titke": "Define whether to run postinstall scripts or not.", "type": "boolean", "default": true} |
yarnrc.json | enableStrictSsl | If false, SSL certificate errors will be ignored | {"_package": "@yarnpkg/core", "type": "boolean", "default": true} |
yarnrc.json | enableTelemetry | If true (the default outside of CI environments), Yarn will periodically send anonymous data to our servers tracking some usage information such as the number of dependencies in your project, how many installs you ran, etc.
Consult the [Telemetry](/advanced/telemetry) page for more details about this process. | {"_package": "@yarnpkg/core", "type": "boolean", "examples": [true]} |
yarnrc.json | enableTimers | If false, Yarn will not print the time spent running each sub-step when running various commands. This is only needed for testing purposes, when you want each execution to have exactly the same output as the previous ones. | {"_package": "@yarnpkg/core", "type": "boolean", "default": true} |
yarnrc.json | enableTransparentWorkspaces | If false, Yarn won't link workspaces just because their versions happen to match a semver range. Disabling this setting will require all workspaces to reference one another using the explicit `workspace:` protocol.
This setting is usually only needed when your project needs to use the published version in order to build the new one (that's for example what happens with Babel, which depends on the latest stable release to build the future ones). | {"_package": "@yarnpkg/core", "type": "boolean", "default": true} |
yarnrc.json | globalFolder | Various files we be stored there: global cache, metadata cache, ... | {"_package": "@yarnpkg/core", "type": "string", "format": "uri-reference", "examples": ["${HOME}/.yarn/berry/global"]} |
yarnrc.json | httpProxy | Only HTTP proxies are supported at the moment. | {"_package": "@yarnpkg/core", "type": "string", "format": "uri", "examples": ["http://proxy:4040"]} |
yarnrc.json | httpsProxy | Only HTTP proxies are supported at the moment. | {"_package": "@yarnpkg/core", "type": "string", "format": "uri", "examples": ["http://proxy:4040"]} |
yarnrc.json | ignorePath | If true, whatever Yarn version is being executed will keep running rather than looking at the value of `yarnPath` to decide. | {"_package": "@yarnpkg/core", "type": "boolean", "default": false} |
yarnrc.json | ^(.+)$ | All properties will be added verbatim to the generated package.json. | {"type": ["string", "number", "boolean"], "examples": ["https://yarnpkg.com"]} |
yarnrc.json | installStatePath | The install state file contains a bunch of cached information about your project. It's only used for optimization purposes, and will be recreated if missing (you don't need to add it to Git). | {"_package": "@yarnpkg/core", "type": "string", "format": "uri-reference", "default": "./.yarn/install-state.gz"} |
yarnrc.json | logFilters | This can be used to hide specific messages, or instead make them more prominent. Rules defined there accept filtering messages by either name or raw content. | {"type": "array", "items": {"type": "object", "properties": {"code": {"type": "string", "examples": ["YN0005"]}, "text": {"type": "string", "examples": ["lorem-ipsum@npm:1.2.3 lists build scripts, but its build has been explicitly disabled through configuration"]}, "pattern": {"type": "string", "examples": ["lorem-ipsum@* lists build scripts, but its build has been explicitly disabled through configuration"]}, "level": {"type": "string", "enum": ["info", "warning", "error", "discard"]}}}, "_exampleItems": [{"code": "YN0006", "level": "discard"}, {"text": "lorem-ipsum@npm:1.2.3 lists build scripts, but its build has been explicitly disabled through configuration", "level": "error"}, {"pattern": "lorem-ipsum@* lists build scripts, but its build has been explicitly disabled through configuration", "level": "error"}]} |
yarnrc.json | text | In case a message matches both `code`-based and `text`-based filters, the `text`-based ones will take precedence over the `code`-based ones. | {"type": "string", "examples": ["lorem-ipsum@npm:1.2.3 lists build scripts, but its build has been explicitly disabled through configuration"]} |
yarnrc.json | pattern | In case a message matches both `pattern`-based and `code`-based filters, the `pattern`-based ones will take precedence over the other ones. Patterns can be overridden on a case-by-case basis by using the `text` filter, which has precedence over `pattern`. | {"type": "string", "examples": ["lorem-ipsum@* lists build scripts, but its build has been explicitly disabled through configuration"]} |
yarnrc.json | networkConcurrency | We default to 50 concurrent requests, but it may be required to limit it even more when working behind proxies that can't handle large amounts of traffic. | {"_package": "@yarnpkg/core", "type": "number", "default": 50} |
yarnrc.json | nmHoistingLimits | Replacement of the former `nohoist` setting. Possible values are:
- If `none` (the default), packages are hoisted as per the usual rules.
- If `workspaces`, packages won't be hoisted past the workspace that depends on them.
- If `dependencies`, transitive dependencies also won't be hoisted past your direct dependencies.
This setting can be overridden on a per-workspace basis using the `installConfig.hoistingLimits` field. | {"_package": "@yarnpkg/plugin-nm", "type": "string", "enum": ["workspaces", "dependencies", "none"], "default": "none"} |
yarnrc.json | nmSelfReferences | If false, Yarn won't create self-referencing symlinks when using `nodeLinker: node-modules`. This setting can be overridden on a per-workspace basis using the `installConfig.selfReferences` field. | {"_package": "@yarnpkg/plugin-nm", "type": "boolean", "default": true} |
yarnrc.json | nmMode | Possible values are:
- If `classic`, regular copy or clone operations are performed.
- If `hardlinks-global`, hardlinks to a global content-addressable store will be used.
- If `hardlinks-local`, hardlinks will only be created between similar packages from the same project.
For compatibility with the ecosystem, the default is `classic`. | {"_package": "@yarnpkg/plugin-nm", "type": "string", "enum": ["classic", "hardlinks-local", "hardlinks-global"], "default": "classic"} |
yarnrc.json | nodeLinker | Yarn supports three ways to install your project's dependencies, based on the `nodeLinker` setting. Possible values are:
- If `pnp`, a single Node.js loader file will be generated.
- If `pnpm`, a `node-modules` will be created using symlinks and hardlinks to a global content-addressable store.
- If `node-modules`, a regular `node_modules` folder just like in Yarn Classic or npm will be created. | {"_package": "@yarnpkg/plugin-pnp", "anyOf": [{"type": "string"}, {"enum": ["pnp", "pnpm", "node-modules"]}], "type": "string", "default": "pnp"} |
yarnrc.json | winLinkType | Possible values are:
- If `junctions`, Yarn will use Windows junctions when linking workspaces into `node_modules` directories, which are always absolute paths.
- If `symlinks`, Yarn will use symlinks, which will use relative paths, and is consistent with Yarn's behavior on non-Windows platforms.
Symlinks are preferred, but they require the Windows user running Yarn to have the `create symbolic links` privilege. As a result, we default to using junctions instead. | {"_package": "@yarnpkg/core", "type": "string", "enum": ["junctions", "symlinks"]} |
yarnrc.json | npmAlwaysAuth | If true, authentication credentials will always be sent when sending requests to the registries. This shouldn't be needed unless you configured the registry to reference a private npm mirror. | {"_package": "@yarnpkg/plugin-npm", "type": "boolean", "default": false} |
yarnrc.json | npmAuditRegistry | If not explicitly set, the value of `npmRegistryServer` will be used. | {"_package": "@yarnpkg/plugin-npm", "type": "string", "format": "uri", "examples": ["https://registry.npmjs.org"]} |
yarnrc.json | npmAuthIdent | Replacement of the former `_auth` setting. Because it requires storing unencrypted values in your configuration, `npmAuthToken` should be preferred when possible. | {"_package": "@yarnpkg/plugin-npm", "type": "string", "examples": ["username:password"]} |
yarnrc.json | npmAuthToken | Replacement of the former `_authToken` settings. If you're using `npmScopes` to define multiple registries, the `npmRegistries` dictionary allows you to override these credentials on a per-registry basis. | {"_package": "@yarnpkg/plugin-npm", "type": "string", "examples": ["ffffffff-ffff-ffff-ffff-ffffffffffff"]} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.