From 7ee317a48a9b8c575457008f0df418e2b580aa64 Mon Sep 17 00:00:00 2001 From: Huon Wilson Date: Thu, 25 Jul 2024 16:03:12 +1000 Subject: [PATCH 1/2] Escape $'s in default value too --- reference_codegen/generate.mjs | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/reference_codegen/generate.mjs b/reference_codegen/generate.mjs index 3aef70d4..36271f32 100644 --- a/reference_codegen/generate.mjs +++ b/reference_codegen/generate.mjs @@ -89,9 +89,14 @@ function convertDefault(val, type) { val = String(val).replace(/\\n/g, "\\\\n"); } - return val - .replace(buildroot, "") - .replace(cachedir, "$XDG_CACHE_HOME"); + return ( + val + .replace(buildroot, "") + .replace(cachedir, "$XDG_CACHE_HOME") + // this ends up in a template literal, so if it contains literally ${something} we need to + // ensure that doesn't get interpreted as a substitution + .replace(/\$/g, "\\$") + ); } function escape(val) { From cb09580ae30392496e16ba15d308810d31e021ba Mon Sep 17 00:00:00 2001 From: Huon Wilson Date: Thu, 25 Jul 2024 16:03:22 +1000 Subject: [PATCH 2/2] Regenerate --- docs/reference/global-options.mdx | 4 ++-- docs/reference/subsystems/jvm.mdx | 2 +- docs/reference/targets/vcs_version.mdx | 2 +- versioned_docs/version-2.0/reference/global-options.mdx | 8 ++++---- .../version-2.0/reference/subsystems/cookies.mdx | 2 +- versioned_docs/version-2.1/reference/global-options.mdx | 8 ++++---- versioned_docs/version-2.10/reference/global-options.mdx | 4 ++-- versioned_docs/version-2.11/reference/global-options.mdx | 4 ++-- versioned_docs/version-2.12/reference/global-options.mdx | 4 ++-- versioned_docs/version-2.13/reference/global-options.mdx | 4 ++-- .../version-2.13/reference/targets/vcs_version.mdx | 2 +- versioned_docs/version-2.14/reference/global-options.mdx | 4 ++-- .../version-2.14/reference/targets/vcs_version.mdx | 2 +- versioned_docs/version-2.15/reference/global-options.mdx | 4 ++-- .../version-2.15/reference/targets/vcs_version.mdx | 2 +- versioned_docs/version-2.16/reference/global-options.mdx | 4 ++-- .../version-2.16/reference/targets/vcs_version.mdx | 2 +- versioned_docs/version-2.17/reference/global-options.mdx | 4 ++-- .../version-2.17/reference/targets/vcs_version.mdx | 2 +- versioned_docs/version-2.18/reference/global-options.mdx | 4 ++-- .../version-2.18/reference/targets/vcs_version.mdx | 2 +- versioned_docs/version-2.19/reference/global-options.mdx | 4 ++-- .../version-2.19/reference/targets/vcs_version.mdx | 2 +- versioned_docs/version-2.2/reference/global-options.mdx | 6 +++--- versioned_docs/version-2.20/reference/global-options.mdx | 4 ++-- .../version-2.20/reference/targets/vcs_version.mdx | 2 +- versioned_docs/version-2.21/reference/global-options.mdx | 4 ++-- .../version-2.21/reference/targets/vcs_version.mdx | 2 +- versioned_docs/version-2.22/reference/global-options.mdx | 4 ++-- versioned_docs/version-2.22/reference/subsystems/jvm.mdx | 2 +- .../version-2.22/reference/targets/vcs_version.mdx | 2 +- versioned_docs/version-2.3/reference/global-options.mdx | 6 +++--- versioned_docs/version-2.4/reference/global-options.mdx | 6 +++--- versioned_docs/version-2.5/reference/global-options.mdx | 4 ++-- versioned_docs/version-2.6/reference/global-options.mdx | 4 ++-- versioned_docs/version-2.7/reference/global-options.mdx | 4 ++-- versioned_docs/version-2.8/reference/global-options.mdx | 4 ++-- versioned_docs/version-2.9/reference/global-options.mdx | 4 ++-- 38 files changed, 69 insertions(+), 69 deletions(-) diff --git a/docs/reference/global-options.mdx b/docs/reference/global-options.mdx index bd0c581d..f988112f 100644 --- a/docs/reference/global-options.mdx +++ b/docs/reference/global-options.mdx @@ -516,7 +516,7 @@ The path may be absolute or relative. If the directory is within the build root, env_repr='PANTS_LOCAL_STORE_DIR' toml_repr={`[GLOBAL] local_store_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/lmdb_store`} + default_repr={`\$XDG_CACHE_HOME/pants/lmdb_store`} > Directory to use for the local file store, which stores the results of subprocesses run by Pants. @@ -654,7 +654,7 @@ The maximum number of times to loop when `--loop` is specified. env_repr='PANTS_NAMED_CACHES_DIR' toml_repr={`[GLOBAL] named_caches_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/named_caches`} + default_repr={`\$XDG_CACHE_HOME/pants/named_caches`} > Directory to use for named global caches for tools and processes with trusted, concurrency-safe caches. diff --git a/docs/reference/subsystems/jvm.mdx b/docs/reference/subsystems/jvm.mdx index 72db1844..98f6776e 100644 --- a/docs/reference/subsystems/jvm.mdx +++ b/docs/reference/subsystems/jvm.mdx @@ -70,7 +70,7 @@ deploy_jar_exclude_files = [ '', ..., ]`} - default_repr={`[\n "^META-INF/[^/]+\\.SF$",\n "^META-INF/[^/]+\\.DSA$",\n "^META-INF/[^/]+\\.RSA$",\n "META-INF/INDEX.LIST$"\n]`} + default_repr={`[\n "^META-INF/[^/]+\\.SF\$",\n "^META-INF/[^/]+\\.DSA\$",\n "^META-INF/[^/]+\\.RSA\$",\n "META-INF/INDEX.LIST\$"\n]`} > A list of patterns to exclude from all deploy jars. An individual deploy_jar target can also exclude other files, in addition to these, by setting its `exclude_files` field. diff --git a/docs/reference/targets/vcs_version.mdx b/docs/reference/targets/vcs_version.mdx index 623849b3..7aaf9722 100644 --- a/docs/reference/targets/vcs_version.mdx +++ b/docs/reference/targets/vcs_version.mdx @@ -91,7 +91,7 @@ All dependencies must share the same value for their `resolve` field. [vV]?\\d+(?:\\.\\d+){0,2}[^\\+]*)(?:\\+.*)?$'`} + default_repr={`'^(?:[\\w-]+-)?(?P[vV]?\\d+(?:\\.\\d+){0,2}[^\\+]*)(?:\\+.*)?\$'`} > A Python regex string to extract the version string from a VCS tag. diff --git a/versioned_docs/version-2.0/reference/global-options.mdx b/versioned_docs/version-2.0/reference/global-options.mdx index 159c948f..2472202a 100644 --- a/versioned_docs/version-2.0/reference/global-options.mdx +++ b/versioned_docs/version-2.0/reference/global-options.mdx @@ -289,7 +289,7 @@ Directory to use for local process execution sandboxing. The path may be absolut env_repr='PANTS_LOCAL_STORE_DIR' toml_repr={`[GLOBAL] local_store_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/lmdb_store`} + default_repr={`\$XDG_CACHE_HOME/pants/lmdb_store`} > Directory to use for the local file store, which stores the results of subprocesses run by Pants. The path may be absolute or relative. If the directory is within the build root, be sure to include it in `--pants-ignore`. @@ -361,7 +361,7 @@ The maximum number of times to loop when `--loop` is specified. env_repr='PANTS_NAMED_CACHES_DIR' toml_repr={`[GLOBAL] named_caches_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/named_caches`} + default_repr={`\$XDG_CACHE_HOME/pants/named_caches`} > Directory to use for named global caches for tools and processes with trusted, concurrency-safe caches. The path may be absolute or relative. If the directory is within the build root, be sure to include it in `--pants-ignore`. @@ -418,7 +418,7 @@ The name of the script or binary used to invoke Pants. Useful when printing help env_repr='PANTS_BOOTSTRAPDIR' toml_repr={`[GLOBAL] pants_bootstrapdir = `} - default_repr={`$XDG_CACHE_HOME/pants`} + default_repr={`\$XDG_CACHE_HOME/pants`} > Unused. Will be deprecated in 2.1.0. @@ -718,7 +718,7 @@ Override config with values from these files, using syntax matching that of `--p env_repr='PANTS_PLUGIN_CACHE_DIR' toml_repr={`[GLOBAL] plugin_cache_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/plugins`} + default_repr={`\$XDG_CACHE_HOME/pants/plugins`} > Cache resolved plugin requirements here. diff --git a/versioned_docs/version-2.0/reference/subsystems/cookies.mdx b/versioned_docs/version-2.0/reference/subsystems/cookies.mdx index 9c44ca9d..c7e5a029 100644 --- a/versioned_docs/version-2.0/reference/subsystems/cookies.mdx +++ b/versioned_docs/version-2.0/reference/subsystems/cookies.mdx @@ -34,7 +34,7 @@ None env_repr='PANTS_COOKIES_PATH' toml_repr={`[cookies] path = `} - default_repr={`$XDG_CACHE_HOME/pants/auth/cookies`} + default_repr={`\$XDG_CACHE_HOME/pants/auth/cookies`} removal_version='2.1.0.dev0' removal_hint={'The option `--cookies-path` does not do anything and the `[cookies]` subsystem will be removed.'} > diff --git a/versioned_docs/version-2.1/reference/global-options.mdx b/versioned_docs/version-2.1/reference/global-options.mdx index 6120812a..6c41b7d0 100644 --- a/versioned_docs/version-2.1/reference/global-options.mdx +++ b/versioned_docs/version-2.1/reference/global-options.mdx @@ -289,7 +289,7 @@ Directory to use for local process execution sandboxing. The path may be absolut env_repr='PANTS_LOCAL_STORE_DIR' toml_repr={`[GLOBAL] local_store_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/lmdb_store`} + default_repr={`\$XDG_CACHE_HOME/pants/lmdb_store`} > Directory to use for the local file store, which stores the results of subprocesses run by Pants. The path may be absolute or relative. If the directory is within the build root, be sure to include it in `--pants-ignore`. @@ -361,7 +361,7 @@ The maximum number of times to loop when `--loop` is specified. env_repr='PANTS_NAMED_CACHES_DIR' toml_repr={`[GLOBAL] named_caches_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/named_caches`} + default_repr={`\$XDG_CACHE_HOME/pants/named_caches`} > Directory to use for named global caches for tools and processes with trusted, concurrency-safe caches. The path may be absolute or relative. If the directory is within the build root, be sure to include it in `--pants-ignore`. @@ -418,7 +418,7 @@ The name of the script or binary used to invoke Pants. Useful when printing help env_repr='PANTS_BOOTSTRAPDIR' toml_repr={`[GLOBAL] pants_bootstrapdir = `} - default_repr={`$XDG_CACHE_HOME/pants`} + default_repr={`\$XDG_CACHE_HOME/pants`} > Unused. Will be deprecated in 2.2.0. @@ -704,7 +704,7 @@ Override config with values from these files, using syntax matching that of `--p env_repr='PANTS_PLUGIN_CACHE_DIR' toml_repr={`[GLOBAL] plugin_cache_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/plugins`} + default_repr={`\$XDG_CACHE_HOME/pants/plugins`} > Cache resolved plugin requirements here. diff --git a/versioned_docs/version-2.10/reference/global-options.mdx b/versioned_docs/version-2.10/reference/global-options.mdx index d7d62260..8e9c86b1 100644 --- a/versioned_docs/version-2.10/reference/global-options.mdx +++ b/versioned_docs/version-2.10/reference/global-options.mdx @@ -429,7 +429,7 @@ The path may be absolute or relative. If the directory is within the build root, env_repr='PANTS_LOCAL_STORE_DIR' toml_repr={`[GLOBAL] local_store_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/lmdb_store`} + default_repr={`\$XDG_CACHE_HOME/pants/lmdb_store`} > Directory to use for the local file store, which stores the results of subprocesses run by Pants. @@ -567,7 +567,7 @@ The maximum number of times to loop when `--loop` is specified. env_repr='PANTS_NAMED_CACHES_DIR' toml_repr={`[GLOBAL] named_caches_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/named_caches`} + default_repr={`\$XDG_CACHE_HOME/pants/named_caches`} > Directory to use for named global caches for tools and processes with trusted, concurrency-safe caches. diff --git a/versioned_docs/version-2.11/reference/global-options.mdx b/versioned_docs/version-2.11/reference/global-options.mdx index a48eeb87..f72e2ec9 100644 --- a/versioned_docs/version-2.11/reference/global-options.mdx +++ b/versioned_docs/version-2.11/reference/global-options.mdx @@ -427,7 +427,7 @@ The path may be absolute or relative. If the directory is within the build root, env_repr='PANTS_LOCAL_STORE_DIR' toml_repr={`[GLOBAL] local_store_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/lmdb_store`} + default_repr={`\$XDG_CACHE_HOME/pants/lmdb_store`} > Directory to use for the local file store, which stores the results of subprocesses run by Pants. @@ -565,7 +565,7 @@ The maximum number of times to loop when `--loop` is specified. env_repr='PANTS_NAMED_CACHES_DIR' toml_repr={`[GLOBAL] named_caches_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/named_caches`} + default_repr={`\$XDG_CACHE_HOME/pants/named_caches`} > Directory to use for named global caches for tools and processes with trusted, concurrency-safe caches. diff --git a/versioned_docs/version-2.12/reference/global-options.mdx b/versioned_docs/version-2.12/reference/global-options.mdx index d7298b4a..019cb8e8 100644 --- a/versioned_docs/version-2.12/reference/global-options.mdx +++ b/versioned_docs/version-2.12/reference/global-options.mdx @@ -427,7 +427,7 @@ The path may be absolute or relative. If the directory is within the build root, env_repr='PANTS_LOCAL_STORE_DIR' toml_repr={`[GLOBAL] local_store_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/lmdb_store`} + default_repr={`\$XDG_CACHE_HOME/pants/lmdb_store`} > Directory to use for the local file store, which stores the results of subprocesses run by Pants. @@ -565,7 +565,7 @@ The maximum number of times to loop when `--loop` is specified. env_repr='PANTS_NAMED_CACHES_DIR' toml_repr={`[GLOBAL] named_caches_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/named_caches`} + default_repr={`\$XDG_CACHE_HOME/pants/named_caches`} > Directory to use for named global caches for tools and processes with trusted, concurrency-safe caches. diff --git a/versioned_docs/version-2.13/reference/global-options.mdx b/versioned_docs/version-2.13/reference/global-options.mdx index d9352f8c..cf1363bc 100644 --- a/versioned_docs/version-2.13/reference/global-options.mdx +++ b/versioned_docs/version-2.13/reference/global-options.mdx @@ -472,7 +472,7 @@ The path may be absolute or relative. If the directory is within the build root, env_repr='PANTS_LOCAL_STORE_DIR' toml_repr={`[GLOBAL] local_store_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/lmdb_store`} + default_repr={`\$XDG_CACHE_HOME/pants/lmdb_store`} > Directory to use for the local file store, which stores the results of subprocesses run by Pants. @@ -610,7 +610,7 @@ The maximum number of times to loop when `--loop` is specified. env_repr='PANTS_NAMED_CACHES_DIR' toml_repr={`[GLOBAL] named_caches_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/named_caches`} + default_repr={`\$XDG_CACHE_HOME/pants/named_caches`} > Directory to use for named global caches for tools and processes with trusted, concurrency-safe caches. diff --git a/versioned_docs/version-2.13/reference/targets/vcs_version.mdx b/versioned_docs/version-2.13/reference/targets/vcs_version.mdx index 2de52151..debaf1c7 100644 --- a/versioned_docs/version-2.13/reference/targets/vcs_version.mdx +++ b/versioned_docs/version-2.13/reference/targets/vcs_version.mdx @@ -80,7 +80,7 @@ All dependencies must share the same value for their `resolve` field. [vV]?\\d+(?:\\.\\d+){0,2}[^\\+]*)(?:\\+.*)?$'`} + default_repr={`'^(?:[\\w-]+-)?(?P[vV]?\\d+(?:\\.\\d+){0,2}[^\\+]*)(?:\\+.*)?\$'`} > A Python regex string to extract the version string from a VCS tag. diff --git a/versioned_docs/version-2.14/reference/global-options.mdx b/versioned_docs/version-2.14/reference/global-options.mdx index bd5ab69a..85cee884 100644 --- a/versioned_docs/version-2.14/reference/global-options.mdx +++ b/versioned_docs/version-2.14/reference/global-options.mdx @@ -434,7 +434,7 @@ The path may be absolute or relative. If the directory is within the build root, env_repr='PANTS_LOCAL_STORE_DIR' toml_repr={`[GLOBAL] local_store_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/lmdb_store`} + default_repr={`\$XDG_CACHE_HOME/pants/lmdb_store`} > Directory to use for the local file store, which stores the results of subprocesses run by Pants. @@ -572,7 +572,7 @@ The maximum number of times to loop when `--loop` is specified. env_repr='PANTS_NAMED_CACHES_DIR' toml_repr={`[GLOBAL] named_caches_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/named_caches`} + default_repr={`\$XDG_CACHE_HOME/pants/named_caches`} > Directory to use for named global caches for tools and processes with trusted, concurrency-safe caches. diff --git a/versioned_docs/version-2.14/reference/targets/vcs_version.mdx b/versioned_docs/version-2.14/reference/targets/vcs_version.mdx index c2b330df..229f7580 100644 --- a/versioned_docs/version-2.14/reference/targets/vcs_version.mdx +++ b/versioned_docs/version-2.14/reference/targets/vcs_version.mdx @@ -80,7 +80,7 @@ All dependencies must share the same value for their `resolve` field. [vV]?\\d+(?:\\.\\d+){0,2}[^\\+]*)(?:\\+.*)?$'`} + default_repr={`'^(?:[\\w-]+-)?(?P[vV]?\\d+(?:\\.\\d+){0,2}[^\\+]*)(?:\\+.*)?\$'`} > A Python regex string to extract the version string from a VCS tag. diff --git a/versioned_docs/version-2.15/reference/global-options.mdx b/versioned_docs/version-2.15/reference/global-options.mdx index 3cc7d469..971e90b6 100644 --- a/versioned_docs/version-2.15/reference/global-options.mdx +++ b/versioned_docs/version-2.15/reference/global-options.mdx @@ -454,7 +454,7 @@ The path may be absolute or relative. If the directory is within the build root, env_repr='PANTS_LOCAL_STORE_DIR' toml_repr={`[GLOBAL] local_store_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/lmdb_store`} + default_repr={`\$XDG_CACHE_HOME/pants/lmdb_store`} > Directory to use for the local file store, which stores the results of subprocesses run by Pants. @@ -592,7 +592,7 @@ The maximum number of times to loop when `--loop` is specified. env_repr='PANTS_NAMED_CACHES_DIR' toml_repr={`[GLOBAL] named_caches_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/named_caches`} + default_repr={`\$XDG_CACHE_HOME/pants/named_caches`} > Directory to use for named global caches for tools and processes with trusted, concurrency-safe caches. diff --git a/versioned_docs/version-2.15/reference/targets/vcs_version.mdx b/versioned_docs/version-2.15/reference/targets/vcs_version.mdx index 300ef072..2424a6ac 100644 --- a/versioned_docs/version-2.15/reference/targets/vcs_version.mdx +++ b/versioned_docs/version-2.15/reference/targets/vcs_version.mdx @@ -80,7 +80,7 @@ All dependencies must share the same value for their `resolve` field. [vV]?\\d+(?:\\.\\d+){0,2}[^\\+]*)(?:\\+.*)?$'`} + default_repr={`'^(?:[\\w-]+-)?(?P[vV]?\\d+(?:\\.\\d+){0,2}[^\\+]*)(?:\\+.*)?\$'`} > A Python regex string to extract the version string from a VCS tag. diff --git a/versioned_docs/version-2.16/reference/global-options.mdx b/versioned_docs/version-2.16/reference/global-options.mdx index 70d39513..88940399 100644 --- a/versioned_docs/version-2.16/reference/global-options.mdx +++ b/versioned_docs/version-2.16/reference/global-options.mdx @@ -454,7 +454,7 @@ The path may be absolute or relative. If the directory is within the build root, env_repr='PANTS_LOCAL_STORE_DIR' toml_repr={`[GLOBAL] local_store_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/lmdb_store`} + default_repr={`\$XDG_CACHE_HOME/pants/lmdb_store`} > Directory to use for the local file store, which stores the results of subprocesses run by Pants. @@ -592,7 +592,7 @@ The maximum number of times to loop when `--loop` is specified. env_repr='PANTS_NAMED_CACHES_DIR' toml_repr={`[GLOBAL] named_caches_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/named_caches`} + default_repr={`\$XDG_CACHE_HOME/pants/named_caches`} > Directory to use for named global caches for tools and processes with trusted, concurrency-safe caches. diff --git a/versioned_docs/version-2.16/reference/targets/vcs_version.mdx b/versioned_docs/version-2.16/reference/targets/vcs_version.mdx index 315ff011..3311a850 100644 --- a/versioned_docs/version-2.16/reference/targets/vcs_version.mdx +++ b/versioned_docs/version-2.16/reference/targets/vcs_version.mdx @@ -80,7 +80,7 @@ All dependencies must share the same value for their `resolve` field. [vV]?\\d+(?:\\.\\d+){0,2}[^\\+]*)(?:\\+.*)?$'`} + default_repr={`'^(?:[\\w-]+-)?(?P[vV]?\\d+(?:\\.\\d+){0,2}[^\\+]*)(?:\\+.*)?\$'`} > A Python regex string to extract the version string from a VCS tag. diff --git a/versioned_docs/version-2.17/reference/global-options.mdx b/versioned_docs/version-2.17/reference/global-options.mdx index f50a2d41..512992ac 100644 --- a/versioned_docs/version-2.17/reference/global-options.mdx +++ b/versioned_docs/version-2.17/reference/global-options.mdx @@ -454,7 +454,7 @@ The path may be absolute or relative. If the directory is within the build root, env_repr='PANTS_LOCAL_STORE_DIR' toml_repr={`[GLOBAL] local_store_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/lmdb_store`} + default_repr={`\$XDG_CACHE_HOME/pants/lmdb_store`} > Directory to use for the local file store, which stores the results of subprocesses run by Pants. @@ -592,7 +592,7 @@ The maximum number of times to loop when `--loop` is specified. env_repr='PANTS_NAMED_CACHES_DIR' toml_repr={`[GLOBAL] named_caches_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/named_caches`} + default_repr={`\$XDG_CACHE_HOME/pants/named_caches`} > Directory to use for named global caches for tools and processes with trusted, concurrency-safe caches. diff --git a/versioned_docs/version-2.17/reference/targets/vcs_version.mdx b/versioned_docs/version-2.17/reference/targets/vcs_version.mdx index 797e0032..9c9f9332 100644 --- a/versioned_docs/version-2.17/reference/targets/vcs_version.mdx +++ b/versioned_docs/version-2.17/reference/targets/vcs_version.mdx @@ -80,7 +80,7 @@ All dependencies must share the same value for their `resolve` field. [vV]?\\d+(?:\\.\\d+){0,2}[^\\+]*)(?:\\+.*)?$'`} + default_repr={`'^(?:[\\w-]+-)?(?P[vV]?\\d+(?:\\.\\d+){0,2}[^\\+]*)(?:\\+.*)?\$'`} > A Python regex string to extract the version string from a VCS tag. diff --git a/versioned_docs/version-2.18/reference/global-options.mdx b/versioned_docs/version-2.18/reference/global-options.mdx index f2031fd7..95b7d502 100644 --- a/versioned_docs/version-2.18/reference/global-options.mdx +++ b/versioned_docs/version-2.18/reference/global-options.mdx @@ -454,7 +454,7 @@ The path may be absolute or relative. If the directory is within the build root, env_repr='PANTS_LOCAL_STORE_DIR' toml_repr={`[GLOBAL] local_store_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/lmdb_store`} + default_repr={`\$XDG_CACHE_HOME/pants/lmdb_store`} > Directory to use for the local file store, which stores the results of subprocesses run by Pants. @@ -592,7 +592,7 @@ The maximum number of times to loop when `--loop` is specified. env_repr='PANTS_NAMED_CACHES_DIR' toml_repr={`[GLOBAL] named_caches_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/named_caches`} + default_repr={`\$XDG_CACHE_HOME/pants/named_caches`} > Directory to use for named global caches for tools and processes with trusted, concurrency-safe caches. diff --git a/versioned_docs/version-2.18/reference/targets/vcs_version.mdx b/versioned_docs/version-2.18/reference/targets/vcs_version.mdx index 1d5a8c6f..e834cbe6 100644 --- a/versioned_docs/version-2.18/reference/targets/vcs_version.mdx +++ b/versioned_docs/version-2.18/reference/targets/vcs_version.mdx @@ -80,7 +80,7 @@ All dependencies must share the same value for their `resolve` field. [vV]?\\d+(?:\\.\\d+){0,2}[^\\+]*)(?:\\+.*)?$'`} + default_repr={`'^(?:[\\w-]+-)?(?P[vV]?\\d+(?:\\.\\d+){0,2}[^\\+]*)(?:\\+.*)?\$'`} > A Python regex string to extract the version string from a VCS tag. diff --git a/versioned_docs/version-2.19/reference/global-options.mdx b/versioned_docs/version-2.19/reference/global-options.mdx index 99978101..7ce6bd39 100644 --- a/versioned_docs/version-2.19/reference/global-options.mdx +++ b/versioned_docs/version-2.19/reference/global-options.mdx @@ -454,7 +454,7 @@ The path may be absolute or relative. If the directory is within the build root, env_repr='PANTS_LOCAL_STORE_DIR' toml_repr={`[GLOBAL] local_store_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/lmdb_store`} + default_repr={`\$XDG_CACHE_HOME/pants/lmdb_store`} > Directory to use for the local file store, which stores the results of subprocesses run by Pants. @@ -592,7 +592,7 @@ The maximum number of times to loop when `--loop` is specified. env_repr='PANTS_NAMED_CACHES_DIR' toml_repr={`[GLOBAL] named_caches_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/named_caches`} + default_repr={`\$XDG_CACHE_HOME/pants/named_caches`} > Directory to use for named global caches for tools and processes with trusted, concurrency-safe caches. diff --git a/versioned_docs/version-2.19/reference/targets/vcs_version.mdx b/versioned_docs/version-2.19/reference/targets/vcs_version.mdx index 7d0d2c81..bc01aa64 100644 --- a/versioned_docs/version-2.19/reference/targets/vcs_version.mdx +++ b/versioned_docs/version-2.19/reference/targets/vcs_version.mdx @@ -80,7 +80,7 @@ All dependencies must share the same value for their `resolve` field. [vV]?\\d+(?:\\.\\d+){0,2}[^\\+]*)(?:\\+.*)?$'`} + default_repr={`'^(?:[\\w-]+-)?(?P[vV]?\\d+(?:\\.\\d+){0,2}[^\\+]*)(?:\\+.*)?\$'`} > A Python regex string to extract the version string from a VCS tag. diff --git a/versioned_docs/version-2.2/reference/global-options.mdx b/versioned_docs/version-2.2/reference/global-options.mdx index 3ca3e76a..976f843d 100644 --- a/versioned_docs/version-2.2/reference/global-options.mdx +++ b/versioned_docs/version-2.2/reference/global-options.mdx @@ -289,7 +289,7 @@ Directory to use for local process execution sandboxing. The path may be absolut env_repr='PANTS_LOCAL_STORE_DIR' toml_repr={`[GLOBAL] local_store_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/lmdb_store`} + default_repr={`\$XDG_CACHE_HOME/pants/lmdb_store`} > Directory to use for the local file store, which stores the results of subprocesses run by Pants. The path may be absolute or relative. If the directory is within the build root, be sure to include it in `--pants-ignore`. @@ -361,7 +361,7 @@ The maximum number of times to loop when `--loop` is specified. env_repr='PANTS_NAMED_CACHES_DIR' toml_repr={`[GLOBAL] named_caches_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/named_caches`} + default_repr={`\$XDG_CACHE_HOME/pants/named_caches`} > Directory to use for named global caches for tools and processes with trusted, concurrency-safe caches. The path may be absolute or relative. If the directory is within the build root, be sure to include it in `--pants-ignore`. @@ -662,7 +662,7 @@ Override config with values from these files, using syntax matching that of `--p env_repr='PANTS_PLUGIN_CACHE_DIR' toml_repr={`[GLOBAL] plugin_cache_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/plugins`} + default_repr={`\$XDG_CACHE_HOME/pants/plugins`} > Cache resolved plugin requirements here. diff --git a/versioned_docs/version-2.20/reference/global-options.mdx b/versioned_docs/version-2.20/reference/global-options.mdx index 224784cf..348f2c11 100644 --- a/versioned_docs/version-2.20/reference/global-options.mdx +++ b/versioned_docs/version-2.20/reference/global-options.mdx @@ -479,7 +479,7 @@ The path may be absolute or relative. If the directory is within the build root, env_repr='PANTS_LOCAL_STORE_DIR' toml_repr={`[GLOBAL] local_store_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/lmdb_store`} + default_repr={`\$XDG_CACHE_HOME/pants/lmdb_store`} > Directory to use for the local file store, which stores the results of subprocesses run by Pants. @@ -617,7 +617,7 @@ The maximum number of times to loop when `--loop` is specified. env_repr='PANTS_NAMED_CACHES_DIR' toml_repr={`[GLOBAL] named_caches_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/named_caches`} + default_repr={`\$XDG_CACHE_HOME/pants/named_caches`} > Directory to use for named global caches for tools and processes with trusted, concurrency-safe caches. diff --git a/versioned_docs/version-2.20/reference/targets/vcs_version.mdx b/versioned_docs/version-2.20/reference/targets/vcs_version.mdx index 623849b3..7aaf9722 100644 --- a/versioned_docs/version-2.20/reference/targets/vcs_version.mdx +++ b/versioned_docs/version-2.20/reference/targets/vcs_version.mdx @@ -91,7 +91,7 @@ All dependencies must share the same value for their `resolve` field. [vV]?\\d+(?:\\.\\d+){0,2}[^\\+]*)(?:\\+.*)?$'`} + default_repr={`'^(?:[\\w-]+-)?(?P[vV]?\\d+(?:\\.\\d+){0,2}[^\\+]*)(?:\\+.*)?\$'`} > A Python regex string to extract the version string from a VCS tag. diff --git a/versioned_docs/version-2.21/reference/global-options.mdx b/versioned_docs/version-2.21/reference/global-options.mdx index 15537170..e52916c6 100644 --- a/versioned_docs/version-2.21/reference/global-options.mdx +++ b/versioned_docs/version-2.21/reference/global-options.mdx @@ -479,7 +479,7 @@ The path may be absolute or relative. If the directory is within the build root, env_repr='PANTS_LOCAL_STORE_DIR' toml_repr={`[GLOBAL] local_store_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/lmdb_store`} + default_repr={`\$XDG_CACHE_HOME/pants/lmdb_store`} > Directory to use for the local file store, which stores the results of subprocesses run by Pants. @@ -617,7 +617,7 @@ The maximum number of times to loop when `--loop` is specified. env_repr='PANTS_NAMED_CACHES_DIR' toml_repr={`[GLOBAL] named_caches_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/named_caches`} + default_repr={`\$XDG_CACHE_HOME/pants/named_caches`} > Directory to use for named global caches for tools and processes with trusted, concurrency-safe caches. diff --git a/versioned_docs/version-2.21/reference/targets/vcs_version.mdx b/versioned_docs/version-2.21/reference/targets/vcs_version.mdx index 623849b3..7aaf9722 100644 --- a/versioned_docs/version-2.21/reference/targets/vcs_version.mdx +++ b/versioned_docs/version-2.21/reference/targets/vcs_version.mdx @@ -91,7 +91,7 @@ All dependencies must share the same value for their `resolve` field. [vV]?\\d+(?:\\.\\d+){0,2}[^\\+]*)(?:\\+.*)?$'`} + default_repr={`'^(?:[\\w-]+-)?(?P[vV]?\\d+(?:\\.\\d+){0,2}[^\\+]*)(?:\\+.*)?\$'`} > A Python regex string to extract the version string from a VCS tag. diff --git a/versioned_docs/version-2.22/reference/global-options.mdx b/versioned_docs/version-2.22/reference/global-options.mdx index 8e24c5f4..ac42bd86 100644 --- a/versioned_docs/version-2.22/reference/global-options.mdx +++ b/versioned_docs/version-2.22/reference/global-options.mdx @@ -502,7 +502,7 @@ The path may be absolute or relative. If the directory is within the build root, env_repr='PANTS_LOCAL_STORE_DIR' toml_repr={`[GLOBAL] local_store_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/lmdb_store`} + default_repr={`\$XDG_CACHE_HOME/pants/lmdb_store`} > Directory to use for the local file store, which stores the results of subprocesses run by Pants. @@ -640,7 +640,7 @@ The maximum number of times to loop when `--loop` is specified. env_repr='PANTS_NAMED_CACHES_DIR' toml_repr={`[GLOBAL] named_caches_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/named_caches`} + default_repr={`\$XDG_CACHE_HOME/pants/named_caches`} > Directory to use for named global caches for tools and processes with trusted, concurrency-safe caches. diff --git a/versioned_docs/version-2.22/reference/subsystems/jvm.mdx b/versioned_docs/version-2.22/reference/subsystems/jvm.mdx index 72db1844..98f6776e 100644 --- a/versioned_docs/version-2.22/reference/subsystems/jvm.mdx +++ b/versioned_docs/version-2.22/reference/subsystems/jvm.mdx @@ -70,7 +70,7 @@ deploy_jar_exclude_files = [ '', ..., ]`} - default_repr={`[\n "^META-INF/[^/]+\\.SF$",\n "^META-INF/[^/]+\\.DSA$",\n "^META-INF/[^/]+\\.RSA$",\n "META-INF/INDEX.LIST$"\n]`} + default_repr={`[\n "^META-INF/[^/]+\\.SF\$",\n "^META-INF/[^/]+\\.DSA\$",\n "^META-INF/[^/]+\\.RSA\$",\n "META-INF/INDEX.LIST\$"\n]`} > A list of patterns to exclude from all deploy jars. An individual deploy_jar target can also exclude other files, in addition to these, by setting its `exclude_files` field. diff --git a/versioned_docs/version-2.22/reference/targets/vcs_version.mdx b/versioned_docs/version-2.22/reference/targets/vcs_version.mdx index 623849b3..7aaf9722 100644 --- a/versioned_docs/version-2.22/reference/targets/vcs_version.mdx +++ b/versioned_docs/version-2.22/reference/targets/vcs_version.mdx @@ -91,7 +91,7 @@ All dependencies must share the same value for their `resolve` field. [vV]?\\d+(?:\\.\\d+){0,2}[^\\+]*)(?:\\+.*)?$'`} + default_repr={`'^(?:[\\w-]+-)?(?P[vV]?\\d+(?:\\.\\d+){0,2}[^\\+]*)(?:\\+.*)?\$'`} > A Python regex string to extract the version string from a VCS tag. diff --git a/versioned_docs/version-2.3/reference/global-options.mdx b/versioned_docs/version-2.3/reference/global-options.mdx index bce8333b..9374bd92 100644 --- a/versioned_docs/version-2.3/reference/global-options.mdx +++ b/versioned_docs/version-2.3/reference/global-options.mdx @@ -289,7 +289,7 @@ Directory to use for local process execution sandboxing. The path may be absolut env_repr='PANTS_LOCAL_STORE_DIR' toml_repr={`[GLOBAL] local_store_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/lmdb_store`} + default_repr={`\$XDG_CACHE_HOME/pants/lmdb_store`} > Directory to use for the local file store, which stores the results of subprocesses run by Pants. The path may be absolute or relative. If the directory is within the build root, be sure to include it in `--pants-ignore`. @@ -361,7 +361,7 @@ The maximum number of times to loop when `--loop` is specified. env_repr='PANTS_NAMED_CACHES_DIR' toml_repr={`[GLOBAL] named_caches_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/named_caches`} + default_repr={`\$XDG_CACHE_HOME/pants/named_caches`} > Directory to use for named global caches for tools and processes with trusted, concurrency-safe caches. The path may be absolute or relative. If the directory is within the build root, be sure to include it in `--pants-ignore`. @@ -1202,7 +1202,7 @@ Verify that all config file values correspond to known options. env_repr='PANTS_PLUGIN_CACHE_DIR' toml_repr={`[GLOBAL] plugin_cache_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/plugins`} + default_repr={`\$XDG_CACHE_HOME/pants/plugins`} removal_version='2.5.0.dev0' removal_hint={'This option now no-ops, the plugins cache is now housed in the named caches.'} > diff --git a/versioned_docs/version-2.4/reference/global-options.mdx b/versioned_docs/version-2.4/reference/global-options.mdx index 3ac6d3ac..abd91ada 100644 --- a/versioned_docs/version-2.4/reference/global-options.mdx +++ b/versioned_docs/version-2.4/reference/global-options.mdx @@ -289,7 +289,7 @@ Directory to use for local process execution sandboxing. The path may be absolut env_repr='PANTS_LOCAL_STORE_DIR' toml_repr={`[GLOBAL] local_store_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/lmdb_store`} + default_repr={`\$XDG_CACHE_HOME/pants/lmdb_store`} > Directory to use for the local file store, which stores the results of subprocesses run by Pants. The path may be absolute or relative. If the directory is within the build root, be sure to include it in `--pants-ignore`. @@ -425,7 +425,7 @@ The maximum number of times to loop when `--loop` is specified. env_repr='PANTS_NAMED_CACHES_DIR' toml_repr={`[GLOBAL] named_caches_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/named_caches`} + default_repr={`\$XDG_CACHE_HOME/pants/named_caches`} > Directory to use for named global caches for tools and processes with trusted, concurrency-safe caches. The path may be absolute or relative. If the directory is within the build root, be sure to include it in `--pants-ignore`. @@ -1273,7 +1273,7 @@ Verify that all config file values correspond to known options. env_repr='PANTS_PLUGIN_CACHE_DIR' toml_repr={`[GLOBAL] plugin_cache_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/plugins`} + default_repr={`\$XDG_CACHE_HOME/pants/plugins`} removal_version='2.5.0.dev0' removal_hint={'This option now no-ops, the plugins cache is now housed in the named caches.'} > diff --git a/versioned_docs/version-2.5/reference/global-options.mdx b/versioned_docs/version-2.5/reference/global-options.mdx index af48280d..3dec2fa7 100644 --- a/versioned_docs/version-2.5/reference/global-options.mdx +++ b/versioned_docs/version-2.5/reference/global-options.mdx @@ -298,7 +298,7 @@ The path may be absolute or relative. If the directory is within the build root, env_repr='PANTS_LOCAL_STORE_DIR' toml_repr={`[GLOBAL] local_store_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/lmdb_store`} + default_repr={`\$XDG_CACHE_HOME/pants/lmdb_store`} > Directory to use for the local file store, which stores the results of subprocesses run by Pants. @@ -436,7 +436,7 @@ The maximum number of times to loop when `--loop` is specified. env_repr='PANTS_NAMED_CACHES_DIR' toml_repr={`[GLOBAL] named_caches_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/named_caches`} + default_repr={`\$XDG_CACHE_HOME/pants/named_caches`} > Directory to use for named global caches for tools and processes with trusted, concurrency-safe caches. diff --git a/versioned_docs/version-2.6/reference/global-options.mdx b/versioned_docs/version-2.6/reference/global-options.mdx index ac1c2438..41f134a6 100644 --- a/versioned_docs/version-2.6/reference/global-options.mdx +++ b/versioned_docs/version-2.6/reference/global-options.mdx @@ -300,7 +300,7 @@ The path may be absolute or relative. If the directory is within the build root, env_repr='PANTS_LOCAL_STORE_DIR' toml_repr={`[GLOBAL] local_store_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/lmdb_store`} + default_repr={`\$XDG_CACHE_HOME/pants/lmdb_store`} > Directory to use for the local file store, which stores the results of subprocesses run by Pants. @@ -438,7 +438,7 @@ The maximum number of times to loop when `--loop` is specified. env_repr='PANTS_NAMED_CACHES_DIR' toml_repr={`[GLOBAL] named_caches_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/named_caches`} + default_repr={`\$XDG_CACHE_HOME/pants/named_caches`} > Directory to use for named global caches for tools and processes with trusted, concurrency-safe caches. diff --git a/versioned_docs/version-2.7/reference/global-options.mdx b/versioned_docs/version-2.7/reference/global-options.mdx index c5419bd4..05324826 100644 --- a/versioned_docs/version-2.7/reference/global-options.mdx +++ b/versioned_docs/version-2.7/reference/global-options.mdx @@ -316,7 +316,7 @@ The path may be absolute or relative. If the directory is within the build root, env_repr='PANTS_LOCAL_STORE_DIR' toml_repr={`[GLOBAL] local_store_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/lmdb_store`} + default_repr={`\$XDG_CACHE_HOME/pants/lmdb_store`} > Directory to use for the local file store, which stores the results of subprocesses run by Pants. @@ -454,7 +454,7 @@ The maximum number of times to loop when `--loop` is specified. env_repr='PANTS_NAMED_CACHES_DIR' toml_repr={`[GLOBAL] named_caches_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/named_caches`} + default_repr={`\$XDG_CACHE_HOME/pants/named_caches`} > Directory to use for named global caches for tools and processes with trusted, concurrency-safe caches. diff --git a/versioned_docs/version-2.8/reference/global-options.mdx b/versioned_docs/version-2.8/reference/global-options.mdx index db43409e..df08caf6 100644 --- a/versioned_docs/version-2.8/reference/global-options.mdx +++ b/versioned_docs/version-2.8/reference/global-options.mdx @@ -324,7 +324,7 @@ The path may be absolute or relative. If the directory is within the build root, env_repr='PANTS_LOCAL_STORE_DIR' toml_repr={`[GLOBAL] local_store_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/lmdb_store`} + default_repr={`\$XDG_CACHE_HOME/pants/lmdb_store`} > Directory to use for the local file store, which stores the results of subprocesses run by Pants. @@ -462,7 +462,7 @@ The maximum number of times to loop when `--loop` is specified. env_repr='PANTS_NAMED_CACHES_DIR' toml_repr={`[GLOBAL] named_caches_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/named_caches`} + default_repr={`\$XDG_CACHE_HOME/pants/named_caches`} > Directory to use for named global caches for tools and processes with trusted, concurrency-safe caches. diff --git a/versioned_docs/version-2.9/reference/global-options.mdx b/versioned_docs/version-2.9/reference/global-options.mdx index 8498c1d5..63aae316 100644 --- a/versioned_docs/version-2.9/reference/global-options.mdx +++ b/versioned_docs/version-2.9/reference/global-options.mdx @@ -414,7 +414,7 @@ The path may be absolute or relative. If the directory is within the build root, env_repr='PANTS_LOCAL_STORE_DIR' toml_repr={`[GLOBAL] local_store_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/lmdb_store`} + default_repr={`\$XDG_CACHE_HOME/pants/lmdb_store`} > Directory to use for the local file store, which stores the results of subprocesses run by Pants. @@ -552,7 +552,7 @@ The maximum number of times to loop when `--loop` is specified. env_repr='PANTS_NAMED_CACHES_DIR' toml_repr={`[GLOBAL] named_caches_dir = `} - default_repr={`$XDG_CACHE_HOME/pants/named_caches`} + default_repr={`\$XDG_CACHE_HOME/pants/named_caches`} > Directory to use for named global caches for tools and processes with trusted, concurrency-safe caches.