docs(testing): add x-priority to cypress package (#14253)

This commit is contained in:
Caleb Ukle 2023-01-23 09:28:59 -06:00 committed by GitHub
parent ac3804983b
commit f372dbf99c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 38 additions and 19 deletions

View File

@ -73,7 +73,8 @@
},
"baseUrl": {
"type": "string",
"description": "The address (with the port) which your application is running on."
"description": "The address (with the port) which your application is running on.",
"x-priority": "important"
},
"browser": {
"type": "string",
@ -90,7 +91,8 @@
"copyFiles": {
"type": "string",
"description": "A regex string that is used to choose what additional integration files to copy to the dist folder.",
"x-deprecated": "No longer used since cypress supports typescript out of the box. If specified, it will be ignored."
"x-deprecated": "No longer used since cypress supports typescript out of the box. If specified, it will be ignored.",
"x-priority": "internal"
},
"ciBuildId": {
"oneOf": [{ "type": "string" }, { "type": "number" }],

View File

@ -12,7 +12,8 @@
"project": {
"type": "string",
"description": "The name of the frontend project to test.",
"$default": { "$source": "projectName" }
"$default": { "$source": "projectName" },
"x-priority": "important"
},
"baseUrl": {
"type": "string",
@ -26,7 +27,8 @@
},
"directory": {
"type": "string",
"description": "A directory where the project is placed."
"description": "A directory where the project is placed.",
"x-priority": "important"
},
"linter": {
"description": "The tool to use for running lint checks.",
@ -42,7 +44,8 @@
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"setParserOptionsProject": {
"type": "boolean",
@ -51,18 +54,21 @@
},
"standaloneConfig": {
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside workspace.json.",
"type": "boolean"
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"type": "boolean",
"default": false,
"description": "Do not add dependencies to `package.json`."
"description": "Do not add dependencies to `package.json`.",
"x-priority": "internal"
},
"rootProject": {
"description": "Create a application at the root of the workspace",
"type": "boolean",
"default": false,
"hidden": true
"hidden": true,
"x-priority": "internal"
},
"bundler": {
"description": "The Cypress bundler to use.",

View File

@ -12,7 +12,8 @@
"skipPackageJson": {
"type": "boolean",
"default": false,
"description": "Do not add dependencies to `package.json`."
"description": "Do not add dependencies to `package.json`.",
"x-priority": "internal"
}
},
"presets": []

View File

@ -73,7 +73,8 @@
},
"baseUrl": {
"type": "string",
"description": "The address (with the port) which your application is running on."
"description": "The address (with the port) which your application is running on.",
"x-priority": "important"
},
"browser": {
"type": "string",
@ -90,7 +91,8 @@
"copyFiles": {
"type": "string",
"description": "A regex string that is used to choose what additional integration files to copy to the dist folder.",
"x-deprecated": "No longer used since cypress supports typescript out of the box. If specified, it will be ignored."
"x-deprecated": "No longer used since cypress supports typescript out of the box. If specified, it will be ignored.",
"x-priority": "internal"
},
"ciBuildId": {
"oneOf": [

View File

@ -36,7 +36,8 @@
"skipFormat": {
"type": "boolean",
"description": "Skip formatting files.",
"default": false
"default": false,
"x-priority": "internal"
}
},
"required": ["project"]

View File

@ -11,7 +11,8 @@
"description": "The name of the frontend project to test.",
"$default": {
"$source": "projectName"
}
},
"x-priority": "important"
},
"baseUrl": {
"type": "string",
@ -28,7 +29,8 @@
},
"directory": {
"type": "string",
"description": "A directory where the project is placed."
"description": "A directory where the project is placed.",
"x-priority": "important"
},
"linter": {
"description": "The tool to use for running lint checks.",
@ -44,7 +46,8 @@
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"setParserOptionsProject": {
"type": "boolean",
@ -53,18 +56,21 @@
},
"standaloneConfig": {
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside workspace.json.",
"type": "boolean"
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"type": "boolean",
"default": false,
"description": "Do not add dependencies to `package.json`."
"description": "Do not add dependencies to `package.json`.",
"x-priority": "internal"
},
"rootProject": {
"description": "Create a application at the root of the workspace",
"type": "boolean",
"default": false,
"hidden": true
"hidden": true,
"x-priority": "internal"
},
"bundler": {
"description": "The Cypress bundler to use.",

View File

@ -9,7 +9,8 @@
"skipPackageJson": {
"type": "boolean",
"default": false,
"description": "Do not add dependencies to `package.json`."
"description": "Do not add dependencies to `package.json`.",
"x-priority": "internal"
}
}
}