From 493a630be82b644e6744844208311993b1486e5c Mon Sep 17 00:00:00 2001 From: Cheng Liu Date: Fri, 15 Mar 2024 12:39:47 -0700 Subject: [PATCH] chore: update duplicated strings anywhere --- apps/sparo-lib/assets/sparo-profile.json | 11 +++++------ apps/sparo-lib/src/schemas/sparo-profile.schema.json | 6 +++--- apps/website/docs/pages/configs/profile_json.md | 8 ++++++++ apps/website/static/schemas/sparo-profile.schema.json | 6 +++--- 4 files changed, 19 insertions(+), 12 deletions(-) diff --git a/apps/sparo-lib/assets/sparo-profile.json b/apps/sparo-lib/assets/sparo-profile.json index 623e632..633830f 100644 --- a/apps/sparo-lib/assets/sparo-profile.json +++ b/apps/sparo-lib/assets/sparo-profile.json @@ -36,8 +36,8 @@ /** * A list of arbitrary additional folders to be included for checkout, * not necessarily corresponding to any workspace project. - * The paths should use forward slashes, without a leading slash, and should be to the - * root folder of the monorepo. Wildcards and glob patterns are not supported for + * The paths should use forward slashes, without a leading slash, and should be to the + * root folder of the monorepo. Wildcards and glob patterns are not supported for * performance reasons. */ "includeFolders": [ @@ -48,10 +48,9 @@ * A list of folders to be excluded from the checkout. This field takes precedence * over the "includeFolders" and "selections" fields, guaranteeing that the * specified path will definitely not be included. - * Each path given should be relative to the root directory of the Monorepo. - * Wildcards and glob patterns are not permitted due to a number of shortcomings. - * See the git sparse-checkout documentation for details: - * https://git-scm.com/docs/git-sparse-checkout#_internalsnon_cone_problems + * The paths should use forward slashes, without a leading slash, and should be to the + * root folder of the monorepo. Wildcards and glob patterns are not supported for + * performance reasons. */ "excludeFolders": [ // "path/to/exclude" diff --git a/apps/sparo-lib/src/schemas/sparo-profile.schema.json b/apps/sparo-lib/src/schemas/sparo-profile.schema.json index 3ee3a34..0549417 100644 --- a/apps/sparo-lib/src/schemas/sparo-profile.schema.json +++ b/apps/sparo-lib/src/schemas/sparo-profile.schema.json @@ -23,7 +23,7 @@ "type": "string" }, "argument": { - "description": "The selector argument, for example a project name or an expression such as \"tag:my-tag\".", + "description": "The selector argument, for example a project name or an expression such as \"tag:my-tag\".\nTo learn about Rush project tags, see this documentation:\nhttps://rushjs.io/pages/developer/project_tags/", "type": "string" } } @@ -31,7 +31,7 @@ }, "includeFolders": { - "description": "A list of arbitrary additional folders to be included for checkout, not necessarily corresponding to any workspace project.", + "description": "A list of arbitrary additional folders to be included for checkout, not necessarily corresponding to any workspace project.\nThe paths should use forward slashes, without a leading slash, and should be to the root folder of the monorepo. Wildcards and glob patterns are not supported for performance reasons.", "type": "array", "items": { "type": "string" @@ -39,7 +39,7 @@ }, "excludeFolders": { - "description": "A list of folders to be excluded from the checkout. This field takes precedence over the \"includeFolders\" and \"selections\" fields, guaranteeing that the specified path will definitely not be included.", + "description": "A list of folders to be excluded from the checkout. This field takes precedence over the \"includeFolders\" and \"selections\" fields, guaranteeing that the specified path will definitely not be included.\nThe paths should use forward slashes, without a leading slash, and should be to the root folder of the monorepo. Wildcards and glob patterns are not supported for performance reasons.", "type": "array", "items": { "type": "string" diff --git a/apps/website/docs/pages/configs/profile_json.md b/apps/website/docs/pages/configs/profile_json.md index 076ff79..19d6f7b 100644 --- a/apps/website/docs/pages/configs/profile_json.md +++ b/apps/website/docs/pages/configs/profile_json.md @@ -23,6 +23,8 @@ To initialize a new Sparo profile, you can copy and paste the contents of this t /** * For example, include all Rush projects tagged with "tag:my-team" * as well as the dependency workspace projects needed to build them. + * To learn about Rush project tags, see this documentation: + * https://rushjs.io/pages/developer/project_tags/ */ // { // "selector": "--to", @@ -42,6 +44,9 @@ To initialize a new Sparo profile, you can copy and paste the contents of this t /** * A list of arbitrary additional folders to be included for checkout, * not necessarily corresponding to any workspace project. + * The paths should use forward slashes, without a leading slash, and should be to the + * root folder of the monorepo. Wildcards and glob patterns are not supported for + * performance reasons. */ "includeFolders": [ // "path/to/include" @@ -51,6 +56,9 @@ To initialize a new Sparo profile, you can copy and paste the contents of this t * A list of folders to be excluded from the checkout. This field takes precedence * over the "includeFolders" and "selections" fields, guaranteeing that the * specified path will definitely not be included. + * The paths should use forward slashes, without a leading slash, and should be to the + * root folder of the monorepo. Wildcards and glob patterns are not supported for + * performance reasons. */ "excludeFolders": [ // "path/to/exclude" diff --git a/apps/website/static/schemas/sparo-profile.schema.json b/apps/website/static/schemas/sparo-profile.schema.json index 3ee3a34..0549417 100644 --- a/apps/website/static/schemas/sparo-profile.schema.json +++ b/apps/website/static/schemas/sparo-profile.schema.json @@ -23,7 +23,7 @@ "type": "string" }, "argument": { - "description": "The selector argument, for example a project name or an expression such as \"tag:my-tag\".", + "description": "The selector argument, for example a project name or an expression such as \"tag:my-tag\".\nTo learn about Rush project tags, see this documentation:\nhttps://rushjs.io/pages/developer/project_tags/", "type": "string" } } @@ -31,7 +31,7 @@ }, "includeFolders": { - "description": "A list of arbitrary additional folders to be included for checkout, not necessarily corresponding to any workspace project.", + "description": "A list of arbitrary additional folders to be included for checkout, not necessarily corresponding to any workspace project.\nThe paths should use forward slashes, without a leading slash, and should be to the root folder of the monorepo. Wildcards and glob patterns are not supported for performance reasons.", "type": "array", "items": { "type": "string" @@ -39,7 +39,7 @@ }, "excludeFolders": { - "description": "A list of folders to be excluded from the checkout. This field takes precedence over the \"includeFolders\" and \"selections\" fields, guaranteeing that the specified path will definitely not be included.", + "description": "A list of folders to be excluded from the checkout. This field takes precedence over the \"includeFolders\" and \"selections\" fields, guaranteeing that the specified path will definitely not be included.\nThe paths should use forward slashes, without a leading slash, and should be to the root folder of the monorepo. Wildcards and glob patterns are not supported for performance reasons.", "type": "array", "items": { "type": "string"