7cc5c4f330d47060/tiktok-sparo
1
0
Fork 0
mirror of https://github.com/tiktok/sparo.git synced 2024-11-14 19:35:12 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Improve the JSON schema docs

Browse source
This commit is contained in:
Pete Gonzalez 2024-03-04 22:28:05 -08:00
parent 65590f32db
commit 41c752b3f4
4 changed files with 31 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
apps/sparo-lib/assets/sparo-profile.json
View file

@ -1,3 +1,7 @@
/**
* OWNER: <your team name>
* PURPOSE: <what you use this profile for>
*/
{
"$schema": "https://tiktok.github.io/sparo/schemas/sparo-profile.schema.json",
@ -28,16 +32,16 @@
],
/**
* A list of arbitrary additional folders to be included, not necessarily
* corresponding to any workspace project.
* A list of arbitrary additional folders to be included for checkout,
* not necessarily corresponding to any workspace project.
*/
"includeFolders": [
// "path/to/include"
],
/**
* A list of folders to be excluded. This field takes precedence over
* the "includeFolders" and "selections" fields, guaranteeing that the
* 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.
*/
"excludeFolders": [

17
apps/sparo-lib/src/schemas/sparo-profile.schema.json
View file

@ -1,7 +1,7 @@
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Profile for Sparo tool.",
"description": "For use with the sparo tool, this file provides the scope of folders in the sparse checkout cone",
"title": "A sparse checkout profile for use with the Sparo tool",
"description": "This config file is used by the Sparo tool that optimizes performance of Git operations for a large frontend monorepo.\n\nhttps://tiktok.github.io/sparo/",
"type": "object",
"additionalProperties": false,
@ -12,19 +12,18 @@
},
"selections": {
"description": "A list of project selection definition",
"description": "A list of Rush project selectors indicating the project folders to be included for sparse checkout. The selectors will be combined to make the union superset of projects.\n\nSee the Rush selector documentation for details:\nhttps://rushjs.io/pages/developer/selecting_subsets/",
"type": "array",
"items": {
"description": "A definition of project selector parameter. See https://rushjs.io/pages/developer/selecting_subsets/",
"type": "object",
"additionalProperties": false,
"properties": {
"selector": {
"description": "The selector",
"description": "A RushJS project selector such as \"--to\", \"--from\", \"--impacted-by\".\n\nSee the Rush selector documentation for details:\nhttps://rushjs.io/pages/developer/selecting_subsets/",
"type": "string"
},
"argument": {
"description": "The argument of selector, it can be one project name, tagged projects prefixes with tag:, and modified projects prefixes with git:",
"description": "The selector argument, for example a project name or an expression such as \"tag:my-tag\".",
"type": "string"
}
}
@ -32,19 +31,17 @@
},
"includeFolders": {
"description": "A list of folders expand the sparse checkout cone, adding more include folders.",
"description": "A list of arbitrary additional folders to be included for checkout, not necessarily corresponding to any workspace project.",
"type": "array",
"items": {
"description": "A relative path from the root of monorepo",
"type": "string"
}
},
"excludeFolders": {
"description": "A list of folders will be excluded in the sparse checkout cone. The exclude folders overrides include folders and the result of selection",
"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.",
"type": "array",
"items": {
"description": "A relative path from the root of monorepo",
"type": "string"
}
}

15
apps/website/docs/pages/configs/profile_json.md
View file

@ -6,6 +6,10 @@ To initialize a new Sparo profile, you can copy and paste the contents of this t
**common/sparo-profiles/&lt;profile-name&gt;.json**
```js
/**
* OWNER: <your team name>
* PURPOSE: <what you use this profile for>
*/
{
"$schema": "https://tiktok.github.io/sparo/schemas/sparo-profile.schema.json",
@ -24,7 +28,6 @@ To initialize a new Sparo profile, you can copy and paste the contents of this t
// "selector": "--to",
// "argument": "tag:my-team"
// },
/**
* For example, include the project called "my-library", as well as all
* projects that are impacted by changes to it, as well as the dependency
@ -37,16 +40,16 @@ 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, not necessarily
* corresponding to any workspace project.
* A list of arbitrary additional folders to be included for checkout,
* not necessarily corresponding to any workspace project.
*/
"includeFolders": [
// "path/to/include"
],
/**
* A list of folders to be excluded. This field takes precedence over
* the "includeFolders" and "selections" fields, guaranteeing that the
* 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.
*/
"excludeFolders": [

17
apps/website/static/schemas/sparo-profile.schema.json
View file

@ -1,7 +1,7 @@
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Profile for Sparo tool.",
"description": "For use with the sparo tool, this file provides the scope of folders in the sparse checkout cone",
"title": "A sparse checkout profile for use with the Sparo tool",
"description": "This config file is used by the Sparo tool that optimizes performance of Git operations for a large frontend monorepo.\n\nhttps://tiktok.github.io/sparo/",
"type": "object",
"additionalProperties": false,
@ -12,19 +12,18 @@
},
"selections": {
"description": "A list of project selection definition",
"description": "A list of Rush project selectors indicating the project folders to be included for sparse checkout. The selectors will be combined to make the union superset of projects.\n\nSee the Rush selector documentation for details:\nhttps://rushjs.io/pages/developer/selecting_subsets/",
"type": "array",
"items": {
"description": "A definition of project selector parameter. See https://rushjs.io/pages/developer/selecting_subsets/",
"type": "object",
"additionalProperties": false,
"properties": {
"selector": {
"description": "The selector",
"description": "A RushJS project selector such as \"--to\", \"--from\", \"--impacted-by\".\n\nSee the Rush selector documentation for details:\nhttps://rushjs.io/pages/developer/selecting_subsets/",
"type": "string"
},
"argument": {
"description": "The argument of selector, it can be one project name, tagged projects prefixes with tag:, and modified projects prefixes with git:",
"description": "The selector argument, for example a project name or an expression such as \"tag:my-tag\".",
"type": "string"
}
}
@ -32,19 +31,17 @@
},
"includeFolders": {
"description": "A list of folders expand the sparse checkout cone, adding more include folders.",
"description": "A list of arbitrary additional folders to be included for checkout, not necessarily corresponding to any workspace project.",
"type": "array",
"items": {
"description": "A relative path from the root of monorepo",
"type": "string"
}
},
"excludeFolders": {
"description": "A list of folders will be excluded in the sparse checkout cone. The exclude folders overrides include folders and the result of selection",
"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.",
"type": "array",
"items": {
"description": "A relative path from the root of monorepo",
"type": "string"
}
}