repository
stringclasses 528
values | commit
stringlengths 40
40
| commitDate
timestamp[s] | path
stringlengths 11
149
| repoStars
int64 5
94.9k
| repoLastFetched
stringclasses 528
values | content
stringlengths 48
736k
| license
stringclasses 14
values | language
stringclasses 7
values |
|---|---|---|---|---|---|---|---|---|
CesiumGS/cesium-native | 30f5d148642e676bad69c595117444d0b0020b20 | 2024-04-10T04:07:11 | CesiumQuantizedMeshTerrain/schema/availabilityRectangle.schema.json | 373 | 2024-05-28T04:42:55.610782Z | {
"$id": "availabilityRectangle.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A rectangle of tile availability.",
"properties": {
"endX": {
"description": "The index of the end tile in the X direction.",
"type": "integer"
},
"endY": {
"description": "The index of the end tile in the Y direction.",
"type": "integer"
},
"startX": {
"description": "The index of the start tile in the X direction.",
"type": "integer"
},
"startY": {
"description": "The index of the start tile in the Y direction.",
"type": "integer"
}
},
"required": [
"startX",
"startY",
"endX",
"endY"
],
"title": "AvailabilityRectangle"
} | Apache-2.0 | en |
CesiumGS/cesium-native | 30f5d148642e676bad69c595117444d0b0020b20 | 2024-04-10T04:07:11 | CesiumQuantizedMeshTerrain/schema/layer.schema.json | 373 | 2024-05-28T04:42:55.610782Z | {
"$id": "layer.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A legacy terrain layer.json.",
"properties": {
"attribution": {
"default": "",
"description": "The attribution (credit) string for the terrain.",
"type": "string"
},
"available": {
"description": "The tile availability information. The outer array is indexed by tile level. The inner array is a list of rectangles of availability at that level. Tiles themselves may also contain further availability information for their subtree.",
"items": {
"items": {
"$ref": "availabilityRectangle.schema.json"
},
"type": "array"
},
"type": "array"
},
"bounds": {
"default": [
-180,
-90,
180,
90
],
"description": "The bounding box of the terrain, expressed as west, south, east, north in degrees.",
"items": {
"type": "number"
},
"maxItems": 4,
"minItems": 4,
"type": "array"
},
"description": {
"default": "",
"description": "The description of this terrain tileset.",
"type": "string"
},
"extensions": {
"description": "The extensions available for this tileset.",
"items": {
"type": "string"
},
"type": "array"
},
"format": {
"default": "quantized-mesh-1.0",
"description": "The format of the terrain tiles. Should be `\"quantized-mesh-1.0\"`.",
"type": "string"
},
"maxzoom": {
"description": "The maximum level for which there are any available tiles.",
"type": "integer"
},
"metadataAvailability": {
"description": "The levels at metadata is found in tiles. For example, if this value is 10, then metadata is found at levels 0, 10, 20, etc.",
"type": "integer"
},
"minzoom": {
"default": 0,
"description": "The minimum level for which there are any available tiles.",
"type": "integer"
},
"name": {
"default": "Terrain",
"description": "The name of this terrain tileset.",
"type": "string"
},
"parentUrl": {
"description": "The URL of the parent layer.json that this one is layered on top of.",
"type": "string"
},
"projection": {
"default": "EPSG:4326",
"description": "The map projection of this tileset. Valid values are `\"EPSG:4326\"` and `\"EPSG:3857\"`.",
"type": "string"
},
"scheme": {
"default": "tms",
"description": "The tiling scheme. The only valid value is `\"tms\"`.",
"type": "string"
},
"tiles": {
"description": "The URL templates from which to obtain tiles.",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"default": "1.0.0",
"description": "The version of this tileset.",
"type": "string"
}
},
"required": [
"tiles",
"maxzoom"
],
"title": "Layer"
} | Apache-2.0 | en |
tyconsulting/CloudNaming-Module | e93c04f9b7ad4372202c6226f395ee728d316239 | 2022-08-28T12:23:59 | CloudNaming/CloudNaming.schema.json | 5 | 2024-05-27T06:49:13.957271Z | {
"$id": "http://example.com/example.json",
"$schema": "http://json-schema.org/draft-07/schema",
"additionalProperties": true,
"default": {},
"description": "The root schema comprises the entire JSON document.",
"examples": [],
"properties": {
"allowedValues": {
"$id": "#/properties/allowedValues",
"additionalProperties": true,
"default": {},
"description": "An explanation about the purpose of this instance.",
"examples": [],
"properties": {
"cloud": {
"$id": "#/properties/allowedValues/properties/cloud",
"additionalItems": true,
"default": [],
"description": "An explanation about the purpose of this instance.",
"examples": [],
"items": {
"$id": "#/properties/allowedValues/properties/cloud/items",
"anyOf": [
{
"$id": "#/properties/allowedValues/properties/cloud/items/anyOf/0",
"additionalProperties": true,
"default": {},
"description": "An explanation about the purpose of this instance.",
"examples": [
{
"description": "Microsoft Azure",
"name": "azure"
},
{
"description": "Amazon Web Services",
"name": "aws"
},
{
"description": "Google Cloud Platform",
"name": "gcp"
}
],
"properties": {
"description": {
"$id": "#/properties/allowedValues/properties/cloud/items/anyOf/0/properties/description",
"default": "",
"description": "An explanation about the purpose of this instance.",
"examples": [
"Microsoft Azure"
],
"title": "The description schema",
"type": "string"
},
"name": {
"$id": "#/properties/allowedValues/properties/cloud/items/anyOf/0/properties/value",
"default": "",
"description": "An explanation about the purpose of this instance.",
"examples": [
"azure"
],
"title": "The name schema",
"type": "string"
}
},
"required": [
"name",
"description"
],
"title": "The first anyOf schema",
"type": "object"
}
]
},
"title": "The cloud schema",
"type": "array"
},
"company": {
"$id": "#/properties/allowedValues/properties/company",
"additionalItems": true,
"default": [],
"description": "An explanation about the purpose of this instance.",
"examples": [],
"items": {
"$id": "#/properties/allowedValues/properties/company/items",
"anyOf": [
{
"$id": "#/properties/allowedValues/properties/company/items/anyOf/0",
"additionalProperties": true,
"default": {},
"description": "An explanation about the purpose of this instance.",
"examples": [
{
"description": "Contoso Ltd.",
"value": "contoso"
}
],
"properties": {
"description": {
"$id": "#/properties/allowedValues/properties/company/items/anyOf/0/properties/description",
"default": "",
"description": "An explanation about the purpose of this instance.",
"examples": [
"Contoso Ltd."
],
"title": "The description schema",
"type": "string"
},
"value": {
"$id": "#/properties/allowedValues/properties/company/items/anyOf/0/properties/value",
"default": "",
"description": "An explanation about the purpose of this instance.",
"examples": [
"contoso"
],
"title": "The value schema",
"type": "string"
}
},
"required": [
"value",
"description"
],
"title": "The first anyOf schema",
"type": "object"
}
]
},
"title": "The company schema",
"type": "array"
},
"resourceType": {
"$id": "#/properties/allowedValues/properties/resourceType",
"additionalItems": true,
"default": [],
"description": "An explanation about the purpose of this instance.",
"examples": [],
"items": {
"$id": "#/properties/allowedValues/properties/resourceType/items",
"anyOf": [
{
"$id": "#/properties/allowedValues/properties/resourceType/items/anyOf/0",
"additionalProperties": true,
"default": {},
"description": "An explanation about the purpose of this instance.",
"examples": [],
"properties": {
"case": {
"$id": "#/properties/allowedValues/properties/resourceType/items/anyOf/0/properties/case",
"default": "",
"description": "An explanation about the purpose of this instance.",
"examples": [
"lower"
],
"title": "The case schema",
"type": "string"
},
"cloud": {
"$id": "#/properties/allowedValues/properties/resourceType/items/anyOf/0/properties/cloud",
"default": "",
"description": "An explanation about the purpose of this instance.",
"examples": [
"azure"
],
"title": "The cloud schema",
"type": "string"
},
"description": {
"$id": "#/properties/allowedValues/properties/resourceType/items/anyOf/0/properties/description",
"default": "",
"description": "An explanation about the purpose of this instance.",
"examples": [
"Automation Account"
],
"title": "The description schema",
"type": "string"
},
"leadingZeros": {
"$id": "#/properties/allowedValues/properties/resourceType/items/anyOf/0/properties/leadingZeros",
"default": false,
"description": "An explanation about the purpose of this instance.",
"examples": [
true
],
"title": "The leadingZeros schema",
"type": "boolean"
},
"maxLength": {
"$id": "#/properties/allowedValues/properties/resourceType/items/anyOf/0/properties/maxLength",
"default": 0,
"description": "An explanation about the purpose of this instance.",
"examples": [
50
],
"title": "The maxLength schema",
"type": "integer"
},
"minLength": {
"$id": "#/properties/allowedValues/properties/resourceType/items/anyOf/0/properties/minLength",
"default": 0,
"description": "An explanation about the purpose of this instance.",
"examples": [
6
],
"title": "The minLength schema",
"type": "integer"
},
"pattern": {
"$id": "#/properties/allowedValues/properties/resourceType/items/anyOf/0/properties/pattern",
"default": "",
"description": "An explanation about the purpose of this instance.",
"examples": [
"{company}-{resourceType}-{environment}-{appIdentifier}-{instance}"
],
"title": "The pattern schema",
"type": "string"
},
"value": {
"$id": "#/properties/allowedValues/properties/resourceType/items/anyOf/0/properties/value",
"default": "",
"description": "An explanation about the purpose of this instance.",
"examples": [
"aa"
],
"title": "The value schema",
"type": "string"
}
},
"required": [
"value",
"description",
"cloud",
"minLength",
"maxLength",
"case",
"leadingZeros",
"pattern"
],
"title": "The first anyOf schema",
"type": "object"
}
]
},
"title": "The resourceType schema",
"type": "array"
}
},
"required": [
"cloud",
"company",
"resourceType"
],
"title": "The allowedValues schema",
"type": "object"
},
"control": {
"$id": "#/properties/control",
"additionalProperties": true,
"default": {},
"description": "An explanation about the purpose of this instance.",
"examples": [],
"properties": {
"appIdentifier": {
"$id": "#/properties/control/properties/appIdentifier",
"additionalProperties": true,
"default": {},
"description": "An explanation about the purpose of this instance.",
"examples": [
{
"description": "Uniquely identifies the application.",
"maxLength": 7,
"minLength": 3,
"type": "string"
}
],
"properties": {
"description": {
"$id": "#/properties/control/properties/appIdentifier/properties/description",
"default": "",
"description": "An explanation about the purpose of this instance.",
"examples": [
"Uniquely identifies the application."
],
"title": "The description schema",
"type": "string"
},
"maxLength": {
"$id": "#/properties/control/properties/appIdentifier/properties/maxLength",
"default": 0,
"description": "An explanation about the purpose of this instance.",
"examples": [
7
],
"title": "The maxLength schema",
"type": "integer"
},
"minLength": {
"$id": "#/properties/control/properties/appIdentifier/properties/minLength",
"default": 0,
"description": "An explanation about the purpose of this instance.",
"examples": [
3
],
"title": "The minLength schema",
"type": "integer"
},
"type": {
"$id": "#/properties/control/properties/appIdentifier/properties/type",
"default": "",
"description": "An explanation about the purpose of this instance.",
"examples": [
"string"
],
"title": "The type schema",
"type": "string"
}
},
"required": [
"description",
"type",
"minLength",
"maxLength"
],
"title": "The appIdentifier schema",
"type": "object"
},
"associatedResourceName": {
"$id": "#/properties/control/properties/associatedResourceName",
"additionalProperties": true,
"default": {},
"description": "An explanation about the purpose of this instance.",
"examples": [
{
"description": "Associated resource name.",
"maxLength": 4,
"minLength": 2,
"regex": "^[a-zA-Z0-9]+(-?[a-zA-Z0-9])*[a-zA-Z0-9]+$",
"type": "string"
}
],
"properties": {
"description": {
"$id": "#/properties/control/properties/associatedResourceName/properties/description",
"default": "",
"description": "An explanation about the purpose of this instance.",
"examples": [
"Associated resource name."
],
"title": "The description schema",
"type": "string"
},
"maxLength": {
"$id": "#/properties/control/properties/associatedResourceName/properties/maxLength",
"default": 0,
"description": "An explanation about the purpose of this instance.",
"examples": [
4
],
"title": "The maxLength schema",
"type": "integer"
},
"minLength": {
"$id": "#/properties/control/properties/associatedResourceName/properties/minLength",
"default": 0,
"description": "An explanation about the purpose of this instance.",
"examples": [
2
],
"title": "The minLength schema",
"type": "integer"
},
"regex": {
"$id": "#/properties/control/properties/associatedResourceName/properties/regex",
"default": "",
"description": "An explanation about the purpose of this instance.",
"examples": [
"^[a-zA-Z0-9]+(-?[a-zA-Z0-9])*[a-zA-Z0-9]+$"
],
"title": "The regex schema",
"type": "string"
},
"type": {
"$id": "#/properties/control/properties/associatedResourceName/properties/type",
"default": "",
"description": "An explanation about the purpose of this instance.",
"examples": [
"string"
],
"title": "The type schema",
"type": "string"
}
},
"required": [
"description",
"type",
"minLength",
"maxLength",
"regex"
],
"title": "The associatedResourceName schema",
"type": "object"
},
"associatedResourceType": {
"$id": "#/properties/control/properties/associatedResourceType",
"additionalProperties": true,
"default": {},
"description": "An explanation about the purpose of this instance.",
"examples": [
{
"description": "Associated resource type.",
"maxLength": 5,
"minLength": 2,
"type": "string"
}
],
"properties": {
"description": {
"$id": "#/properties/control/properties/associatedResourceType/properties/description",
"default": "",
"description": "An explanation about the purpose of this instance.",
"examples": [
"Associated resource type."
],
"title": "The description schema",
"type": "string"
},
"maxLength": {
"$id": "#/properties/control/properties/associatedResourceType/properties/maxLength",
"default": 0,
"description": "An explanation about the purpose of this instance.",
"examples": [
5
],
"title": "The maxLength schema",
"type": "integer"
},
"minLength": {
"$id": "#/properties/control/properties/associatedResourceType/properties/minLength",
"default": 0,
"description": "An explanation about the purpose of this instance.",
"examples": [
2
],
"title": "The minLength schema",
"type": "integer"
},
"type": {
"$id": "#/properties/control/properties/associatedResourceType/properties/type",
"default": "",
"description": "An explanation about the purpose of this instance.",
"examples": [
"string"
],
"title": "The type schema",
"type": "string"
}
},
"required": [
"description",
"type",
"minLength",
"maxLength"
],
"title": "The associatedResourceType schema",
"type": "object"
},
"cloud": {
"$id": "#/properties/control/properties/cloud",
"additionalProperties": true,
"default": {},
"description": "An explanation about the purpose of this instance.",
"examples": [],
"properties": {
"description": {
"$id": "#/properties/control/properties/cloud/properties/description",
"default": "",
"description": "An explanation about the purpose of this instance.",
"examples": [],
"title": "The description schema",
"type": "string"
},
"maxLength": {
"$id": "#/properties/control/properties/cloud/properties/maxLength",
"default": 0,
"description": "An explanation about the purpose of this instance.",
"examples": [
3
],
"title": "The maxLength schema",
"type": "integer"
},
"minLength": {
"$id": "#/properties/control/properties/cloud/properties/minLength",
"default": 0,
"description": "An explanation about the purpose of this instance.",
"examples": [
3
],
"title": "The minLength schema",
"type": "integer"
},
"type": {
"$id": "#/properties/control/properties/cloud/properties/type",
"default": "",
"description": "An explanation about the purpose of this instance.",
"examples": [
"string"
],
"title": "The type schema",
"type": "string"
}
},
"required": [
"description",
"type",
"minLength",
"maxLength"
],
"title": "The cloud schema",
"type": "object"
},
"company": {
"$id": "#/properties/control/properties/company",
"additionalProperties": true,
"default": {},
"description": "An explanation about the purpose of this instance.",
"examples": [],
"properties": {
"description": {
"$id": "#/properties/control/properties/company/properties/description",
"default": "",
"description": "An explanation about the purpose of this instance.",
"examples": [],
"title": "The description schema",
"type": "string"
},
"maxLength": {
"$id": "#/properties/control/properties/company/properties/maxLength",
"default": 0,
"description": "An explanation about the purpose of this instance.",
"examples": [
3
],
"title": "The maxLength schema",
"type": "integer"
},
"minLength": {
"$id": "#/properties/control/properties/company/properties/minLength",
"default": 0,
"description": "An explanation about the purpose of this instance.",
"examples": [
3
],
"title": "The minLength schema",
"type": "integer"
},
"type": {
"$id": "#/properties/control/properties/company/properties/type",
"default": "",
"description": "An explanation about the purpose of this instance.",
"examples": [
"string"
],
"title": "The type schema",
"type": "string"
}
},
"required": [
"description",
"type",
"minLength",
"maxLength"
],
"title": "The cloud schema",
"type": "object"
},
"environment": {
"$id": "#/properties/control/properties/environment",
"additionalProperties": true,
"default": {},
"description": "An explanation about the purpose of this instance.",
"examples": [
{
"description": "Environment.",
"maxLength": 3,
"minLength": 3,
"regex": "^[a-zA-Z][0-9]{2}$",
"type": "string"
}
],
"properties": {
"description": {
"$id": "#/properties/control/properties/environment/properties/description",
"default": "",
"description": "An explanation about the purpose of this instance.",
"examples": [
"Environment."
],
"title": "The description schema",
"type": "string"
},
"maxLength": {
"$id": "#/properties/control/properties/environment/properties/maxLength",
"default": 0,
"description": "An explanation about the purpose of this instance.",
"examples": [
3
],
"title": "The maxLength schema",
"type": "integer"
},
"minLength": {
"$id": "#/properties/control/properties/environment/properties/minLength",
"default": 0,
"description": "An explanation about the purpose of this instance.",
"examples": [
3
],
"title": "The minLength schema",
"type": "integer"
},
"regex": {
"$id": "#/properties/control/properties/environment/properties/regex",
"default": "",
"description": "An explanation about the purpose of this instance.",
"examples": [
"^[a-zA-Z][0-9]{2}$"
],
"title": "The regex schema",
"type": "string"
},
"type": {
"$id": "#/properties/control/properties/environment/properties/type",
"default": "",
"description": "An explanation about the purpose of this instance.",
"examples": [
"string"
],
"title": "The type schema",
"type": "string"
}
},
"required": [
"description",
"type",
"minLength",
"maxLength",
"regex"
],
"title": "The environment schema",
"type": "object"
},
"instance": {
"$id": "#/properties/control/properties/instance",
"additionalProperties": true,
"default": {},
"description": "An explanation about the purpose of this instance.",
"examples": [
{
"description": "Instance number",
"maxValue": 99,
"minValue": 1,
"type": "int"
}
],
"properties": {
"description": {
"$id": "#/properties/control/properties/instance/properties/description",
"default": "",
"description": "An explanation about the purpose of this instance.",
"examples": [
"Instance number"
],
"title": "The description schema",
"type": "string"
},
"maxValue": {
"$id": "#/properties/control/properties/instance/properties/maxValue",
"default": 0,
"description": "An explanation about the purpose of this instance.",
"examples": [
99
],
"title": "The maxValue schema",
"type": "integer"
},
"minValue": {
"$id": "#/properties/control/properties/instance/properties/minValue",
"default": 0,
"description": "An explanation about the purpose of this instance.",
"examples": [
1
],
"title": "The minValue schema",
"type": "integer"
},
"type": {
"$id": "#/properties/control/properties/instance/properties/type",
"default": "",
"description": "An explanation about the purpose of this instance.",
"examples": [
"int"
],
"title": "The type schema",
"type": "string"
}
},
"required": [
"description",
"type",
"minValue",
"maxValue"
],
"title": "The instance schema",
"type": "object"
},
"location": {
"$id": "#/properties/control/properties/appIdentifier",
"additionalProperties": true,
"default": {},
"description": "An explanation about the purpose of this instance.",
"examples": [
{
"description": "Location or Region of the public cloud provider",
"maxLength": 5,
"minLength": 2,
"type": "string"
}
],
"properties": {
"description": {
"$id": "#/properties/control/properties/appIdentifier/properties/description",
"default": "",
"description": "An explanation about the purpose of this instance.",
"examples": [
"Location or Region of the public cloud provider"
],
"title": "The description schema",
"type": "string"
},
"maxLength": {
"$id": "#/properties/control/properties/appIdentifier/properties/maxLength",
"default": 0,
"description": "An explanation about the purpose of this instance.",
"examples": [
5
],
"title": "The maxLength schema",
"type": "integer"
},
"minLength": {
"$id": "#/properties/control/properties/appIdentifier/properties/minLength",
"default": 0,
"description": "An explanation about the purpose of this instance.",
"examples": [
2
],
"title": "The minLength schema",
"type": "integer"
},
"type": {
"$id": "#/properties/control/properties/appIdentifier/properties/type",
"default": "",
"description": "An explanation about the purpose of this instance.",
"examples": [
"string"
],
"title": "The type schema",
"type": "string"
}
},
"required": [
"description",
"type",
"minLength",
"maxLength"
],
"title": "The appIdentifier schema",
"type": "object"
},
"resourceType": {
"$id": "#/properties/control/properties/resourceType",
"additionalProperties": true,
"default": {},
"description": "An explanation about the purpose of this instance.",
"examples": [
{
"description": "Resource type.",
"maxLength": 5,
"minLength": 2,
"type": "string"
}
],
"properties": {
"description": {
"$id": "#/properties/control/properties/resourceType/properties/description",
"default": "",
"description": "An explanation about the purpose of this instance.",
"examples": [
"Resource type."
],
"title": "The description schema",
"type": "string"
},
"maxLength": {
"$id": "#/properties/control/properties/resourceType/properties/maxLength",
"default": 0,
"description": "An explanation about the purpose of this instance.",
"examples": [
5
],
"title": "The maxLength schema",
"type": "integer"
},
"minLength": {
"$id": "#/properties/control/properties/resourceType/properties/minLength",
"default": 0,
"description": "An explanation about the purpose of this instance.",
"examples": [
2
],
"title": "The minLength schema",
"type": "integer"
},
"type": {
"$id": "#/properties/control/properties/resourceType/properties/type",
"default": "",
"description": "An explanation about the purpose of this instance.",
"examples": [
"string"
],
"title": "The type schema",
"type": "string"
}
},
"required": [
"description",
"type",
"minLength",
"maxLength"
],
"title": "The resourceType schema",
"type": "object"
},
"workloadType": {
"$id": "#/properties/control/properties/workloadType",
"additionalProperties": true,
"default": {},
"description": "An explanation about the purpose of this instance.",
"examples": [
{
"description": "Workload type.",
"maxLength": 3,
"minLength": 3,
"type": "string"
}
],
"properties": {
"description": {
"$id": "#/properties/control/properties/workloadType/properties/description",
"default": "",
"description": "An explanation about the purpose of this instance.",
"examples": [
"Workload type."
],
"title": "The description schema",
"type": "string"
},
"maxLength": {
"$id": "#/properties/control/properties/workloadType/properties/maxLength",
"default": 0,
"description": "An explanation about the purpose of this instance.",
"examples": [
3
],
"title": "The maxLength schema",
"type": "integer"
},
"minLength": {
"$id": "#/properties/control/properties/workloadType/properties/minLength",
"default": 0,
"description": "An explanation about the purpose of this instance.",
"examples": [
3
],
"title": "The minLength schema",
"type": "integer"
},
"type": {
"$id": "#/properties/control/properties/workloadType/properties/type",
"default": "",
"description": "An explanation about the purpose of this instance.",
"examples": [
"string"
],
"title": "The type schema",
"type": "string"
}
},
"required": [
"description",
"type",
"minLength",
"maxLength"
],
"title": "The workloadType schema",
"type": "object"
}
},
"required": [
"cloud",
"company",
"resourceType",
"environment",
"location",
"appIdentifier",
"associatedResourceType",
"associatedResourceName",
"workloadType",
"instance"
],
"title": "The control schema",
"type": "object"
}
},
"required": [
"control",
"allowedValues"
],
"title": "The root schema",
"type": "object"
} | MIT | en |
splunk/vscode-extension-splunk-soar | b02a56e8f05371bbeb05b7ea60d821e7924df38c | 2022-10-18T13:18:18 | schemas/splunk_phantom_app-1.0.json | 11 | 2024-05-27T05:25:53.655762Z | {
"$schema": "https://json-schema.org/draft-04/schema",
"properties": {
"actions": {
"items": {
"properties": {
"action": {
"type": "string"
},
"description": {
"type": "string"
},
"identifier": {
"type": "string"
},
"lock": {
"properties": {
"data_path": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"timeout": {
"type": "number"
}
},
"required": [
"enabled"
],
"type": "object"
},
"output": {
"items": {
"properties": {
"column_name": {
"type": "string"
},
"column_order": {
"type": [
"integer",
"string"
]
},
"contains": {
"items": {
"type": "string"
},
"type": "array"
},
"data_path": {
"type": "string"
},
"data_type": {
"enum": [
"string",
"numeric",
"boolean",
"password",
"file"
],
"type": "string"
},
"example_values": {
"type": "array"
},
"map_info": {
"type": "string"
}
},
"required": [
"data_path",
"data_type"
],
"type": "object"
},
"type": "array"
},
"parameters": {
"additionalProperties": {
"properties": {
"allow_list": {
"type": "boolean"
},
"data_type": {
"enum": [
"string",
"numeric",
"boolean"
],
"type": "string"
},
"default": {
"type": [
"string",
"number",
"boolean"
]
},
"description": {
"type": "string"
},
"order": {
"type": "number"
},
"primary": {
"type": "boolean"
},
"required": {
"type": "boolean"
},
"value_list": {
"type": "array"
}
},
"required": [
"data_type"
],
"type": "object"
},
"type": "object"
},
"read_only": {
"type": "boolean"
},
"render": {
"properties": {
"height": {
"type": "number"
},
"menu_name": {
"type": "string"
},
"title": {
"type": "string"
},
"type": {
"enum": [
"table",
"map",
"custom"
],
"type": "string"
},
"view": {
"type": "string"
},
"width": {
"type": "number"
}
},
"required": [
"type"
],
"type": "object"
},
"type": {
"type": "string"
},
"undo": {
"type": "string"
},
"verbose": {
"type": "string"
},
"versions": {
"type": "string"
}
},
"required": [
"action",
"description",
"identifier",
"output",
"parameters",
"read_only",
"type",
"versions"
],
"type": "object"
},
"type": "array"
},
"app_version": {
"type": "string"
},
"app_wizard_version": {
"type": "string"
},
"appid": {
"type": "string"
},
"configuration": {
"additionalProperties": {
"properties": {
"allow_list": {
"type": "boolean"
},
"data_type": {
"enum": [
"string",
"numeric",
"boolean",
"password",
"file"
],
"type": "string"
},
"default": {
"type": [
"string",
"number",
"boolean"
]
},
"description": {
"type": "string"
},
"order": {
"type": "number"
},
"value_list": {
"type": "array"
}
},
"required": [
"data_type"
],
"type": "object"
},
"type": "object"
},
"consolidate_widgets": {
"type": "boolean"
},
"description": {
"type": "string"
},
"license": {
"type": "string"
},
"logo": {
"type": "string"
},
"logo_dark": {
"type": "string"
},
"main_module": {
"type": "string"
},
"min_phantom_version": {
"type": "string"
},
"name": {
"type": "string"
},
"package_name": {
"type": "string"
},
"pip3_dependencies": {
"properties": {
"pypi": {
"items": {
"properties": {
"module": {
"type": "string"
}
},
"required": [
"module"
],
"type": "object"
},
"type": "array"
},
"wheel": {
"items": {
"properties": {
"input_file": {
"type": "string"
},
"module": {
"type": "string"
}
},
"required": [
"module",
"input_file"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"pip_dependencies": {
"properties": {
"pypi": {
"items": {
"properties": {
"module": {
"type": "string"
}
},
"required": [
"module"
],
"type": "object"
},
"type": "array"
},
"wheel": {
"items": {
"properties": {
"input_file": {
"type": "string"
},
"module": {
"type": "string"
}
},
"required": [
"module",
"input_file"
],
"type": "object"
},
"type": "array"
}
},
"required": [],
"type": "object"
},
"product_name": {
"type": "string"
},
"product_vendor": {
"type": "string"
},
"product_version_regex": {
"type": "string"
},
"publisher": {
"type": "string"
},
"python_version": {
"type": "string"
},
"rest_handler": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"utctime_updated": {
"type": "string"
}
},
"required": [
"actions",
"app_version",
"appid",
"configuration",
"description",
"license",
"main_module",
"name",
"package_name",
"product_name",
"product_vendor",
"product_version_regex",
"publisher",
"type"
],
"type": "object"
} | Apache-2.0 | en |
splunk/vscode-extension-splunk-soar | cb450ae8233bdc1797deb83009f22c481200cf02 | 2022-04-07T08:47:28 | schemas/splunk_phantom_app-1.0.json | 11 | 2024-05-27T05:25:53.655762Z | {
"$schema": "https://json-schema.org/draft-04/schema",
"properties": {
"actions": {
"items": {
"properties": {
"action": {
"type": "string"
},
"description": {
"type": "string"
},
"identifier": {
"type": "string"
},
"lock": {
"properties": {
"data_path": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"timeout": {
"type": "number"
}
},
"required": [
"enabled"
],
"type": "object"
},
"output": {
"items": {
"properties": {
"column_name": {
"type": "string"
},
"column_order": {
"type": [
"integer",
"string"
]
},
"contains": {
"items": {
"type": "string"
},
"type": "array"
},
"data_path": {
"type": "string"
},
"data_type": {
"type": "string"
},
"example_values": {
"type": "array"
},
"map_info": {
"type": "string"
}
},
"required": [
"data_path",
"data_type"
],
"type": "object"
},
"type": "array"
},
"parameters": {
"additionalProperties": {
"properties": {
"allow_list": {
"type": "boolean"
},
"data_type": {
"type": "string"
},
"default": {
"type": [
"string",
"number",
"boolean"
]
},
"description": {
"type": "string"
},
"order": {
"type": "number"
},
"primary": {
"type": "boolean"
},
"required": {
"type": "boolean"
},
"value_list": {
"type": "array"
}
},
"required": [
"data_type"
],
"type": "object"
},
"type": "object"
},
"read_only": {
"type": "boolean"
},
"render": {
"properties": {
"height": {
"type": "number"
},
"menu_name": {
"type": "string"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"view": {
"type": "string"
},
"width": {
"type": "number"
}
},
"required": [
"type"
],
"type": "object"
},
"type": {
"type": "string"
},
"undo": {
"type": "string"
},
"verbose": {
"type": "string"
},
"versions": {
"type": "string"
}
},
"required": [
"action",
"description",
"identifier",
"output",
"parameters",
"read_only",
"type",
"versions"
],
"type": "object"
},
"type": "array"
},
"app_version": {
"type": "string"
},
"app_wizard_version": {
"type": "string"
},
"appid": {
"type": "string"
},
"configuration": {
"additionalProperties": {
"properties": {
"allow_list": {
"type": "boolean"
},
"data_type": {
"type": "string"
},
"default": {
"type": [
"string",
"number",
"boolean"
]
},
"description": {
"type": "string"
},
"order": {
"type": "number"
},
"value_list": {
"type": "array"
}
},
"required": [
"data_type"
],
"type": "object"
},
"type": "object"
},
"consolidate_widgets": {
"type": "boolean"
},
"description": {
"type": "string"
},
"license": {
"type": "string"
},
"logo": {
"type": "string"
},
"logo_dark": {
"type": "string"
},
"main_module": {
"type": "string"
},
"min_phantom_version": {
"type": "string"
},
"name": {
"type": "string"
},
"package_name": {
"type": "string"
},
"pip3_dependencies": {
"properties": {
"pypi": {
"items": {
"properties": {
"module": {
"type": "string"
}
},
"required": [
"module"
],
"type": "object"
},
"type": "array"
},
"wheel": {
"items": {
"properties": {
"input_file": {
"type": "string"
},
"module": {
"type": "string"
}
},
"required": [
"module",
"input_file"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"pip_dependencies": {
"properties": {
"pypi": {
"items": {
"properties": {
"module": {
"type": "string"
}
},
"required": [
"module"
],
"type": "object"
},
"type": "array"
},
"wheel": {
"items": {
"properties": {
"input_file": {
"type": "string"
},
"module": {
"type": "string"
}
},
"required": [
"module",
"input_file"
],
"type": "object"
},
"type": "array"
}
},
"required": [],
"type": "object"
},
"product_name": {
"type": "string"
},
"product_vendor": {
"type": "string"
},
"product_version_regex": {
"type": "string"
},
"publisher": {
"type": "string"
},
"python_version": {
"type": "string"
},
"rest_handler": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"utctime_updated": {
"type": "string"
}
},
"required": [
"actions",
"app_version",
"appid",
"configuration",
"description",
"license",
"main_module",
"name",
"package_name",
"product_name",
"product_vendor",
"product_version_regex",
"publisher",
"type"
],
"type": "object"
} | Apache-2.0 | en |
splunk/vscode-extension-splunk-soar | 9a182d9a138a3b58eb1f890e564b817089331f10 | 2022-10-18T13:15:18 | schemas/splunk_phantom_app-1.0.json | 11 | 2024-05-27T05:25:53.655762Z | {
"$schema": "https://json-schema.org/draft-04/schema",
"properties": {
"actions": {
"items": {
"properties": {
"action": {
"type": "string"
},
"description": {
"type": "string"
},
"identifier": {
"type": "string"
},
"lock": {
"properties": {
"data_path": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"timeout": {
"type": "number"
}
},
"required": [
"enabled"
],
"type": "object"
},
"output": {
"items": {
"properties": {
"column_name": {
"type": "string"
},
"column_order": {
"type": [
"integer",
"string"
]
},
"contains": {
"items": {
"type": "string"
},
"type": "array"
},
"data_path": {
"type": "string"
},
"data_type": {
"enum": [
"string",
"numeric",
"boolean",
"password",
"file"
],
"type": "string"
},
"example_values": {
"type": "array"
},
"map_info": {
"type": "string"
}
},
"required": [
"data_path",
"data_type"
],
"type": "object"
},
"type": "array"
},
"parameters": {
"additionalProperties": {
"properties": {
"allow_list": {
"type": "boolean"
},
"data_type": {
"enum": [
"string",
"numeric",
"boolean"
],
"type": "string"
},
"default": {
"type": [
"string",
"number",
"boolean"
]
},
"description": {
"type": "string"
},
"order": {
"type": "number"
},
"primary": {
"type": "boolean"
},
"required": {
"type": "boolean"
},
"value_list": {
"type": "array"
}
},
"required": [
"data_type"
],
"type": "object"
},
"type": "object"
},
"read_only": {
"type": "boolean"
},
"render": {
"properties": {
"height": {
"type": "number"
},
"menu_name": {
"type": "string"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"view": {
"type": "string"
},
"width": {
"type": "number"
}
},
"required": [
"type"
],
"type": "object"
},
"type": {
"type": "string"
},
"undo": {
"type": "string"
},
"verbose": {
"type": "string"
},
"versions": {
"type": "string"
}
},
"required": [
"action",
"description",
"identifier",
"output",
"parameters",
"read_only",
"type",
"versions"
],
"type": "object"
},
"type": "array"
},
"app_version": {
"type": "string"
},
"app_wizard_version": {
"type": "string"
},
"appid": {
"type": "string"
},
"configuration": {
"additionalProperties": {
"properties": {
"allow_list": {
"type": "boolean"
},
"data_type": {
"enum": [
"string",
"numeric",
"boolean",
"password",
"file"
],
"type": "string"
},
"default": {
"type": [
"string",
"number",
"boolean"
]
},
"description": {
"type": "string"
},
"order": {
"type": "number"
},
"value_list": {
"type": "array"
}
},
"required": [
"data_type"
],
"type": "object"
},
"type": "object"
},
"consolidate_widgets": {
"type": "boolean"
},
"description": {
"type": "string"
},
"license": {
"type": "string"
},
"logo": {
"type": "string"
},
"logo_dark": {
"type": "string"
},
"main_module": {
"type": "string"
},
"min_phantom_version": {
"type": "string"
},
"name": {
"type": "string"
},
"package_name": {
"type": "string"
},
"pip3_dependencies": {
"properties": {
"pypi": {
"items": {
"properties": {
"module": {
"type": "string"
}
},
"required": [
"module"
],
"type": "object"
},
"type": "array"
},
"wheel": {
"items": {
"properties": {
"input_file": {
"type": "string"
},
"module": {
"type": "string"
}
},
"required": [
"module",
"input_file"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"pip_dependencies": {
"properties": {
"pypi": {
"items": {
"properties": {
"module": {
"type": "string"
}
},
"required": [
"module"
],
"type": "object"
},
"type": "array"
},
"wheel": {
"items": {
"properties": {
"input_file": {
"type": "string"
},
"module": {
"type": "string"
}
},
"required": [
"module",
"input_file"
],
"type": "object"
},
"type": "array"
}
},
"required": [],
"type": "object"
},
"product_name": {
"type": "string"
},
"product_vendor": {
"type": "string"
},
"product_version_regex": {
"type": "string"
},
"publisher": {
"type": "string"
},
"python_version": {
"type": "string"
},
"rest_handler": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"utctime_updated": {
"type": "string"
}
},
"required": [
"actions",
"app_version",
"appid",
"configuration",
"description",
"license",
"main_module",
"name",
"package_name",
"product_name",
"product_vendor",
"product_version_regex",
"publisher",
"type"
],
"type": "object"
} | Apache-2.0 | en |
spacemeshos/go-spacemesh | ee9b3c08900a36a9492e7a589286a70d5eb641fc | 2023-06-05T22:12:38 | bootstrap/schema.json | 741 | 2024-05-28T06:13:18.100215Z | {
"$id": "https://spacemesh.io/bootstrap.schema.json.1.0",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "epoch data for bootstrapping and fallback",
"properties": {
"data": {
"properties": {
"epoch": {
"properties": {
"activeSet": {
"description": "the set of ATXs for hare protocol in this epoch",
"items": {
"type": "string"
},
"type": [
"array",
"null"
],
"uniqueItems": true
},
"beacon": {
"description": "the random beacon value for this epoch",
"minLength": 8,
"type": "string"
},
"number": {
"description": "epoch number",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
},
"required": [
"epoch"
],
"type": "object"
},
"version": {
"description": "version of the checkpoint file. should be compatible schema's $id",
"type": "string"
}
},
"required": [
"version",
"data"
],
"title": "epoch data",
"type": "object"
} | MIT | en |
spacemeshos/go-spacemesh | a04a2085344c71bdcc7a625db9901b213474933f | 2023-03-27T22:26:22 | bootstrap/schema.json | 741 | 2024-05-28T06:13:18.100215Z | {
"$id": "https://spacemesh.io/checkpoint.schema.json.1.0",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "epoch data for bootstrapping and fallback",
"properties": {
"data": {
"properties": {
"epochs": {
"items": {
"properties": {
"activeSet": {
"description": "the set of ATXs for hare protocol in this epoch",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"beacon": {
"description": "the random beacon value for this epoch",
"minLength": 8,
"type": "string"
},
"epoch": {
"description": "epoch number",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"id": {
"exclusiveMinimum": 0,
"type": "integer"
}
},
"required": [
"id",
"epochs"
],
"type": "object"
},
"version": {
"description": "version of the checkpoint file. should be compatible schema's $id",
"type": "string"
}
},
"required": [
"version",
"data"
],
"title": "epoch data",
"type": "object"
} | MIT | en |
spacemeshos/go-spacemesh | 4625a43b00e29d1ed8fcef467c8f35c58c106e83 | 2023-05-12T20:41:28 | checkpoint/schema.json | 741 | 2024-05-28T06:13:18.100215Z | {
"$id": "https://spacemesh.io/checkpoint.schema.json.1.0",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "checkpoint data for recovery",
"properties": {
"data": {
"properties": {
"atxs": {
"accounts": {
"description": "accounts snapshot",
"items": {
"properties": {
"address": {
"type": "string"
},
"balance": {
"type": "integer"
},
"nonce": {
"type": "integer"
},
"state": {
"type": "string"
},
"template": {
"type": "string"
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"description": "the set of golden ATXs",
"items": {
"properties": {
"baseTickHeight": {
"type": "integer"
},
"coinbase": {
"type": "string"
},
"commitmentAtx": {
"type": "string"
},
"epoch": {
"type": "integer"
},
"id": {
"description": "atx id",
"type": "string"
},
"numUnits": {
"type": "integer"
},
"publicKey": {
"type": "string"
},
"sequence": {
"type": "integer"
},
"tickCount": {
"type": "integer"
},
"vrfNonce": {
"type": "integer"
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"id": {
"type": "string"
},
"restore": {
"description": "the layer to restore the mesh with checkpoint data",
"exclusiveMinimum": 0,
"type": "integer"
}
},
"required": [
"id",
"restore",
"atxs",
"accounts"
],
"type": "object"
},
"version": {
"description": "version of the checkpoint file. same as schema's $id",
"type": "string"
}
},
"required": [
"version",
"data"
],
"title": "checkpoint data",
"type": "object"
} | MIT | en |
spacemeshos/go-spacemesh | 9cb2c3cd26c5fee242e1c25dbd089c7d8577e67d | 2023-05-28T06:30:32 | checkpoint/schema.json | 741 | 2024-05-28T06:13:18.100215Z | {
"$id": "https://spacemesh.io/checkpoint.schema.json.1.0",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "checkpoint data for recovery",
"properties": {
"data": {
"properties": {
"atxs": {
"accounts": {
"description": "accounts snapshot",
"items": {
"properties": {
"address": {
"type": "string"
},
"balance": {
"type": "integer"
},
"nonce": {
"type": "integer"
},
"state": {
"type": "string"
},
"template": {
"type": "string"
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"description": "the set of golden ATXs",
"items": {
"properties": {
"baseTickHeight": {
"type": "integer"
},
"coinbase": {
"type": "string"
},
"commitmentAtx": {
"type": "string"
},
"epoch": {
"type": "integer"
},
"id": {
"description": "atx id",
"type": "string"
},
"numUnits": {
"type": "integer"
},
"publicKey": {
"type": "string"
},
"sequence": {
"type": "integer"
},
"tickCount": {
"type": "integer"
},
"vrfNonce": {
"type": "integer"
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"id": {
"type": "string"
}
},
"required": [
"id",
"atxs",
"accounts"
],
"type": "object"
},
"version": {
"description": "version of the checkpoint file. same as schema's $id",
"type": "string"
}
},
"required": [
"version",
"data"
],
"title": "checkpoint data",
"type": "object"
} | MIT | en |
spacemeshos/go-spacemesh | c30532dbe951a669422f74807cccea78f3d86c64 | 2023-04-11T03:14:42 | bootstrap/schema.json | 741 | 2024-05-28T06:13:18.100215Z | {
"$id": "https://spacemesh.io/checkpoint.schema.json.1.0",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "epoch data for bootstrapping and fallback",
"properties": {
"data": {
"properties": {
"epoch": {
"properties": {
"activeSet": {
"description": "the set of ATXs for hare protocol in this epoch",
"items": {
"type": "string"
},
"type": [
"array",
"null"
],
"uniqueItems": true
},
"beacon": {
"description": "the random beacon value for this epoch",
"minLength": 8,
"type": "string"
},
"number": {
"description": "epoch number",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"id": {
"exclusiveMinimum": 0,
"type": "integer"
}
},
"required": [
"id",
"epoch"
],
"type": "object"
},
"version": {
"description": "version of the checkpoint file. should be compatible schema's $id",
"type": "string"
}
},
"required": [
"version",
"data"
],
"title": "epoch data",
"type": "object"
} | MIT | en |
spacemeshos/go-spacemesh | a867b825be83cc59a8ad52ed35b82663073d8bac | 2023-05-07T16:34:00 | bootstrap/schema.json | 741 | 2024-05-28T06:13:18.100215Z | {
"$id": "https://spacemesh.io/bootstrap.schema.json.1.0",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "epoch data for bootstrapping and fallback",
"properties": {
"data": {
"properties": {
"epoch": {
"properties": {
"activeSet": {
"description": "the set of ATXs for hare protocol in this epoch",
"items": {
"type": "string"
},
"type": [
"array",
"null"
],
"uniqueItems": true
},
"beacon": {
"description": "the random beacon value for this epoch",
"minLength": 8,
"type": "string"
},
"number": {
"description": "epoch number",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"id": {
"exclusiveMinimum": 0,
"type": "integer"
}
},
"required": [
"id",
"epoch"
],
"type": "object"
},
"version": {
"description": "version of the checkpoint file. should be compatible schema's $id",
"type": "string"
}
},
"required": [
"version",
"data"
],
"title": "epoch data",
"type": "object"
} | MIT | en |
spacemeshos/go-spacemesh | edda5f23cf7af5a1b830df376b06afde853b7453 | 2023-07-04T21:58:37 | checkpoint/schema.json | 741 | 2024-05-28T06:13:18.100215Z | {
"$id": "https://spacemesh.io/checkpoint.schema.json.1.0",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "checkpoint data for recovery",
"properties": {
"command": {
"description": "command to execute",
"type": "string"
},
"data": {
"properties": {
"atxs": {
"accounts": {
"description": "accounts snapshot",
"items": {
"properties": {
"address": {
"type": "string"
},
"balance": {
"type": "integer"
},
"nonce": {
"type": "integer"
},
"state": {
"type": "string"
},
"template": {
"type": "string"
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"description": "the set of golden ATXs",
"items": {
"properties": {
"baseTickHeight": {
"type": "integer"
},
"coinbase": {
"type": "string"
},
"commitmentAtx": {
"type": "string"
},
"epoch": {
"type": "integer"
},
"id": {
"description": "atx id",
"type": "string"
},
"numUnits": {
"type": "integer"
},
"publicKey": {
"type": "string"
},
"sequence": {
"type": "integer"
},
"tickCount": {
"type": "integer"
},
"vrfNonce": {
"type": "integer"
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"id": {
"type": "string"
}
},
"required": [
"id",
"atxs",
"accounts"
],
"type": "object"
},
"version": {
"description": "version of the checkpoint file. same as schema's $id",
"type": "string"
}
},
"required": [
"command",
"version",
"data"
],
"title": "checkpoint data",
"type": "object"
} | MIT | en |
toedter/spring-hateoas-jsonapi | 14e9a3c5310e7c0c3b4e79a52447b0c1d7bb1d56 | 2022-11-03T16:23:19 | lib/src/test/resources/com/toedter/spring/hateoas/jsonapi/jsonapi-schema.json | 99 | 2024-05-28T05:19:53.313829Z | {
"$id": "https://jsonapi.org/schemas/spec/v1.1/draft",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "#/definitions/requiredTopLevelMembers"
},
{
"$ref": "#/definitions/oneOfDataOrErrors"
}
],
"anyOf": [
{
"$ref": "#/definitions/atMemberName"
}
],
"definitions": {
"atMemberName": {
"description": "@member name may contain any valid JSON value.",
"patternProperties": {
"^@[a-zA-Z0-9]{1}(?:[-\\w]*[a-zA-Z0-9])?$": true
},
"type": "object"
},
"attributes": {
"anyOf": [
{
"$ref": "#/definitions/memberName"
},
{
"$ref": "#/definitions/atMemberName"
}
],
"description": "Members of the attributes object (\"attributes\") represent information about the resource object in which it's defined.",
"not": {
"$comment": "This is what the specification requires, but it seems bad. https://github.com/json-api/json-api/issues/1553",
"anyOf": [
{
"required": [
"type"
]
},
{
"required": [
"id"
]
}
]
},
"type": "object",
"unevaluatedProperties": false
},
"data": {
"description": "The document's \"primary data\" is a representation of the resource or collection of resources targeted by a request.",
"oneOf": [
{
"$ref": "#/definitions/resource"
},
{
"$ref": "#/definitions/resourceCollection",
"description": "An array of resource objects, an array of resource identifier objects, or an empty array ([]), for requests that target resource collections."
},
{
"description": "null if the request is one that might correspond to a single resource, but doesn't currently.",
"type": "null"
}
]
},
"empty": {
"description": "Describes an empty to-one relationship.",
"type": "null"
},
"error": {
"anyOf": [
{
"required": [
"id"
]
},
{
"required": [
"links"
]
},
{
"required": [
"status"
]
},
{
"required": [
"code"
]
},
{
"required": [
"title"
]
},
{
"required": [
"detail"
]
},
{
"required": [
"source"
]
},
{
"required": [
"meta"
]
}
],
"properties": {
"code": {
"description": "An application-specific error code, expressed as a string value.",
"type": "string"
},
"detail": {
"description": "A human-readable explanation specific to this occurrence of the problem.",
"type": "string"
},
"id": {
"description": "A unique identifier for this particular occurrence of the problem.",
"type": "string"
},
"links": {
"$ref": "#/definitions/errorLinks"
},
"meta": {
"$ref": "#/definitions/meta"
},
"source": {
"$ref": "#/definitions/errorSource"
},
"status": {
"description": "The HTTP status code applicable to this problem, expressed as a string value.",
"type": "string"
},
"title": {
"description": "A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization.",
"type": "string"
}
},
"type": "object",
"unevaluatedProperties": false
},
"errorLinks": {
"allOf": [
{
"$ref": "#/definitions/links"
}
],
"anyOf": [
{
"$ref": "#/definitions/atMemberName"
}
],
"description": "The error links object **MAY** contain the following members: about.",
"properties": {
"about": {
"$ref": "#/definitions/link",
"description": "A link that leads to further details about this particular occurrence of the problem."
},
"type": {
"$ref": "#/definitions/link",
"description": "A link that identifies the type of error that this particular error is an instance of."
}
},
"type": "object",
"unevaluatedProperties": false
},
"errorSource": {
"properties": {
"header": {
"description": "A string indicating the name of a single request header which caused the error.",
"type": "string"
},
"parameter": {
"description": "A string indicating which query parameter caused the error.",
"type": "string"
},
"pointer": {
"description": "A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. \"/data\" for a primary data object, or \"/data/attributes/title\" for a specific attribute].",
"pattern": "^(?:\\/(?:[^~/]|~0|~1)*)*$",
"type": "string"
}
},
"type": "object"
},
"errors": {
"items": {
"$ref": "#/definitions/error"
},
"type": "array",
"uniqueItems": true
},
"included": {
"description": "To reduce the number of HTTP requests, servers **MAY** allow responses that include related resources along with the requested primary resources. Such responses are called \"compound documents\".",
"items": {
"$ref": "#/definitions/resource"
},
"type": "array",
"uniqueItems": true
},
"jsonapi": {
"anyOf": [
{
"$ref": "#/definitions/atMemberName"
}
],
"description": "An object describing the server's implementation",
"properties": {
"ext": {
"items": {
"$ref": "#/definitions/linkUrl"
},
"type": "array",
"uniqueItems": true
},
"meta": {
"$ref": "#/definitions/meta"
},
"profile": {
"items": {
"$ref": "#/definitions/linkUrl"
},
"type": "array",
"uniqueItems": true
},
"version": {
"type": "string"
}
},
"type": "object",
"unevaluatedProperties": false
},
"link": {
"description": "A link **MUST** be represented as either: a string containing the link's URL or a link object.",
"oneOf": [
{
"$ref": "#/definitions/linkUrl"
},
{
"$ref": "#/definitions/linkObject"
}
]
},
"linkObject": {
"properties": {
"describedby": {
"$ref": "#/definitions/link"
},
"href": {
"$ref": "#/definitions/linkUrl"
},
"hreflang": {
"type": "string"
},
"meta": {
"$ref": "#/definitions/meta"
},
"rel": {
"type": "string"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href"
],
"type": "object"
},
"linkUrl": {
"$comment": "URI regex as per https://tools.ietf.org/html/rfc3986#appendix-B",
"description": "A string containing the link's URL.",
"format": "uri",
"pattern": "^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?",
"type": "string"
},
"linkage": {
"description": "Resource linkage in a compound document allows a client to link together all of the included resource objects without having to GET any URLs via links.",
"oneOf": [
{
"$ref": "#/definitions/relationshipToOne"
},
{
"$ref": "#/definitions/relationshipToMany"
}
]
},
"links": {
"type": "object"
},
"memberName": {
"description": "Member name may contain any valid JSON value.",
"patternProperties": {
"^[a-zA-Z0-9]{1}(?:[-\\w]*[a-zA-Z0-9])?$": true
},
"type": "object"
},
"meta": {
"anyOf": [
{
"$ref": "#/definitions/memberName"
},
{
"$ref": "#/definitions/atMemberName"
}
],
"description": "Non-standard meta-information that can not be represented as an attribute or relationship.",
"type": "object",
"unevaluatedProperties": true
},
"oneOfDataOrErrors": {
"dependentSchemas": {
"data": {
"not": {
"required": [
"errors"
]
}
}
},
"type": "object"
},
"pagination": {
"properties": {
"first": {
"description": "The first page of data",
"oneOf": [
{
"$ref": "#/definitions/link"
},
{
"type": "null"
}
]
},
"last": {
"description": "The last page of data",
"oneOf": [
{
"$ref": "#/definitions/link"
},
{
"type": "null"
}
]
},
"next": {
"description": "The next page of data",
"oneOf": [
{
"$ref": "#/definitions/link"
},
{
"type": "null"
}
]
},
"prev": {
"description": "The previous page of data",
"oneOf": [
{
"$ref": "#/definitions/link"
},
{
"type": "null"
}
]
}
},
"type": "object"
},
"relationship": {
"allOf": [
{
"anyOf": [
{
"required": [
"data"
]
},
{
"required": [
"meta"
]
},
{
"required": [
"links"
]
}
]
}
],
"anyOf": [
{
"$ref": "#/definitions/atMemberName"
}
],
"properties": {
"data": {
"$ref": "#/definitions/linkage"
},
"links": {
"$ref": "#/definitions/relationshipLinks"
},
"meta": {
"$ref": "#/definitions/meta"
}
},
"type": "object",
"unevaluatedProperties": false
},
"relationshipFromRequest": {
"anyOf": [
{
"$ref": "#/definitions/atMemberName"
}
],
"properties": {
"data": {
"$ref": "#/definitions/linkage"
},
"meta": {
"$ref": "#/definitions/meta"
}
},
"required": [
"data"
],
"type": "object",
"unevaluatedProperties": false
},
"relationshipLinks": {
"allOf": [
{
"$ref": "#/definitions/links"
}
],
"anyOf": [
{
"$ref": "#/definitions/pagination",
"description": "Pagination links for the relationship data."
},
{
"$ref": "#/definitions/atMemberName"
}
],
"description": "A resource object **MAY** contain references to other resource objects (\"relationships\"). Relationships may be to-one or to-many. Relationships can be specified by including a member in a resource's links object.",
"properties": {
"related": {
"$ref": "#/definitions/link"
},
"self": {
"$ref": "#/definitions/link",
"description": "A `self` member, whose value is a URL for the relationship itself (a \"relationship URL\"). This URL allows the client to directly manipulate the relationship. For example, it would allow a client to remove an `author` from an `article` without deleting the people resource itself."
}
},
"type": "object",
"unevaluatedProperties": false
},
"relationshipToMany": {
"description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.",
"items": {
"$ref": "#/definitions/resourceIdentifier"
},
"type": "array",
"uniqueItems": true
},
"relationshipToOne": {
"description": "References to other resource objects in a to-one (\"relationship\"). Relationships can be specified by including a member in a resource's links object.",
"oneOf": [
{
"$ref": "#/definitions/empty"
},
{
"$ref": "#/definitions/resourceIdentifier"
}
]
},
"relationships": {
"allOf": [
{
"$ref": "#/definitions/relationshipsForbiddenMemberName"
}
],
"anyOf": [
{
"$ref": "#/definitions/atMemberName"
}
],
"description": "Members of the relationships object (\"relationships\") represent references from the resource object in which it's defined to other resource objects.",
"patternProperties": {
"^[a-zA-Z0-9]{1}(?:[-\\w]*[a-zA-Z0-9])?$": {
"$ref": "#/definitions/relationship"
}
},
"type": "object",
"unevaluatedProperties": false
},
"relationshipsForbiddenMemberName": {
"not": {
"anyOf": [
{
"required": [
"type"
],
"type": "object"
},
{
"required": [
"id"
],
"type": "object"
}
]
}
},
"relationshipsFromRequest": {
"allOf": [
{
"$ref": "#/definitions/relationshipsForbiddenMemberName"
}
],
"anyOf": [
{
"$ref": "#/definitions/atMemberName"
}
],
"description": "Members of the relationships object (\"relationships\") represent references from the resource object in which it's defined to other resource objects.",
"patternProperties": {
"^[a-zA-Z0-9]{1}(?:[-\\w]*[a-zA-Z0-9])?$": {
"$ref": "#/definitions/relationshipFromRequest"
}
},
"type": "object",
"unevaluatedProperties": false
},
"requiredTopLevelMembers": {
"anyOf": [
{
"required": [
"meta"
],
"type": "object"
},
{
"required": [
"data"
],
"type": "object"
},
{
"required": [
"errors"
],
"type": "object"
}
]
},
"resource": {
"$comment": "The id member is not required when the resource object originates at the client and represents a new resource to be created on the server.",
"allOf": [
{
"$ref": "#/definitions/resourceIdentification"
}
],
"description": "\"Resource objects\" appear in a JSON:API document to represent resources.",
"properties": {
"attributes": {
"$ref": "#/definitions/attributes"
},
"links": {
"$ref": "#/definitions/resourceLinks"
},
"meta": {
"$ref": "#/definitions/meta"
},
"relationships": {
"$ref": "#/definitions/relationships"
}
},
"type": "object",
"unevaluatedProperties": false
},
"resourceCollection": {
"description": "An array of resource objects.",
"items": {
"$ref": "#/definitions/resource"
},
"type": "array",
"uniqueItems": true
},
"resourceIdentification": {
"allOf": [
{
"$ref": "#/definitions/resourceIdentificationNew"
},
{
"required": [
"type",
"id"
],
"type": "object"
},
{
"not": {
"required": [
"lid"
],
"type": "object"
}
}
]
},
"resourceIdentificationNew": {
"$comment": "The id member is not required when the resource object originates at the client and represents a new resource to be created on the server.",
"anyOf": [
{
"$ref": "#/definitions/atMemberName"
}
],
"properties": {
"id": {
"type": "string"
},
"lid": {
"type": "string"
},
"type": {
"pattern": "^[a-zA-Z0-9]{1}(?:[-\\w]*[a-zA-Z0-9])?$",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"resourceIdentifier": {
"allOf": [
{
"$ref": "#/definitions/resourceIdentificationNew"
},
{
"required": [
"type"
]
},
{
"oneOf": [
{
"required": [
"id"
]
},
{
"required": [
"lid"
]
}
]
}
],
"description": "A \"resource identifier object\" is an object that identifies an individual resource.",
"properties": {
"meta": {
"$ref": "#/definitions/meta"
}
},
"type": "object",
"unevaluatedProperties": false
},
"resourceLinks": {
"allOf": [
{
"$ref": "#/definitions/links"
}
],
"anyOf": [
{
"$ref": "#/definitions/atMemberName"
}
],
"description": "The top-level links object **MAY** contain the following members: self, related, pagination links.",
"properties": {
"self": {
"$ref": "#/definitions/link",
"description": ""
}
},
"type": "object",
"unevaluatedProperties": false
},
"topLevelLinks": {
"allOf": [
{
"$ref": "#/definitions/links"
}
],
"anyOf": [
{
"$ref": "#/definitions/pagination",
"description": "Pagination links for the primary data."
},
{
"$ref": "#/definitions/atMemberName"
}
],
"description": "The top-level links object **MAY** contain the following members: self, related, pagination links.",
"properties": {
"describedby": {
"$ref": "#/definitions/link",
"description": "A link to a description document (e.g. OpenAPI or JSON Schema) for the current document."
},
"related": {
"$ref": "#/definitions/link",
"description": "A related resource link when the primary data represents a resource relationship."
},
"self": {
"$ref": "#/definitions/link",
"description": "The link that generated the current response document."
}
},
"type": "object",
"unevaluatedProperties": false
}
},
"dependencies": {
"included": [
"data"
]
},
"description": "This schema only validates RESPONSES from a request.",
"properties": {
"data": {
"$ref": "#/definitions/data"
},
"errors": {
"$ref": "#/definitions/errors"
},
"included": {
"$ref": "#/definitions/included"
},
"jsonapi": {
"$ref": "#/definitions/jsonapi"
},
"links": {
"$ref": "#/definitions/topLevelLinks",
"description": "Link members related to the primary data."
},
"meta": {
"$ref": "#/definitions/meta"
}
},
"title": "JSON:API Schema v1.1",
"type": "object",
"unevaluatedProperties": false
} | Apache-2.0 | en |
mscharhag/blog-examples | 57a6396bcb72f3ba30da60df1f125e89e90cb419 | 2020-07-29T06:47:49 | spring-json-schema/src/main/resources/painting-schema.json | 125 | 2024-05-29T11:41:01.207883Z | {
"$defs": {
"dimension": {
"additionalProperties": true,
"description": "Describes the dimension of a painting in cm",
"properties": {
"height": {
"description": "Height of the product",
"minimum": 1,
"type": "number"
},
"width": {
"description": "Width of the product",
"minimum": 1,
"type": "number"
}
},
"required": [
"width",
"height"
],
"title": "Painting dimension",
"type": "object"
},
"tag": {
"enum": [
"oil",
"watercolor",
"digital",
"famous"
],
"type": "string"
}
},
"$id": "http://my-paintings-api.com/schemas/painting-schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": true,
"description": "Painting information",
"properties": {
"artist": {
"description": "Name of the artist",
"maxLength": 50,
"type": "string"
},
"description": {
"description": "Painting description",
"type": [
"string",
"null"
]
},
"dimension": {
"$ref": "#/$defs/dimension"
},
"name": {
"description": "Painting name",
"type": "string"
},
"tags": {
"items": {
"$ref": "#/$defs/tag"
},
"type": "array"
}
},
"required": [
"name",
"artist",
"dimension",
"description",
"tags"
],
"title": "Painting",
"type": "object"
} | Apache-2.0 | en |
mscharhag/blog-examples | 9078c6523c6bdc73b070e702c25b724cfa5ee51f | 2020-07-21T14:45:13 | json-schema-validation/src/main/resources/example-schema.json | 125 | 2024-05-29T11:41:01.207883Z | {
"$defs": {
"dimension": {
"additionalProperties": true,
"description": "Describes the dimension of a painting in cm",
"properties": {
"height": {
"description": "Height of the product",
"minimum": 1,
"type": "number"
},
"width": {
"description": "Width of the product",
"minimum": 1,
"type": "number"
}
},
"required": [
"width",
"height"
],
"title": "Painting dimension",
"type": "object"
},
"tag": {
"enum": [
"oil",
"watercolor",
"digital",
"famous"
],
"type": "string"
}
},
"$id": "http://my-paintings-api.com/schemas/painting-schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": true,
"description": "Painting information",
"properties": {
"artist": {
"description": "Name of the artist",
"maxLength": 50,
"type": "string"
},
"description": {
"description": "Painting description",
"type": [
"string",
"null"
]
},
"dimension": {
"$ref": "#/$defs/dimension"
},
"name": {
"description": "Painting name",
"type": "string"
},
"tags": {
"items": {
"$ref": "#/$defs/tag"
},
"type": "array"
}
},
"required": [
"name",
"artist",
"dimension",
"description",
"tags"
],
"title": "Painting",
"type": "object"
} | Apache-2.0 | en |
grafana/grafana-plugin-sdk-go | 757e917dee73e80850b7ed5694127402444b39b5 | 2024-05-20T09:47:26 | experimental/apis/data/v0alpha1/query.schema.json | 192 | 2024-05-29T15:38:44.925573Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"additionalProperties": true,
"description": "Generic query properties",
"properties": {
"datasource": {
"additionalProperties": false,
"description": "The datasource",
"properties": {
"apiVersion": {
"description": "The apiserver version",
"type": "string"
},
"type": {
"description": "The datasource plugin type",
"type": "string"
},
"uid": {
"description": "Datasource UID (NOTE: name in k8s)",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"hide": {
"description": "true if query is disabled (ie should not be returned to the dashboard)\nNOTE: this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)",
"type": "boolean"
},
"intervalMs": {
"description": "Interval is the suggested duration between time points in a time series query.\nNOTE: the values for intervalMs is not saved in the query model. It is typically calculated\nfrom the interval required to fill a pixels in the visualization",
"type": "number"
},
"maxDataPoints": {
"description": "MaxDataPoints is the maximum number of data points that should be returned from a time series query.\nNOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated\nfrom the number of pixels visible in a visualization",
"type": "integer"
},
"queryType": {
"description": "QueryType is an optional identifier for the type of query.\nIt can be used to distinguish different types of queries.",
"type": "string"
},
"refId": {
"description": "RefID is the unique identifier of the query, set by the frontend call.",
"type": "string"
},
"resultAssertions": {
"additionalProperties": false,
"description": "Optionally define expected query result behavior",
"properties": {
"maxFrames": {
"description": "Maximum frame count",
"type": "integer"
},
"type": {
"description": "Type asserts that the frame matches a known type structure.\n\n\nPossible enum values:\n - `\"\"` \n - `\"timeseries-wide\"` \n - `\"timeseries-long\"` \n - `\"timeseries-many\"` \n - `\"timeseries-multi\"` \n - `\"directory-listing\"` \n - `\"table\"` \n - `\"numeric-wide\"` \n - `\"numeric-multi\"` \n - `\"numeric-long\"` \n - `\"log-lines\"` ",
"enum": [
"",
"timeseries-wide",
"timeseries-long",
"timeseries-many",
"timeseries-multi",
"directory-listing",
"table",
"numeric-wide",
"numeric-multi",
"numeric-long",
"log-lines"
],
"type": "string",
"x-enum-description": {}
},
"typeVersion": {
"description": "TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
}
},
"required": [
"typeVersion"
],
"type": "object"
},
"timeRange": {
"additionalProperties": false,
"description": "TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly",
"properties": {
"from": {
"default": "now-6h",
"description": "From is the start time of the query.",
"examples": [
"now-1h"
],
"type": "string"
},
"to": {
"default": "now",
"description": "To is the end time of the query.",
"examples": [
"now"
],
"type": "string"
}
},
"required": [
"from",
"to"
],
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
grafana/grafana-plugin-sdk-go | a8003ef2fa22613b4802f1479dc56532763ca288 | 2024-03-06T15:11:02 | experimental/apis/data/v0alpha1/query.schema.json | 192 | 2024-05-29T15:38:44.925573Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"additionalProperties": true,
"description": "Generic query properties",
"properties": {
"datasource": {
"additionalProperties": false,
"description": "The datasource",
"properties": {
"type": {
"description": "The datasource plugin type",
"type": "string"
},
"uid": {
"description": "Datasource UID",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"hide": {
"description": "true if query is disabled (ie should not be returned to the dashboard)\nNOTE: this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)",
"type": "boolean"
},
"intervalMs": {
"description": "Interval is the suggested duration between time points in a time series query.\nNOTE: the values for intervalMs is not saved in the query model. It is typically calculated\nfrom the interval required to fill a pixels in the visualization",
"type": "number"
},
"maxDataPoints": {
"description": "MaxDataPoints is the maximum number of data points that should be returned from a time series query.\nNOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated\nfrom the number of pixels visible in a visualization",
"type": "integer"
},
"queryType": {
"description": "QueryType is an optional identifier for the type of query.\nIt can be used to distinguish different types of queries.",
"type": "string"
},
"refId": {
"description": "RefID is the unique identifier of the query, set by the frontend call.",
"type": "string"
},
"resultAssertions": {
"additionalProperties": false,
"description": "Optionally define expected query result behavior",
"properties": {
"maxFrames": {
"description": "Maximum frame count",
"type": "integer"
},
"type": {
"description": "Type asserts that the frame matches a known type structure.\n\n\nPossible enum values:\n - `\"\"` \n - `\"timeseries-wide\"` \n - `\"timeseries-long\"` \n - `\"timeseries-many\"` \n - `\"timeseries-multi\"` \n - `\"directory-listing\"` \n - `\"table\"` \n - `\"numeric-wide\"` \n - `\"numeric-multi\"` \n - `\"numeric-long\"` \n - `\"log-lines\"` ",
"enum": [
"",
"timeseries-wide",
"timeseries-long",
"timeseries-many",
"timeseries-multi",
"directory-listing",
"table",
"numeric-wide",
"numeric-multi",
"numeric-long",
"log-lines"
],
"type": "string",
"x-enum-description": {}
},
"typeVersion": {
"description": "TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
}
},
"required": [
"typeVersion"
],
"type": "object"
},
"timeRange": {
"additionalProperties": false,
"description": "TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly",
"properties": {
"from": {
"default": "now-6h",
"description": "From is the start time of the query.",
"examples": [
"now-1h"
],
"type": "string"
},
"to": {
"default": "now",
"description": "To is the end time of the query.",
"examples": [
"now"
],
"type": "string"
}
},
"required": [
"from",
"to"
],
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
grafana/grafana-plugin-sdk-go | a8003ef2fa22613b4802f1479dc56532763ca288 | 2024-03-06T15:11:02 | experimental/apis/data/v0alpha1/query.definition.schema.json | 192 | 2024-05-29T15:38:44.925573Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"properties": {
"changelog": {
"description": "Changelog defines the changed from the previous version\nAll changes in the same version *must* be backwards compatible\nOnly notable changes will be shown here, for the full version history see git!",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"description": "Describe whe the query type is for",
"type": "string"
},
"discriminators": {
"description": "Multiple schemas can be defined using discriminators",
"items": {
"additionalProperties": false,
"properties": {
"field": {
"description": "DiscriminatorField is the field used to link behavior to this specific\nquery type. It is typically \"queryType\", but can be another field if necessary",
"type": "string"
},
"value": {
"description": "The discriminator value",
"type": "string"
}
},
"required": [
"field",
"value"
],
"type": "object"
},
"type": "array"
},
"examples": {
"description": "Examples (include a wrapper) ideally a template!",
"items": {
"additionalProperties": false,
"properties": {
"description": {
"description": "Optionally explain why the example is interesting",
"type": "string"
},
"name": {
"description": "Version identifier or empty if only one exists",
"type": "string"
},
"saveModel": {
"additionalProperties": true,
"description": "An example value saved that can be saved in a dashboard",
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"schema": {
"$ref": "https://json-schema.org/draft-04/schema#",
"description": "The query schema represents the properties that can be sent to the API\nIn many cases, this may be the same properties that are saved in a dashboard\nIn the case where the save model is different, we must also specify a save model",
"type": "object"
}
},
"required": [
"schema",
"examples"
],
"type": "object"
} | Apache-2.0 | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/plugin/src/generators/generator/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxPluginGenerator",
"$schema": "https://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create a Generator for an Nx Plugin.",
"examples": [
{
"command": "nx g generator my-generator --project=my-plugin",
"description": "Generate `libs/my-plugin/src/generators/my-generator`"
}
],
"properties": {
"description": {
"description": "Generator description.",
"type": "string",
"x-priority": "important"
},
"directory": {
"aliases": [
"dir"
],
"description": "The directory at which to create the generator file. When `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. Otherwise, it will be relative to the workspace root.",
"type": "string",
"x-priority": "important"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Generator name.",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use for the generator?"
},
"nameAndDirectoryFormat": {
"description": "Whether to generate the generator in the directory as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The name of the project.",
"type": "string",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v18."
},
"skipFormat": {
"default": false,
"description": "Do not format files with prettier.",
"type": "boolean",
"x-priority": "internal"
},
"skipLintChecks": {
"default": false,
"description": "Do not add an eslint configuration for plugin json files.",
"type": "boolean"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Create a Generator for an Nx Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | ad841c9048b9bf6d509b75a62a4cbbd5c295eb28 | 2023-05-09T13:30:52 | packages/angular/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "SchematicsAngularModuleInit",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Initializes the `@nx/angular` plugin. NOTE: Does not work in the `--dry-run` mode.",
"examples": [
{
"command": "nx g @nx/angular:init --style=scss",
"description": "Installs angular dependencies and initializes the `@nx/angular` plugin with the `scss` stylesheet format."
}
],
"properties": {
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (e2e) tests.",
"enum": [
"cypress",
"none"
],
"type": "string",
"x-priority": "important"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string",
"x-priority": "important"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipInstall": {
"default": false,
"description": "Skip installing after adding `@nx/workspace`.",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"enum": [
"css",
"scss",
"sass",
"less"
],
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "SASS(.sass) [ http://sass-lang.com ]",
"value": "sass"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string",
"x-priority": "important"
}
},
"title": "Init Angular Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | 949466f02ba188c0da8bb5f4abfc6b4e71e4b49c | 2023-10-17T20:33:04 | packages/plugin/src/generators/generator/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxPluginGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create a Generator for an Nx Plugin.",
"examples": [
{
"command": "nx g generator my-generator --project=my-plugin",
"description": "Generate `libs/my-plugin/src/generators/my-generator`"
}
],
"properties": {
"description": {
"description": "Generator description.",
"type": "string",
"x-priority": "important"
},
"directory": {
"aliases": [
"dir"
],
"description": "The directory at which to create the generator file. When `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. Otherwise, it will be relative to the workspace root.",
"type": "string",
"x-priority": "important"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Generator name.",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use for the generator?"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The name of the project.",
"type": "string",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v18."
},
"skipFormat": {
"default": false,
"description": "Do not format files with prettier.",
"type": "boolean",
"x-priority": "internal"
},
"skipLintChecks": {
"default": false,
"description": "Do not add an eslint configuration for plugin json files.",
"type": "boolean"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Create a Generator for an Nx Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | deb0f1a49294eafe18c407a96c95e40af15d3738 | 2024-01-30T21:29:05 | packages/remix/src/generators/action/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "action",
"$schema": "https://json-schema.org/schema",
"description": "Generate an action for a given route.",
"properties": {
"nameAndDirectoryFormat": {
"description": "Whether to generate the action in the directory as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"path": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The route path or path to the filename of the route.",
"type": "string",
"x-prompt": "What is the path of the route? (e.g. 'apps/demo/app/routes/foo/bar.tsx')"
},
"project": {
"description": "The name of the project.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-deprecated": "Provide the `path` option instead and use the `as-provided` format. The project will be determined from the path provided. It will be removed in Nx v19."
}
},
"required": [
"path"
],
"type": "object"
} | MIT | en |
nrwl/nx | 09c6ccb2666f98014a206e23187a2794642a579c | 2022-09-28T15:08:01 | packages/node/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "SchematicsNxNodeApp",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Nx Application Options Schema.",
"properties": {
"babelJest": {
"default": false,
"description": "Use `babel` instead of `ts-jest`.",
"type": "boolean"
},
"directory": {
"description": "The directory of the new application.",
"type": "string"
},
"frontendProject": {
"description": "Frontend project that needs to access this application. This sets up proxy configuration.",
"type": "string"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"type": "string",
"x-prompt": "What name would you like to use for the node application?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case file names.",
"type": "boolean"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
},
"standaloneConfig": {
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean"
},
"tags": {
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [],
"title": "Nx Application Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | 232eaafc21067ee6d5bf5ead2d0fe1dce0db4948 | 2021-12-14T21:00:44 | packages/react/src/generators/component/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactComponent",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"examples": [
{
"command": "g component my-component --project=mylib",
"description": "Generate a component in the mylib library"
},
{
"command": "g component my-component --project=mylib --classComponent",
"description": "Generate a class component in the mylib library"
}
],
"properties": {
"classComponent": {
"alias": "C",
"default": false,
"description": "Use class components instead of functional component.",
"type": "boolean"
},
"directory": {
"alias": "dir",
"description": "Create the component under this directory (can be nested).",
"type": "string"
},
"export": {
"alias": "e",
"default": false,
"description": "When true, the component is exported from the project index.ts (if it exists).",
"type": "boolean",
"x-prompt": "Should this component be exported in the project?"
},
"fileName": {
"description": "Create a component with this file name.",
"type": "string"
},
"flat": {
"default": false,
"description": "Create component at the source root rather than its own directory.",
"type": "boolean"
},
"globalCss": {
"default": false,
"description": "Default is false. When true, the component is generated with *.css/*.scss instead of *.module.css/*.module.scss",
"type": "boolean"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the component.",
"type": "string",
"x-prompt": "What name would you like to use for the component?"
},
"pascalCaseDirectory": {
"alias": "R",
"default": false,
"description": "Use pascal case directory name (e.g. App/App.tsx).",
"type": "boolean"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. App.tsx).",
"type": "boolean"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The name of the project.",
"type": "string",
"x-prompt": "What is the name of the project for this component?"
},
"routing": {
"description": "Generate a library with routes.",
"type": "boolean"
},
"skipTests": {
"default": false,
"description": "When true, does not create \"spec.ts\" test files for the new component.",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "Stylus(.styl) [ http://stylus-lang.com ]",
"value": "styl"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
}
},
"required": [
"name",
"project"
],
"title": "Create a React Component for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/remix/src/generators/style/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxRemixRouteStyle",
"$schema": "https://json-schema.org/schema",
"description": "Generate a style import and file for a given route.",
"examples": [
{
"command": "g style --path='apps/demo/app/routes/path/to/page.tsx'",
"description": "Generate route at apps/demo/app/routes/path/to/page.tsx"
}
],
"properties": {
"nameAndDirectoryFormat": {
"description": "Whether to generate the styles in the path as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"path": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Route path",
"type": "string",
"x-prompt": "What is the path of the route? (e.g. 'apps/demo/app/routes/foo/bar.tsx')"
},
"project": {
"description": "The name of the project.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-deprecated": "Provide the `path` option instead and use the `as-provided` format. The project will be determined from the path provided. It will be removed in Nx v18."
}
},
"required": [
"path"
],
"title": "Add style import to a route",
"type": "object"
} | MIT | en |
nrwl/nx | 6c59cbbb3b31bb03c878a8780e0d025948286cb9 | 2022-11-29T19:49:15 | packages/react/src/generators/host/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "GeneratorReactHost",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create Module Federation configuration files for given React Host Application.",
"properties": {
"classComponent": {
"alias": "C",
"default": false,
"description": "Use class components instead of functional component.",
"type": "boolean"
},
"compiler": {
"default": "babel",
"description": "The compiler to use",
"enum": [
"babel",
"swc"
],
"type": "string"
},
"devServerPort": {
"description": "The port for the dev server of the remote app.",
"type": "number"
},
"directory": {
"alias": "dir",
"description": "The directory of the new application.",
"type": "string"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (e2e) tests.",
"enum": [
"cypress",
"none"
],
"type": "string"
},
"globalCss": {
"default": false,
"description": "Default is false. When true, the component is generated with *.css/*.scss instead of *.module.css/*.module.scss",
"type": "boolean"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the host application to generate the Module Federation configuration",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use as the host application?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. App.tsx).",
"type": "boolean"
},
"remotes": {
"default": [],
"description": "A list of remote application names that the host application should consume.",
"type": "array"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint \"parserOptions.project\" option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipWorkspaceJson": {
"default": false,
"description": "Skip updating workspace.json with default options based on values provided to this app (e.g. babel, style).",
"type": "boolean"
},
"ssr": {
"default": false,
"description": "Whether to configure SSR for the host application",
"type": "boolean"
},
"standaloneConfig": {
"description": "Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Creates an application with strict mode and strict type checking",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "Stylus(.styl) [ http://stylus-lang.com ]",
"value": "styl"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Generate Module Federation Setup for React Host App",
"type": "object"
} | MIT | en |
nrwl/nx | 25d6ec3a921d09cb95ad81ce2471e11e3f51e9d1 | 2023-11-07T20:45:42 | packages/angular/src/generators/library/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "GeneratorAngularLibrary",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Creates an Angular library.",
"examplesFile": "../../../docs/library-examples.md",
"properties": {
"addModuleSpec": {
"default": false,
"description": "Add a module spec file.",
"type": "boolean"
},
"addTailwind": {
"default": false,
"description": "Whether to configure Tailwind CSS for the application. It can only be used with buildable and publishable libraries. Non-buildable libraries will use the application's Tailwind configuration.",
"type": "boolean"
},
"buildable": {
"default": false,
"description": "Generate a buildable library.",
"type": "boolean",
"x-priority": "important"
},
"changeDetection": {
"alias": "c",
"default": "Default",
"description": "The change detection strategy to use in the new component. Disclaimer: This option is only valid when `--standalone` is set to `true`.",
"enum": [
"Default",
"OnPush"
],
"type": "string"
},
"compilationMode": {
"description": "Specifies the compilation mode to use. If not specified, it will default to `partial` for publishable libraries and to `full` for buildable libraries. The `full` value can not be used for publishable libraries.",
"enum": [
"full",
"partial"
],
"type": "string"
},
"directory": {
"description": "A directory where the library is placed.",
"type": "string",
"x-priority": "important"
},
"displayBlock": {
"alias": "b",
"default": false,
"description": "Specifies if the component generated style will contain `:host { display: block; }`. Disclaimer: This option is only valid when `--standalone` is set to `true`.",
"type": "boolean"
},
"flat": {
"default": false,
"description": "Ensure the generated standalone component is not placed in a subdirectory. Disclaimer: This option is only valid when `--standalone` is set to `true`.",
"type": "boolean"
},
"importPath": {
"description": "The library name used to import it, like `@myorg/my-awesome-lib`. Must be a valid npm name.",
"type": "string"
},
"inlineStyle": {
"alias": "s",
"default": false,
"description": "Include styles inline in the component.ts file. Only CSS styles can be included inline. By default, an external styles file is created and referenced in the component.ts file. Disclaimer: This option is only valid when `--standalone` is set to `true`.",
"type": "boolean"
},
"inlineTemplate": {
"alias": "t",
"default": false,
"description": "Include template inline in the component.ts file. By default, an external template file is created and referenced in the component.ts file. Disclaimer: This option is only valid when `--standalone` is set to `true`.",
"type": "boolean"
},
"lazy": {
"default": false,
"description": "Add `RouterModule.forChild` when set to true, and a simple array of routes when set to false.",
"type": "boolean",
"x-priority": "important"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the library.",
"pattern": "(?:^@[a-zA-Z0-9-*~][a-zA-Z0-9-*._~]*\\/[a-zA-Z0-9-~][a-zA-Z0-9-._~]*|^[a-zA-Z][^:]*)$",
"type": "string",
"x-prompt": "What name would you like to use for the library?"
},
"parent": {
"description": "Path to the parent route configuration using `loadChildren` or `children`, depending on what `lazy` is set to.",
"type": "string",
"x-priority": "important"
},
"prefix": {
"alias": "p",
"description": "The prefix to apply to generated selectors.",
"format": "html-selector",
"type": "string"
},
"projectNameAndRootFormat": {
"description": "Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"publishable": {
"default": false,
"description": "Generate a publishable library.",
"type": "boolean",
"x-priority": "important"
},
"routing": {
"default": false,
"description": "Add router configuration. See `lazy` for more information.",
"type": "boolean",
"x-priority": "important"
},
"selector": {
"description": "The HTML selector to use for this component. Disclaimer: This option is only valid when `--standalone` is set to `true`.",
"format": "html-selector",
"type": "string"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"simpleName": {
"default": false,
"description": "Don't include the directory in the name of the module or standalone component entry of the library.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipModule": {
"default": false,
"description": "Whether to skip the creation of a default module when generating the library.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"skipSelector": {
"default": false,
"description": "Specifies if the component should have a selector or not. Disclaimer: This option is only valid when `--standalone` is set to `true`.",
"type": "boolean"
},
"skipTests": {
"default": false,
"description": "Do not create `spec.ts` test files for the new component. Disclaimer: This option is only valid when `--standalone` is set to `true`.",
"type": "boolean"
},
"skipTsConfig": {
"default": false,
"description": "Do not update `tsconfig.json` for development experience.",
"type": "boolean"
},
"standalone": {
"default": true,
"description": "Generate a library that uses a standalone component instead of a module as the entry point.",
"type": "boolean"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"strict": {
"default": true,
"description": "Create a library with stricter type checking and build optimization options.",
"type": "boolean"
},
"style": {
"default": "css",
"description": "The file extension or preprocessor to use for style files, or `none` to skip generating the style file. Disclaimer: This option is only valid when `--standalone` is set to `true`.",
"enum": [
"css",
"scss",
"sass",
"less",
"none"
],
"type": "string"
},
"tags": {
"description": "Add tags to the library (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
},
"viewEncapsulation": {
"alias": "v",
"description": "The view encapsulation strategy to use in the new component. Disclaimer: This option is only valid when `--standalone` is set to `true`.",
"enum": [
"Emulated",
"None",
"ShadowDom"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Create a library",
"type": "object"
} | MIT | en |
nrwl/nx | c616f6218cd8fe198ff473731f9287590f8f48ff | 2022-08-26T09:05:17 | packages/angular/src/generators/host/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxMFHost",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create an Angular Host Module Federation Application.",
"examples": [
{
"command": "nx g @nrwl/angular:host appName --remotes=remote1",
"description": "Create an Angular application with configuration in place for Module Federation. If the `remotes` option is provided, attach the remote application to this application's configuration"
}
],
"properties": {
"addTailwind": {
"default": false,
"description": "Whether to configure Tailwind CSS for the application.",
"type": "boolean"
},
"backendProject": {
"description": "Backend project that provides data to this application. This sets up `proxy.config.json`.",
"type": "string"
},
"directory": {
"description": "The directory of the new application.",
"type": "string"
},
"dynamic": {
"default": false,
"description": "Should the host application use dynamic federation?",
"type": "boolean"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (E2E) tests.",
"enum": [
"protractor",
"cypress",
"none"
],
"type": "string"
},
"inlineStyle": {
"alias": "s",
"default": false,
"description": "Specifies if the style will be in the ts file.",
"type": "boolean"
},
"inlineTemplate": {
"alias": "t",
"default": false,
"description": "Specifies if the template will be in the ts file.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name to give to the host Angular application.",
"type": "string"
},
"prefix": {
"alias": "p",
"description": "The prefix to apply to generated selectors.",
"format": "html-selector",
"type": "string"
},
"remotes": {
"description": "The names of the remote applications to add to the host.",
"type": "array"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
},
"skipPostInstall": {
"default": false,
"description": "Do not add or append `ngcc` to the `postinstall` script in `package.json`.",
"type": "boolean"
},
"skipTests": {
"alias": "S",
"default": false,
"description": "Skip creating spec files.",
"type": "boolean"
},
"standalone": {
"default": false,
"description": "Whether to generate a host application that uses standalone components.",
"type": "boolean"
},
"standaloneConfig": {
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Create an application with stricter type checking and build optimization options.",
"type": "boolean"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"enum": [
"css",
"scss",
"sass",
"less"
],
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "SASS(.sass) [ http://sass-lang.com ]",
"value": "sass"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"karma",
"jest",
"none"
],
"type": "string"
},
"viewEncapsulation": {
"description": "Specifies the view encapsulation strategy.",
"enum": [
"Emulated",
"None",
"ShadowDom"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Nx Module Federation Host Application",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/nuxt/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNuxtApp",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Create a Nuxt Application for Nx.",
"examplesFile": "../../../docs/application-examples.md",
"properties": {
"directory": {
"alias": "dir",
"description": "The directory of the new application.",
"type": "string",
"x-priority": "important"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (E2E) tests.",
"enum": [
"cypress",
"playwright",
"none"
],
"type": "string",
"x-prompt": "Which E2E test runner would you like to use?"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"pattern": "^[a-zA-Z][^:]*$",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use for the application?"
},
"projectNameAndRootFormat": {
"description": "Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"rootProject": {
"default": false,
"description": "Create an application at the root of the workspace.",
"hidden": true,
"type": "boolean",
"x-priority": "internal"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ https://sass-lang.com ]",
"value": "scss"
},
{
"label": "LESS [ https://lesscss.org ]",
"value": "less"
},
{
"label": "None",
"value": "none"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "none",
"description": "Test runner to use for unit tests.",
"enum": [
"vitest",
"none"
],
"type": "string",
"x-prompt": "Which unit test runner would you like to use?"
}
},
"required": [],
"title": "Create a Nuxt Application for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/vue/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxVueInit",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Initialize a Vue Plugin.",
"properties": {
"keepExistingVersions": {
"default": false,
"description": "Keep existing dependencies versions",
"type": "boolean",
"x-priority": "internal"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
}
},
"required": [],
"title": "Init Vue Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | 5366d49936ea3de7a8012d5d7ab594d82c51faf5 | 2023-10-10T14:21:36 | packages/nuxt/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNuxtApp",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a Nuxt Application for Nx.",
"examplesFile": "../../../docs/application-examples.md",
"properties": {
"directory": {
"alias": "d",
"description": "The directory of the new application.",
"type": "string",
"x-priority": "important"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (E2E) tests.",
"enum": [
"cypress",
"playwright",
"none"
],
"type": "string",
"x-prompt": "Which E2E test runner would you like to use?"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"pattern": "^[a-zA-Z][^:]*$",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use for the application?"
},
"projectNameAndRootFormat": {
"description": "Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"rootProject": {
"default": false,
"description": "Create an application at the root of the workspace.",
"hidden": true,
"type": "boolean",
"x-priority": "internal"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string"
},
"tags": {
"alias": "t",
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "none",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"vitest",
"none"
],
"type": "string",
"x-prompt": "Which unit test runner would you like to use?"
}
},
"required": [],
"title": "Create a Nuxt Application for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | 14643b68b5220122d2524e9269f83e2a3e2a2229 | 2023-10-12T15:42:41 | packages/react/src/generators/remote/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "GeneratorReactRemote",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create Module Federation configuration files for given React Remote Application.",
"properties": {
"classComponent": {
"alias": "C",
"default": false,
"description": "Use class components instead of functional component.",
"type": "boolean"
},
"compiler": {
"default": "babel",
"description": "The compiler to use.",
"enum": [
"babel",
"swc"
],
"type": "string"
},
"devServerPort": {
"description": "The port for the dev server of the remote app.",
"type": "number",
"x-priority": "important"
},
"directory": {
"alias": "dir",
"description": "The directory of the new application.",
"type": "string",
"x-priority": "important"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (e2e) tests.",
"enum": [
"cypress",
"none"
],
"type": "string"
},
"globalCss": {
"default": false,
"description": "Default is false. When true, the component is generated with *.css/*.scss instead of *.module.css/*.module.scss.",
"type": "boolean"
},
"host": {
"description": "The host / shell application for this remote.",
"type": "string",
"x-priority": "important"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the remote application to generate the Module Federation configuration",
"pattern": "^[a-zA-Z][^:]*$",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use as the remote application?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. App.tsx).",
"type": "boolean"
},
"projectNameAndRootFormat": {
"description": "Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"routing": {
"default": false,
"description": "Generate application with routes.",
"type": "boolean"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint \"parserOptions.project\" option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipNxJson": {
"default": false,
"description": "Skip updating workspace.json with default options based on values provided to this app (e.g. babel, style).",
"type": "boolean",
"x-priority": "internal"
},
"ssr": {
"default": false,
"description": "Whether to configure SSR for the host application",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Creates an application with strict mode and strict type checking.",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "DEPRECATD: Stylus(.styl) [ http://stylus-lang.com ]",
"value": "styl"
},
{
"label": "None",
"value": "none"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"typescriptConfiguration": {
"default": true,
"description": "Whether the module federation configuration and webpack configuration files should use TS.",
"type": "boolean"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Generate Module Federation Setup for React Remote App",
"type": "object"
} | MIT | en |
nrwl/nx | 4eb7cc7bf170cd48dd87fdd0dd387d3592beec69 | 2023-03-31T15:22:18 | packages/react/src/generators/component/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactComponent",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a React Component for Nx.",
"examples": [
{
"command": "nx g component my-component --project=mylib",
"description": "Generate a component in the `mylib` library"
},
{
"command": "nx g component my-component --project=mylib --classComponent",
"description": "Generate a class component in the `mylib` library"
}
],
"properties": {
"classComponent": {
"alias": "C",
"default": false,
"description": "Use class components instead of functional component.",
"type": "boolean"
},
"directory": {
"alias": "dir",
"description": "Create the component under this directory (can be nested).",
"type": "string",
"x-priority": "important"
},
"export": {
"alias": "e",
"default": false,
"description": "When true, the component is exported from the project `index.ts` (if it exists).",
"type": "boolean",
"x-prompt": "Should this component be exported in the project?"
},
"fileName": {
"description": "Create a component with this file name.",
"type": "string"
},
"flat": {
"default": false,
"description": "Create component at the source root rather than its own directory.",
"type": "boolean"
},
"globalCss": {
"default": false,
"description": "Default is `false`. When `true`, the component is generated with `*.css`/`*.scss` instead of `*.module.css`/`*.module.scss`.",
"type": "boolean"
},
"inSourceTests": {
"default": false,
"description": "When using Vitest, separate spec files will not be generated and instead will be included within the source files. Read more on the Vitest docs site: https://vitest.dev/guide/in-source.html",
"type": "boolean"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the component.",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use for the component?"
},
"pascalCaseDirectory": {
"alias": "R",
"default": false,
"description": "Use pascal case directory name (e.g. `App/App.tsx`).",
"type": "boolean"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. `App.tsx`).",
"type": "boolean"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The name of the project.",
"type": "string",
"x-priority": "important",
"x-prompt": "What is the name of the project for this component?"
},
"routing": {
"description": "Generate a library with routes.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipTests": {
"default": false,
"description": "When true, does not create `spec.ts` test files for the new component.",
"type": "boolean",
"x-priority": "internal"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "Stylus(.styl) [ http://stylus-lang.com ]",
"value": "styl"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
}
},
"required": [
"name",
"project"
],
"title": "Create a React Component",
"type": "object"
} | MIT | en |
nrwl/nx | 6dae32cc3af4f76f4de7f296a7c7c34ecfc1d62b | 2022-03-24T16:00:06 | packages/nest/src/generators/library/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestLibraryGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create a NestJS Library for Nx.",
"examples": [
{
"command": "nx g lib mylib --directory=myapp",
"description": "Generate libs/myapp/mylib"
}
],
"properties": {
"buildable": {
"default": false,
"description": "Generate a buildable library.",
"type": "boolean"
},
"controller": {
"default": false,
"description": "Include a controller with the library.",
"type": "boolean"
},
"directory": {
"alias": "dir",
"description": "A directory where the library is placed.",
"type": "string"
},
"global": {
"default": false,
"description": "Add the Global decorator to the generated module.",
"type": "boolean"
},
"importPath": {
"description": "The library name used to import it, like @myorg/my-awesome-lib. Must be a valid npm name.",
"type": "string"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Library name.",
"type": "string",
"x-prompt": "What name would you like to use for the library?"
},
"publishable": {
"description": "Create a publishable library.",
"type": "boolean"
},
"service": {
"default": false,
"description": "Include a service with the library.",
"type": "boolean"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint \"parserOptions.project\" option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipTsConfig": {
"default": false,
"description": "Do not update tsconfig.base.json for development experience.",
"type": "boolean"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json",
"type": "boolean"
},
"strict": {
"default": false,
"description": "Whether to enable tsconfig strict mode or not.",
"type": "boolean"
},
"tags": {
"alias": "t",
"description": "Add tags to the library (used for linting).",
"type": "string"
},
"target": {
"default": "es6",
"description": "The ES target, Nest suggest using es6 or higher.",
"enum": [
"es5",
"es6",
"esnext",
"es2015",
"es2016",
"es2017",
"es2018",
"es2019",
"es2020"
],
"type": "string"
},
"testEnvironment": {
"default": "node",
"description": "The test environment for jest, for node applications this should stay as node unless doing DOM testing.",
"enum": [
"jsdom",
"node"
],
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Create a NestJS Library for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | 3eede1c7debee88572a71f4668b9b0d63a169f62 | 2023-04-12T12:23:13 | packages/next/src/generators/library/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactLibrary",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a React Library for an Nx workspace.",
"examplesFile": "../../../docs/library-examples.md",
"properties": {
"appProject": {
"alias": "a",
"description": "The application project to add the library route to.",
"type": "string"
},
"buildable": {
"default": false,
"description": "Generate a buildable library.",
"type": "boolean"
},
"component": {
"default": true,
"description": "Generate a default component.",
"type": "boolean"
},
"directory": {
"alias": "dir",
"description": "A directory where the lib is placed.",
"type": "string",
"x-priority": "important"
},
"globalCss": {
"default": false,
"description": "When true, the stylesheet is generated using global CSS instead of CSS modules (e.g. file is `*.css` rather than `*.module.css`).",
"type": "boolean"
},
"importPath": {
"description": "The library name used to import it, like `@myorg/my-awesome-lib`.",
"type": "string"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Library name",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use for the library?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. `App.tsx`).",
"type": "boolean"
},
"publishable": {
"description": "Create a publishable library.",
"type": "boolean"
},
"routing": {
"description": "Generate library with routes.",
"type": "boolean"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"skipTsConfig": {
"default": false,
"description": "Do not update tsconfig.json for development experience.",
"type": "boolean"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"strict": {
"default": true,
"description": "Whether to enable tsconfig strict mode or not.",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
},
{
"label": "Stylus(.styl) [ http://stylus-lang.com ] (DEPRECATED)",
"value": "styl"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the library (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Create a React Library for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/eslint/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxESLintInit",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Set up the ESLint plugin.",
"properties": {
"keepExistingVersions": {
"default": false,
"description": "Keep existing dependencies versions",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
},
"updatePackageScripts": {
"default": false,
"description": "Update `package.json` scripts with inferred targets",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [],
"title": "Initialize ESLint Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | 699a20ca03236676a7923cc96e4766b7cedbe519 | 2023-07-17T17:07:46 | packages/react-native/src/executors/build-ios/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Build iOS app.",
"examplesFile": "../../../docs/build-ios-examples.md",
"presets": [
{
"keys": [
"simulator"
],
"name": "Build iOS for a simulator"
},
{
"keys": [
"device"
],
"name": "Build iOS for a device"
},
{
"keys": [
"udid"
],
"name": "Build iOS for a device with udid"
}
],
"properties": {
"buildFolder": {
"default": "./build",
"description": "Location for iOS build artifacts. Corresponds to Xcode's \"-derivedDataPath\". Relative to ios directory",
"type": "string"
},
"device": {
"description": "Explicitly set device to use by name. The value is not required if you have a single device connected.",
"type": "string"
},
"extraParams": {
"description": "Custom params that will be passed to xcodebuild command.",
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"install": {
"default": true,
"description": "Runs `pod install` for native modules before building iOS app.",
"type": "boolean",
"x-deprecated": "Add pod-install to dependsOn in project.json for this target instead"
},
"interactive": {
"description": "Explicitly select which scheme and configuration to use before running a build",
"type": "boolean"
},
"mode": {
"default": "Debug",
"description": "Explicitly set the scheme configuration to use",
"examples": [
"Debug",
"Release"
],
"type": "string",
"x-priority": "important"
},
"packager": {
"default": true,
"description": "Launch packager while building",
"type": "boolean",
"x-deprecated": "Run `nx run <project>:start` instead. Will be removed in Nx 17."
},
"port": {
"default": 8081,
"description": "The port where the packager server is listening on.",
"type": "number"
},
"resetCache": {
"default": false,
"description": "Resets metro cache.",
"type": "boolean"
},
"scheme": {
"description": "Explicitly set Xcode scheme to use",
"type": "string"
},
"simulator": {
"description": "Explicitly set simulator to use. Optionally include iOS version between parenthesis at the end to match an exact version: \"iPhone 6 (10.0)\"",
"examples": [
"iPhone 14",
"iPhone 13",
"iPhone 12",
"iPhone 11",
"iPhone X"
],
"type": "string",
"x-priority": "important"
},
"sync": {
"default": true,
"description": "Syncs npm dependencies to `package.json` (for React Native autolink).",
"type": "boolean",
"x-deprecated": "Add sync-deps to dependsOn in project.json for this target instead"
},
"udid": {
"description": "Explicitly set device to use by udid",
"type": "string"
},
"verbose": {
"description": "Do not use xcbeautify or xcpretty even if installed",
"type": "boolean"
},
"xcconfig": {
"description": "Explicitly set xcconfig to use",
"type": "string"
}
},
"required": [],
"title": "React Native Build iOS executor",
"type": "object",
"version": 2
} | MIT | en |
nrwl/nx | bdcbac4445df85a8f861ac70465eb641e025e8de | 2021-10-15T22:07:12 | packages/node/src/generators/library/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNodeLibrary",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"examples": [
{
"command": "g lib mylib --directory=myapp",
"description": "Generate libs/myapp/mylib"
}
],
"properties": {
"babelJest": {
"default": false,
"description": "Use babel instead ts-jest",
"type": "boolean"
},
"buildable": {
"default": false,
"description": "Generate a buildable library.",
"type": "boolean"
},
"directory": {
"alias": "dir",
"description": "A directory where the lib is placed",
"type": "string"
},
"importPath": {
"description": "The library name used to import it, like @myorg/my-awesome-lib. Must be a valid npm name.",
"type": "string"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"tslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Library name",
"type": "string",
"x-prompt": "What name would you like to use for the library?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case file names.",
"type": "boolean"
},
"publishable": {
"description": "Create a publishable library.",
"type": "boolean"
},
"rootDir": {
"alias": "srcRootForCompilationRoot",
"description": "Sets the rootDir for TypeScript compilation. When not defined, it uses the project's root property, or srcRootForCompilationRoot if it is defined.",
"type": "string"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint \"parserOptions.project\" option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"simpleModuleName": {
"default": false,
"description": "Keep the module name simple (when using --directory)",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files",
"type": "boolean"
},
"skipTsConfig": {
"default": false,
"description": "Do not update tsconfig.base.json for development experience.",
"type": "boolean"
},
"standaloneConfig": {
"description": "Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json",
"type": "boolean"
},
"strict": {
"default": false,
"description": "Whether to enable tsconfig strict mode or not.",
"type": "boolean"
},
"tags": {
"alias": "t",
"description": "Add tags to the library (used for linting)",
"type": "string"
},
"testEnvironment": {
"default": "jsdom",
"description": "The test environment to use if unitTestRunner is set to jest",
"enum": [
"jsdom",
"node"
],
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Create a Node Library for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | ce4a76a97559e18268b1f4385b211f555f7224c4 | 2023-04-18T18:47:02 | packages/nest/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestApplicationGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Nx Application Options Schema.",
"properties": {
"directory": {
"description": "The directory of the new application.",
"type": "string"
},
"e2eTestRunner": {
"default": "jest",
"description": "Test runner to use for end to end (e2e) tests",
"enum": [
"jest",
"none"
],
"type": "string"
},
"frontendProject": {
"description": "Frontend project that needs to access this application. This sets up proxy configuration.",
"type": "string",
"x-priority": "important"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"type": "string",
"x-prompt": "What name would you like to use for the node application?"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"strict": {
"default": false,
"description": "Adds strictNullChecks, noImplicitAny, strictBindCallApply, forceConsistentCasingInFileNames and noFallthroughCasesInSwitch to tsconfig.",
"type": "boolean"
},
"tags": {
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Nx Application Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | 513e2346b39b4610958a1847a8350008389d54a6 | 2023-10-16T20:04:01 | packages/react/src/generators/component/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactComponent",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a React Component for Nx.",
"examplesFile": "../../../docs/component-examples.md",
"properties": {
"classComponent": {
"alias": "C",
"default": false,
"description": "Use class components instead of functional component.",
"type": "boolean"
},
"directory": {
"alias": "dir",
"description": "The directory at which to create the component file. When `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. Otherwise, it will be relative to the project root.",
"type": "string",
"x-priority": "important"
},
"export": {
"alias": "e",
"default": false,
"description": "When true, the component is exported from the project `index.ts` (if it exists).",
"type": "boolean",
"x-prompt": "Should this component be exported in the project?"
},
"fileName": {
"description": "Create a component with this file name.",
"type": "string"
},
"flat": {
"default": false,
"description": "Create component at the source root rather than its own directory.",
"type": "boolean",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. This option will be removed in Nx v18."
},
"globalCss": {
"default": false,
"description": "Default is `false`. When `true`, the component is generated with `*.css`/`*.scss` instead of `*.module.css`/`*.module.scss`.",
"type": "boolean"
},
"inSourceTests": {
"default": false,
"description": "When using Vitest, separate spec files will not be generated and instead will be included within the source files. Read more on the Vitest docs site: https://vitest.dev/guide/in-source.html",
"type": "boolean"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the component.",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use for the component?"
},
"nameAndDirectoryFormat": {
"description": "Whether to generate the component in the directory as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"pascalCaseDirectory": {
"alias": "R",
"default": false,
"description": "Use pascal case directory name (e.g. `App/App.tsx`).",
"type": "boolean",
"x-deprecated": "Provide the `directory` in pascal-case and use the `as-provided` format. This option will be removed in Nx v18."
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. `App.tsx`).",
"type": "boolean",
"x-deprecated": "Provide the `name` in pascal-case and use the `as-provided` format. This option will be removed in Nx v18."
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The name of the project.",
"type": "string",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v18."
},
"routing": {
"description": "Generate a library with routes.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipTests": {
"default": false,
"description": "When true, does not create `spec.ts` test files for the new component.",
"type": "boolean",
"x-priority": "internal"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
}
},
"required": [
"name"
],
"title": "Create a React Component",
"type": "object"
} | MIT | en |
nrwl/nx | deb0f1a49294eafe18c407a96c95e40af15d3738 | 2024-01-30T21:29:05 | packages/react/src/generators/hook/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactHook",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Create a React component using Hooks in a dedicated React project.",
"examples": [
{
"command": "nx g hook my-hook --project=mylib",
"description": "Generate a hook in the `mylib` library"
}
],
"properties": {
"directory": {
"description": "The directory at which to create the hook file. When `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. Otherwise, it will be relative to the project root.",
"type": "string",
"x-priority": "important"
},
"export": {
"alias": "e",
"default": false,
"description": "When true, the hook is exported from the project `index.ts` (if it exists).",
"type": "boolean",
"x-prompt": "Should this hook be exported in the project?"
},
"flat": {
"default": false,
"description": "Create hook at the source root rather than its own directory.",
"type": "boolean",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19."
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the hook.",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use for the hook?"
},
"nameAndDirectoryFormat": {
"description": "Whether to generate the component in the directory as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"pascalCaseDirectory": {
"alias": "R",
"default": false,
"description": "Use pascal case directory name (e.g. `useHook/useHook.ts`).",
"type": "boolean",
"x-deprecated": "Provide the `directory` in pascal-case and use the `as-provided` format. This option will be removed in Nx v19."
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case hook file name (e.g. `useHook.ts`).",
"type": "boolean",
"x-deprecated": "Provide the `name` in pascal-case and use the `as-provided` format. This option will be removed in Nx v19."
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The name of the project.",
"type": "string",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v19."
},
"skipTests": {
"default": false,
"description": "When true, does not create `spec.ts` test files for the new hook.",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [
"name"
],
"title": "Create a React Hook for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | 295b8d737c687e21e709fa5fa8397e49e12987d3 | 2021-08-18T22:02:12 | packages/nest/src/generators/library/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestLibraryGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"examples": [
{
"command": "g lib mylib --directory=myapp",
"description": "Generate libs/myapp/mylib"
}
],
"properties": {
"buildable": {
"default": false,
"description": "Generate a buildable library.",
"type": "boolean"
},
"controller": {
"default": false,
"description": "Include a controller with the library.",
"type": "boolean"
},
"directory": {
"alias": "dir",
"description": "A directory where the library is placed.",
"type": "string"
},
"global": {
"default": false,
"description": "Add the Global decorator to the generated module.",
"type": "boolean"
},
"importPath": {
"description": "The library name used to import it, like @myorg/my-awesome-lib. Must be a valid npm name.",
"type": "string"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Library name.",
"type": "string",
"x-prompt": "What name would you like to use for the library?"
},
"publishable": {
"description": "Create a publishable library.",
"type": "boolean"
},
"service": {
"default": false,
"description": "Include a service with the library.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipTsConfig": {
"default": false,
"description": "Do not update tsconfig.base.json for development experience.",
"type": "boolean"
},
"strict": {
"default": false,
"description": "Whether to enable tsconfig strict mode or not.",
"type": "boolean"
},
"tags": {
"alias": "t",
"description": "Add tags to the library (used for linting).",
"type": "string"
},
"target": {
"default": "es6",
"description": "The ES target, Nest suggest using es6 or higher.",
"enum": [
"es5",
"es6",
"esnext",
"es2015",
"es2016",
"es2017",
"es2018",
"es2019",
"es2020"
],
"type": "string"
},
"testEnvironment": {
"default": "node",
"description": "The test environment for jest, for node applications this should stay as node unless doing DOM testing.",
"enum": [
"jsdom",
"node"
],
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Create a NestJS Library for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/vue/src/generators/stories/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxVueStorybookStories",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Generate stories/specs for all components declared in a project.",
"examplesFile": "../../../docs/stories-examples.md",
"properties": {
"cypressProject": {
"description": "The Cypress project to generate the stories under. This is inferred from `project` by default.",
"type": "string"
},
"generateCypressSpecs": {
"description": "Automatically generate `*.spec.ts` files in the cypress e2e app generated by the cypress-configure generator.",
"type": "boolean"
},
"ignorePaths": {
"default": [
"*.stories.ts,*.stories.tsx,*.stories.js,*.stories.jsx,*.stories.mdx"
],
"description": "Paths to ignore when looking for components.",
"examples": [
"apps/my-app/src/not-stories/**",
"**/**/src/**/not-stories/**",
"libs/my-lib/**/*.something.ts",
"**/**/src/**/*.other.*",
"libs/my-lib/src/not-stories/**,**/**/src/**/*.other.*,apps/my-app/**/*.something.ts"
],
"items": {
"description": "Path to ignore.",
"type": "string"
},
"type": "array"
},
"interactionTests": {
"default": true,
"description": "Set up Storybook interaction tests.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Do you want to set up Storybook interaction tests?"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"project": {
"$default": {
"$source": "projectName",
"index": 0
},
"aliases": [
"name",
"projectName"
],
"description": "Project for which to generate stories.",
"type": "string",
"x-priority": "important",
"x-prompt": "For which project do you want to generate stories?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [
"project"
],
"title": "Generate Vue Storybook stories",
"type": "object"
} | MIT | en |
nrwl/nx | fab43a15e26b82857ee42456ea881822214a5981 | 2021-06-28T17:01:00 | packages/nest/src/generators/interface/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestInterfaceGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"properties": {
"directory": {
"aliases": [
"d",
"path"
],
"description": "Directory where the generated files are placed.",
"type": "string"
},
"flat": {
"default": true,
"description": "Flag to indicate if a directory is created.",
"type": "boolean"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the interface.",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The Nest project to target.",
"type": "string",
"x-prompt": "What Nest project would you like to target?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
}
},
"required": [
"name",
"project"
],
"title": "Nest Interface Options Schema.",
"type": "object"
} | MIT | en |
nrwl/nx | fcc02d193222f9b020daf637cec807fd529c73bf | 2023-01-09T10:15:37 | packages/react/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactNgInit",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Initialize a React Plugin.",
"properties": {
"e2eTestRunner": {
"default": "cypress",
"description": "Adds the specified E2E test runner.",
"enum": [
"cypress",
"none"
],
"type": "string"
},
"js": {
"default": false,
"description": "Use JavaScript instead of TypeScript",
"type": "boolean"
},
"skipBabelConfig": {
"default": false,
"description": "Do not generate a root babel.config.json (if babel is not needed).",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipHelperLibs": {
"default": false,
"description": "Do not install tslib.",
"hidden": true,
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
},
"unitTestRunner": {
"default": "jest",
"description": "Adds the specified unit test runner.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [],
"title": "Init React Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | 2ab66dd4104dac61a4a6c37546c5e18b53341a83 | 2023-03-09T11:28:31 | packages/angular/src/generators/host/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxMFHost",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create an Angular Host Module Federation Application.",
"examples": [
{
"command": "nx g @nrwl/angular:host appName --remotes=remote1",
"description": "Create an Angular application with configuration in place for Module Federation. If the `remotes` option is provided, attach the remote application to this application's configuration"
}
],
"properties": {
"addTailwind": {
"default": false,
"description": "Whether to configure Tailwind CSS for the application.",
"type": "boolean"
},
"backendProject": {
"description": "Backend project that provides data to this application. This sets up `proxy.config.json`.",
"type": "string"
},
"directory": {
"description": "The directory of the new application.",
"type": "string"
},
"dynamic": {
"default": false,
"description": "Should the host application use dynamic federation?",
"type": "boolean"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (E2E) tests.",
"enum": [
"protractor",
"cypress",
"none"
],
"type": "string"
},
"inlineStyle": {
"alias": "s",
"default": false,
"description": "Specifies if the style will be in the ts file.",
"type": "boolean"
},
"inlineTemplate": {
"alias": "t",
"default": false,
"description": "Specifies if the template will be in the ts file.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name to give to the host Angular application.",
"type": "string"
},
"prefix": {
"alias": "p",
"description": "The prefix to apply to generated selectors.",
"format": "html-selector",
"type": "string"
},
"remotes": {
"description": "The names of the remote applications to add to the host.",
"type": "array",
"x-priority": "important"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"skipPostInstall": {
"default": false,
"description": "Do not add or append `ngcc` to the `postinstall` script in `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"skipTests": {
"alias": "S",
"default": false,
"description": "Skip creating spec files.",
"type": "boolean"
},
"ssr": {
"default": false,
"description": "Whether to configure SSR for the host application",
"type": "boolean",
"x-priority": "important"
},
"standalone": {
"default": false,
"description": "Whether to generate a host application that uses standalone components. _Note: This is only supported in Angular versions >= 14.1.0_",
"type": "boolean"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"strict": {
"default": true,
"description": "Create an application with stricter type checking and build optimization options.",
"type": "boolean"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"enum": [
"css",
"scss",
"sass",
"less"
],
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "SASS(.sass) [ http://sass-lang.com ]",
"value": "sass"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
},
"viewEncapsulation": {
"description": "Specifies the view encapsulation strategy.",
"enum": [
"Emulated",
"None",
"ShadowDom"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Nx Module Federation Host Application",
"type": "object"
} | MIT | en |
nrwl/nx | 9be869ff7bf7c39bfa05c35bb5cd9f73ba34ed2d | 2023-10-10T14:36:28 | packages/angular/src/generators/setup-mf/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "GeneratorAngularMFSetup",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create Module Federation configuration files for given Angular Application.",
"examplesFile": "../../../docs/setup-mf-examples.md",
"properties": {
"appName": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application to generate the Module Federation configuration for.",
"type": "string",
"x-dropdown": "projects",
"x-prompt": "What app would you like to generate a Module Federation configuration for?"
},
"e2eProjectName": {
"description": "The project name of the associated E2E project for the application. This is only required for Cypress E2E projects that do not follow the naming convention `<appName>-e2e`.",
"type": "string"
},
"federationType": {
"default": "static",
"description": "Use either Static or Dynamic Module Federation pattern for the application.",
"enum": [
"static",
"dynamic"
],
"type": "string"
},
"host": {
"description": "The name of the host application that the remote application will be consumed by.",
"type": "string"
},
"mfType": {
"default": "remote",
"description": "Type of application to generate the Module Federation configuration for.",
"enum": [
"host",
"remote"
],
"type": "string"
},
"port": {
"description": "The port at which the remote application should be served.",
"type": "number"
},
"prefix": {
"description": "The prefix to use for any generated component.",
"type": "string"
},
"remotes": {
"description": "A list of remote application names that the host application should consume.",
"type": "array"
},
"routing": {
"description": "Generate a routing setup to allow a host application to route to the remote application.",
"type": "boolean",
"x-priority": "important"
},
"skipE2E": {
"default": false,
"description": "Do not set up E2E related config.",
"type": "boolean"
},
"skipFormat": {
"description": "Skip formatting the workspace after the generator completes.",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"standalone": {
"default": false,
"description": "Whether the application is a standalone application. _Note: This is only supported in Angular versions >= 14.1.0_",
"type": "boolean"
},
"typescriptConfiguration": {
"default": true,
"description": "Whether the module federation configuration and webpack configuration files should use TS.",
"type": "boolean"
}
},
"required": [
"appName",
"mfType"
],
"title": "Generate Module Federation Setup for Angular App",
"type": "object"
} | MIT | en |
nrwl/nx | cfaedc818174eccb3a4184365400bec3243ff89a | 2022-04-19T15:18:26 | packages/angular/src/generators/ng-add/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxAngularNgAddGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Migrates an Angular CLI workspace to Nx or adds the Angular plugin to an Nx workspace. NOTE: Does not work in the `--dry-run` mode.",
"properties": {
"defaultBase": {
"description": "Default base branch for affected. NOTE: only used if running the generator in an Angular CLI workspace.",
"type": "string"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (e2e) tests. NOTE: only used if running the generator in an Nx workspace.",
"enum": [
"protractor",
"cypress",
"none"
],
"type": "string"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks. NOTE: only used if running the generator in an Nx workspace.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"npmScope": {
"description": "Npm scope for importing libs. NOTE: only used if running the generator in an Angular CLI workspace.",
"type": "string"
},
"preserveAngularCliLayout": {
"default": false,
"description": "Preserve the Angular CLI layout instead of moving the app into apps. NOTE: only used if running the generator in an Angular CLI workspace.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files. NOTE: only used if running the generator in an Nx workspace.",
"type": "boolean"
},
"skipInstall": {
"default": false,
"description": "Skip installing added packages.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`. NOTE: only used if running the generator in an Nx workspace.",
"type": "boolean"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files. NOTE: only used if running the generator in an Nx workspace.",
"enum": [
"css",
"scss",
"sass",
"less"
],
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests. NOTE: only used if running the generator in an Nx workspace.",
"enum": [
"karma",
"jest",
"none"
],
"type": "string"
}
},
"title": "Angular plugin initialization",
"type": "object"
} | MIT | en |
nrwl/nx | d7536aa7e3e1d87fe80f99e5255533572db0d79d | 2023-01-24T00:35:15 | packages/web/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWebApp",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a web application using `swc` or `babel` as compiler.",
"examplesFile": "../../../docs/application-examples.md",
"properties": {
"bundler": {
"default": "webpack",
"description": "The bundler to use.",
"enum": [
"webpack",
"none",
"vite"
],
"type": "string",
"x-prompt": "Which bundler do you want to use?"
},
"compiler": {
"default": "babel",
"description": "The compiler to use",
"enum": [
"babel",
"swc"
],
"type": "string"
},
"directory": {
"description": "The directory of the new application.",
"type": "string"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (e2e) tests",
"enum": [
"cypress",
"none"
],
"type": "string"
},
"inSourceTests": {
"default": false,
"description": "When using Vitest, separate spec files will not be generated and instead will be included within the source files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the application?"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files",
"type": "boolean"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside workspace.json",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "Stylus(.styl)[ http://stylus-lang.com ]",
"value": "styl"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"description": "Add tags to the application (used for linting)",
"type": "string"
},
"unitTestRunner": {
"description": "Test runner to use for unit tests. Default value is 'jest' when using 'webpack' or 'none' as the bundler and 'vitest' when using 'vite' as the bundler",
"enum": [
"jest",
"vitest",
"none"
],
"type": "string"
}
},
"required": [],
"title": "Create a Web Application for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | d289134bb0dff8377fd32f2a9bf8b36f37684725 | 2024-05-17T16:29:32 | packages/web/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWebApp",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Create a web application using `swc` or `babel` as compiler.",
"examplesFile": "../../../docs/application-examples.md",
"properties": {
"bundler": {
"default": "webpack",
"description": "The bundler to use.",
"enum": [
"webpack",
"none",
"vite"
],
"type": "string",
"x-priority": "important",
"x-prompt": "Which bundler do you want to use?"
},
"compiler": {
"default": "swc",
"description": "The compiler to use",
"enum": [
"swc",
"babel"
],
"type": "string",
"x-priority": "important"
},
"directory": {
"description": "The directory of the new application.",
"type": "string"
},
"e2eTestRunner": {
"default": "playwright",
"description": "Test runner to use for end to end (e2e) tests",
"enum": [
"playwright",
"cypress",
"none"
],
"type": "string",
"x-prompt": "Which E2E test runner would you like to use?"
},
"inSourceTests": {
"default": false,
"description": "When using Vitest, separate spec files will not be generated and instead will be included within the source files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"pattern": "^[a-zA-Z][^:]*$",
"type": "string",
"x-prompt": "What name would you like to use for the application?"
},
"projectNameAndRootFormat": {
"description": "Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files",
"type": "boolean",
"x-priority": "internal"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside workspace.json",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"strict": {
"default": true,
"description": "Creates an application with strict mode and strict type checking.",
"type": "boolean"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ https://sass-lang.com ]",
"value": "scss"
},
{
"label": "LESS [ https://lesscss.org ]",
"value": "less"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"description": "Add tags to the application (used for linting)",
"type": "string"
},
"unitTestRunner": {
"description": "Test runner to use for unit tests. Default value is 'jest' when using 'webpack' or 'none' as the bundler and 'vitest' when using 'vite' as the bundler",
"enum": [
"jest",
"vitest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Create a Web Application for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | 2c88282e8a00b1a3782feee68ab11a34bd32dd6d | 2023-11-29T13:58:49 | packages/vite/src/executors/preview-server/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"definitions": {},
"description": "Preview Server for Vite.",
"examplesFile": "../../../docs/preview-server-examples.md",
"presets": [
{
"keys": [
"buildTarget"
],
"name": "Default minimum setup"
},
{
"keys": [
"buildTarget",
"port"
],
"name": "Using a Different Port"
}
],
"properties": {
"buildTarget": {
"description": "Target which builds the application.",
"type": "string"
},
"proxyConfig": {
"description": "Path to the proxy configuration file.",
"type": "string",
"x-completion-type": "file"
},
"staticFilePath": {
"description": "Path where the build artifacts are located. If not provided then it will be infered from the buildTarget executor options as outputPath",
"type": "string",
"x-completion-type": "directory"
}
},
"required": [
"buildTarget"
],
"title": "Vite Preview Server",
"type": "object",
"version": 2
} | MIT | en |
nrwl/nx | 662f5413be12c2aa999aab7c4a3e323273c1d6c4 | 2022-11-28T18:29:23 | packages/react/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactApp",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a React application for Nx.",
"examples": [
{
"command": "nx g app myapp --directory=myorg",
"description": "Generate `apps/myorg/myapp` and `apps/myorg/myapp-e2e`"
},
{
"command": "nx g app myapp --classComponent",
"description": "Use class components instead of functional components"
},
{
"command": "nx g app myapp --routing",
"description": "Set up React Router"
}
],
"examplesFile": "../../../docs/application-examples.md",
"properties": {
"bundler": {
"default": "webpack",
"description": "The bundler to use.",
"enum": [
"vite",
"webpack"
],
"type": "string",
"x-prompt": "Which bundler do you want to use to build the application?"
},
"classComponent": {
"alias": "C",
"default": false,
"description": "Use class components instead of functional component.",
"type": "boolean"
},
"compiler": {
"default": "babel",
"description": "The compiler to use.",
"enum": [
"babel",
"swc"
],
"type": "string"
},
"directory": {
"alias": "dir",
"description": "The directory of the new application.",
"type": "string"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (E2E) tests.",
"enum": [
"cypress",
"none"
],
"type": "string"
},
"globalCss": {
"default": false,
"description": "Default is `false`. When `true`, the component is generated with `*.css`/`*.scss` instead of `*.module.css`/`*.module.scss`.",
"type": "boolean"
},
"inSourceTests": {
"default": false,
"description": "When using Vitest, separate spec files will not be generated and instead will be included within the source files. Read more on the Vitest docs site: https://vitest.dev/guide/in-source.html",
"type": "boolean"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"minimal": {
"default": false,
"description": "Generate a React app with a minimal setup, no separate test files.",
"type": "boolean"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the application?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. `App.tsx`).",
"type": "boolean"
},
"rootProject": {
"default": false,
"description": "Create a application at the root of the workspace",
"hidden": true,
"type": "boolean"
},
"routing": {
"default": false,
"description": "Generate application with routes.",
"type": "boolean",
"x-prompt": "Would you like to add React Router to this application?"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipDefaultProject": {
"default": false,
"description": "Skip setting the project as the default project. When `false` (the default), the project is set as the default project only if there is no default project already set.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
},
"skipWorkspaceJson": {
"default": false,
"description": "Skip updating `workspace.json` with default options based on values provided to this app (e.g. babel, style).",
"type": "boolean"
},
"standaloneConfig": {
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Creates an application with strict mode and strict type checking.",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "Stylus(.styl) [ http://stylus-lang.com ]",
"value": "styl"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"vitest",
"none"
],
"type": "string"
}
},
"required": [],
"title": "Create a React Application",
"type": "object"
} | MIT | en |
nrwl/nx | aa7625b76fcd3f53f6eda91220ecfd0a549928de | 2023-10-17T22:14:36 | packages/nest/src/generators/module/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestModuleGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Nest Module Options Schema.",
"properties": {
"directory": {
"aliases": [
"dir",
"path"
],
"description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.",
"type": "string"
},
"flat": {
"default": false,
"description": "Flag to indicate if a directory is created.",
"type": "boolean",
"x-deprecated": "provide the `directory` option instead and use the `as-provided` format. it will be removed in nx v18."
},
"language": {
"description": "Nest module language.",
"enum": [
"js",
"ts"
],
"type": "string"
},
"module": {
"description": "The path to import the module.",
"format": "path",
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the module.",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"nameAndDirectoryFormat": {
"description": "Whether to generate the component in the directory as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The Nest project to target.",
"type": "string",
"x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v18."
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipImport": {
"default": false,
"description": "Flag to skip the module import.",
"type": "boolean"
}
},
"required": [
"name"
],
"title": "Nest Module Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | 3eede1c7debee88572a71f4668b9b0d63a169f62 | 2023-04-12T12:23:13 | packages/next/src/generators/page/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNextReactPage",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a Page for Next.",
"examplesFile": "../../../docs/page-examples.md",
"properties": {
"directory": {
"alias": "dir",
"description": "Create the page under this directory (can be nested). Will be created under `pages/`.",
"type": "string",
"x-priority": "important"
},
"export": {
"alias": "e",
"default": false,
"description": "When true, the component is exported from the project `index.ts` (if it exists).",
"type": "boolean"
},
"flat": {
"default": false,
"description": "Create component at the source root rather than its own directory.",
"type": "boolean"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the component.",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use for the component?"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The name of the project.",
"type": "string",
"x-priority": "important",
"x-prompt": "What is the name of the project for this component?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-priority": "important",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
},
{
"label": "Stylus(.styl) [ http://stylus-lang.com ] (DEPRECATED)",
"value": "styl"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"withTests": {
"default": false,
"description": "When true, creates a `spec.ts` test file for the new page.",
"type": "boolean"
}
},
"required": [
"name",
"project"
],
"title": "Create a Page for Next",
"type": "object"
} | MIT | en |
nrwl/nx | 8b48ba9ac25ce15adec257a92c05c570ed8fa5a2 | 2023-04-14T17:56:57 | packages/react/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactApp",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a React application for Nx.",
"examples": [
{
"command": "nx g app myapp --directory=myorg",
"description": "Generate `apps/myorg/myapp` and `apps/myorg/myapp-e2e`"
},
{
"command": "nx g app myapp --classComponent",
"description": "Use class components instead of functional components"
},
{
"command": "nx g app myapp --routing",
"description": "Set up React Router"
}
],
"examplesFile": "../../../docs/application-examples.md",
"properties": {
"bundler": {
"default": "webpack",
"description": "The bundler to use.",
"enum": [
"vite",
"webpack"
],
"type": "string",
"x-priority": "important",
"x-prompt": "Which bundler do you want to use to build the application?"
},
"classComponent": {
"alias": "C",
"default": false,
"description": "Use class components instead of functional component.",
"type": "boolean"
},
"compiler": {
"default": "babel",
"description": "The compiler to use.",
"enum": [
"babel",
"swc"
],
"type": "string"
},
"directory": {
"alias": "dir",
"description": "The directory of the new application.",
"type": "string",
"x-priority": "important"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (E2E) tests.",
"enum": [
"cypress",
"none"
],
"type": "string"
},
"globalCss": {
"default": false,
"description": "Default is `false`. When `true`, the component is generated with `*.css`/`*.scss` instead of `*.module.css`/`*.module.scss`.",
"type": "boolean"
},
"inSourceTests": {
"default": false,
"description": "When using Vitest, separate spec files will not be generated and instead will be included within the source files. Read more on the Vitest docs site: https://vitest.dev/guide/in-source.html",
"type": "boolean"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"minimal": {
"default": false,
"description": "Generate a React app with a minimal setup, no separate test files.",
"type": "boolean"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use for the application?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. `App.tsx`).",
"type": "boolean"
},
"rootProject": {
"default": false,
"description": "Create a application at the root of the workspace",
"hidden": true,
"type": "boolean"
},
"routing": {
"default": false,
"description": "Generate application with routes.",
"type": "boolean",
"x-prompt": "Would you like to add React Router to this application?"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"skipWorkspaceJson": {
"default": false,
"description": "Skip updating `workspace.json` with default options based on values provided to this app (e.g. babel, style).",
"type": "boolean",
"x-priority": "internal"
},
"strict": {
"default": true,
"description": "Creates an application with strict mode and strict type checking.",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
},
{
"label": "Stylus(.styl) [ http://stylus-lang.com ] (DEPRECATED)",
"value": "styl"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"vitest",
"none"
],
"type": "string"
}
},
"required": [],
"title": "Create a React Application",
"type": "object"
} | MIT | en |
nrwl/nx | b8162c4a17be7de1e5ac394b52720af43fcf0ac4 | 2021-06-15T12:13:56 | packages/angular/src/generators/stories/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxAngularStorybookStoriesGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"properties": {
"cypressProject": {
"description": "The Cypress project to generate the stories under. This is inferred from 'name' by default.",
"type": "string"
},
"generateCypressSpecs": {
"description": "Specifies whether to automatically generate *.spec.ts files in the cypress e2e app generated by the cypress-configure generator.",
"type": "boolean",
"x-prompt": "Do you want to generate Cypress specs as well?"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Library or application name.",
"type": "string",
"x-prompt": "What's the name of the project for which you want to generate stories?"
}
},
"required": [
"name"
],
"type": "object"
} | MIT | en |
nrwl/nx | fb54f6758103973b530cc729a04df12e5a5c8a3f | 2023-04-20T18:35:04 | packages/plugin/src/generators/lint-checks/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "PluginLint",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Adds linting configuration to validate common json files for nx plugins.",
"properties": {
"projectName": {
"$default": {
"$source": "projectName"
},
"description": "Which project should be the configuration be added to?",
"type": "string",
"x-priority": "important"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files with prettier.",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [
"projectName"
],
"title": "",
"type": "object"
} | MIT | en |
nrwl/nx | d9aef75bd564cb2cec0bdbb5929b63bef2a65585 | 2021-02-11T02:30:55 | packages/react/src/generators/component-cypress-spec/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"id": "component-cypress-spec",
"properties": {
"componentPath": {
"description": "Relative path to the component file from the library root?",
"examples": [
"lib/components"
],
"type": "string",
"x-prompt": "What's path of the component relative to the project's lib root for which to generate a test?"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"project": {
"$default": {
"$source": "projectName",
"index": 0
},
"description": "The project name for which to generate tests.",
"examples": [
"shared-ui-component"
],
"type": "string",
"x-prompt": "What's name of the project for which to generate tests?"
}
},
"required": [
"project",
"componentPath"
],
"type": "object"
} | MIT | en |
nrwl/nx | 047dc22aed99ee0870357fa1508cd5decb8009a7 | 2024-01-16T14:29:44 | packages/detox/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"description": "Add Detox Schematics.",
"properties": {
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [],
"title": "Add Detox Schematics",
"type": "object"
} | MIT | en |
nrwl/nx | 7fc5d6fd8f03c8bbf97b2d3fef02a3f0605269a1 | 2021-07-05T19:50:16 | packages/web/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWebApp",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"properties": {
"babelJest": {
"default": false,
"description": "Use babel instead ts-jest",
"type": "boolean"
},
"directory": {
"description": "The directory of the new application.",
"type": "string"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (e2e) tests",
"enum": [
"cypress",
"none"
],
"type": "string"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"tslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the application?"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint \"parserOptions.project\" option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files",
"type": "boolean"
},
"standaloneConfig": {
"default": false,
"description": "Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json",
"type": "boolean"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "Stylus(.styl)[ http://stylus-lang.com ]",
"value": "styl"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"description": "Add tags to the application (used for linting)",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [],
"title": "Create a Web Application for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | bf2c79bc010f05b9ac2e2dc01fafba809127cd2d | 2022-08-02T13:11:49 | packages/react/src/generators/setup-tailwind/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactTailwindSetupGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Adds the Tailwind CSS configuration files for a given React project and installs, if needed, the packages required for Tailwind CSS to work.",
"examples": [
{
"command": "nx g setup-tailwind --project=my-app",
"description": "Initialize Tailwind configuration for the `my-app` project."
}
],
"properties": {
"buildTarget": {
"default": "build",
"description": "The name of the target used to build the project. This option is not needed in most cases.",
"type": "string"
},
"project": {
"$default": {
"$source": "argv",
"index": 0
},
"alias": "p",
"description": "The name of the project to add the Tailwind CSS setup for.",
"type": "string",
"x-dropdown": "project",
"x-prompt": "What project would you like to add the Tailwind CSS setup?"
},
"skipFormat": {
"description": "Skips formatting the workspace after the generator completes.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
}
},
"required": [
"project"
],
"title": "Configures Tailwind CSS for an application or a buildable/publishable library.",
"type": "object"
} | MIT | en |
nrwl/nx | e5212ec4430c5905df957f0f15f0d2a348848b42 | 2022-03-25T19:08:08 | packages/react/src/generators/hook/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactHook",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a React component using Hooks in a dedicated React project.",
"examples": [
{
"command": "nx g hook my-hook --project=mylib",
"description": "Generate a hook in the `mylib` library"
}
],
"properties": {
"directory": {
"alias": "d",
"description": "Create the hook under this directory (can be nested).",
"type": "string"
},
"export": {
"alias": "e",
"default": false,
"description": "When true, the hook is exported from the project `index.ts` (if it exists).",
"type": "boolean",
"x-prompt": "Should this hook be exported in the project?"
},
"flat": {
"default": false,
"description": "Create hook at the source root rather than its own directory.",
"type": "boolean"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the hook.",
"type": "string",
"x-prompt": "What name would you like to use for the hook?"
},
"pascalCaseDirectory": {
"alias": "R",
"default": false,
"description": "Use pascal case directory name (e.g. `useHook/useHook.ts`).",
"type": "boolean"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case hook file name (e.g. `useHook.ts`).",
"type": "boolean"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The name of the project.",
"type": "string",
"x-prompt": "What is the name of the project for this hook?"
},
"skipTests": {
"default": false,
"description": "When true, does not create `spec.ts` test files for the new hook.",
"type": "boolean"
}
},
"required": [
"name",
"project"
],
"title": "Create a React Hook for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | 6dae32cc3af4f76f4de7f296a7c7c34ecfc1d62b | 2022-03-24T16:00:06 | packages/node/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "SchematicsNxNodeApp",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Nx Application Options Schema.",
"properties": {
"babelJest": {
"default": false,
"description": "Use `babel` instead of `ts-jest`.",
"type": "boolean"
},
"directory": {
"description": "The directory of the new application.",
"type": "string"
},
"frontendProject": {
"description": "Frontend project that needs to access this application. This sets up proxy configuration.",
"type": "string"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"tslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"type": "string",
"x-prompt": "What name would you like to use for the node application?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case file names.",
"type": "boolean"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
},
"standaloneConfig": {
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean"
},
"tags": {
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [],
"title": "Nx Application Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | 3b384c78ac3d94b92b1233c251edcdcf203a5826 | 2024-02-14T17:51:37 | packages/react/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactApp",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Create a React application for Nx.",
"examples": [
{
"command": "nx g app myapp --directory=myorg",
"description": "Generate `apps/myorg/myapp` and `apps/myorg/myapp-e2e`"
},
{
"command": "nx g app myapp --classComponent",
"description": "Use class components instead of functional components"
},
{
"command": "nx g app myapp --routing",
"description": "Set up React Router"
}
],
"examplesFile": "../../../docs/application-examples.md",
"properties": {
"bundler": {
"default": "webpack",
"description": "The bundler to use.",
"enum": [
"vite",
"webpack",
"rspack"
],
"type": "string",
"x-priority": "important",
"x-prompt": "Which bundler do you want to use to build the application?"
},
"classComponent": {
"alias": "C",
"default": false,
"description": "Use class components instead of functional component.",
"type": "boolean"
},
"compiler": {
"default": "babel",
"description": "The compiler to use.",
"enum": [
"babel",
"swc"
],
"type": "string"
},
"directory": {
"alias": "dir",
"description": "The directory of the new application.",
"type": "string",
"x-priority": "important"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (E2E) tests.",
"enum": [
"cypress",
"playwright",
"none"
],
"type": "string",
"x-prompt": "Which E2E test runner would you like to use?"
},
"globalCss": {
"default": false,
"description": "Default is `false`. When `true`, the component is generated with `*.css`/`*.scss` instead of `*.module.css`/`*.module.scss`.",
"type": "boolean"
},
"inSourceTests": {
"default": false,
"description": "When using Vitest, separate spec files will not be generated and instead will be included within the source files. Read more on the Vitest docs site: https://vitest.dev/guide/in-source.html",
"type": "boolean"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"minimal": {
"default": false,
"description": "Generate a React app with a minimal setup, no separate test files.",
"type": "boolean"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"pattern": "^[a-zA-Z][^:]*$",
"type": "string",
"x-prompt": "What name would you like to use for the application?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. `App.tsx`).",
"type": "boolean"
},
"projectNameAndRootFormat": {
"description": "Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"rootProject": {
"default": false,
"description": "Create a application at the root of the workspace",
"hidden": true,
"type": "boolean"
},
"routing": {
"default": false,
"description": "Generate application with routes.",
"type": "boolean",
"x-prompt": "Would you like to add React Router to this application?"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipNxJson": {
"default": false,
"description": "Skip updating `nx.json` with default options based on values provided to this app.",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"strict": {
"default": true,
"description": "Creates an application with strict mode and strict type checking.",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ https://sass-lang.com ]",
"value": "scss"
},
{
"label": "LESS [ https://lesscss.org ]",
"value": "less"
},
{
"label": "tailwind [ https://tailwindcss.com/ ]",
"value": "tailwind"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"vitest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Create a React Application",
"type": "object"
} | MIT | en |
nrwl/nx | 6e72dc6c1240f614b463fa79489af8ca46d0fabb | 2022-04-26T18:31:59 | packages/react-native/src/generators/upgrade-native/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactNativeUpgradeNativeConfigure",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Upgrade native iOS and Android code to latest.",
"properties": {
"displayName": {
"description": "The display name to show in the application. Defaults to name.",
"type": "string"
},
"e2eTestRunner": {
"default": "detox",
"description": "Adds the specified e2e test runner.",
"enum": [
"detox",
"none"
],
"type": "string"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files",
"type": "boolean"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Project name.",
"type": "string"
}
},
"required": [
"name"
],
"title": "React native upgrade native configuration",
"type": "object"
} | MIT | en |
nrwl/nx | e8e8f94f7a33f1b92a52ba7f08b1ca7566dbe85e | 2023-11-10T16:22:43 | packages/vue/src/generators/storybook-configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxVueStorybookConfigure",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Set up Storybook for a Vue project.",
"examplesFile": "../../../docs/storybook-configuration-examples.md",
"properties": {
"configureStaticServe": {
"default": true,
"description": "Specifies whether to configure a static file server target for serving storybook. Helpful for speeding up CI build/test times.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Configure a static file server for the storybook instance?"
},
"generateStories": {
"default": true,
"description": "Automatically generate `*.stories.ts` files for components declared in this project?",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Automatically generate *.stories.ts files for components declared in this project?"
},
"ignorePaths": {
"default": [
"*.stories.ts,*.stories.tsx,*.stories.js,*.stories.jsx,*.stories.mdx"
],
"description": "Paths to ignore when looking for components.",
"examples": [
"apps/my-app/src/not-stories/**",
"**/**/src/**/not-stories/**",
"libs/my-lib/**/*.something.ts",
"**/**/src/**/*.other.*",
"libs/my-lib/src/not-stories/**,**/**/src/**/*.other.*,apps/my-app/**/*.something.ts"
],
"items": {
"description": "Path to ignore.",
"type": "string"
},
"type": "array"
},
"interactionTests": {
"alias": [
"configureTestRunner"
],
"default": true,
"description": "Set up Storybook interaction tests.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Do you want to set up Storybook interaction tests?"
},
"js": {
"default": false,
"description": "Generate JavaScript story files rather than TypeScript story files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"project": {
"$default": {
"$source": "argv",
"index": 0
},
"aliases": [
"name",
"projectName"
],
"description": "Project for which to generate Storybook configuration.",
"type": "string",
"x-dropdown": "projects",
"x-priority": "important",
"x-prompt": "For which project do you want to generate Storybook configuration?"
},
"tsConfiguration": {
"default": true,
"description": "Configure your project with TypeScript. Generate main.ts and preview.ts files, instead of main.js and preview.js.",
"type": "boolean"
}
},
"required": [
"project"
],
"title": "Vue Storybook Configure",
"type": "object"
} | MIT | en |
nrwl/nx | 726877d103fdd4e2e7694bb86938798842df1417 | 2021-12-15T17:23:50 | packages/js/src/generators/convert-to-swc/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxTypescriptLibrary",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"examples": [
{
"command": "g swc mylib",
"description": "Convert libs/myapp/mylib to swc"
}
],
"properties": {
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Library name",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the library?"
},
"targets": {
"default": [
"build"
],
"description": "List of targets to convert",
"items": {
"description": "Target to convert",
"type": "string"
},
"type": "array"
}
},
"required": [
"name"
],
"title": "Convert a tsc library to swc",
"type": "object"
} | MIT | en |
nrwl/nx | 9396db03c3b3844ef407d3819d984e2b9097537a | 2022-04-12T11:39:24 | packages/angular/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "GeneratorNxApp",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"properties": {
"addTailwind": {
"default": false,
"description": "Whether to configure Tailwind CSS for the application.",
"type": "boolean"
},
"backendProject": {
"description": "Backend project that provides data to this application. This sets up `proxy.config.json`.",
"type": "string"
},
"directory": {
"description": "The directory of the new application.",
"type": "string"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (E2E) tests.",
"enum": [
"protractor",
"cypress",
"none"
],
"type": "string"
},
"federationType": {
"default": "static",
"description": "Use either Static or Dynamic Module Federation pattern for the application.",
"enum": [
"static",
"dynamic"
],
"type": "string",
"x-deprecated": "Use the `mfe-host` or `mfe-remote` generators instead. Support for generating MFE applications using the application generator will be removed in an upcoming version."
},
"host": {
"description": "The name of the host application that the remote application will be consumed by.",
"type": "string",
"x-deprecated": "Use the `mfe-host` or `mfe-remote` generators instead. Support for generating MFE applications using the application generator will be removed in an upcoming version."
},
"inlineStyle": {
"alias": "s",
"default": false,
"description": "Specifies if the style will be in the ts file.",
"type": "boolean"
},
"inlineTemplate": {
"alias": "t",
"default": false,
"description": "Specifies if the template will be in the ts file.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"mfe": {
"default": false,
"description": "Generate a Module Federation configuration for the application",
"type": "boolean",
"x-deprecated": "Use the `mfe-host` or `mfe-remote` generators instead. Support for generating MFE applications using the application generator will be removed in an upcoming version."
},
"mfeType": {
"default": "remote",
"description": "Type of application to generate the Module Federation configuration for.",
"enum": [
"host",
"remote"
],
"type": "string",
"x-deprecated": "Use the `mfe-host` or `mfe-remote` generators instead. Support for generating MFE applications using the application generator will be removed in an upcoming version."
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the application?"
},
"port": {
"description": "The port at which the remote application should be served.",
"type": "number"
},
"prefix": {
"alias": "p",
"description": "The prefix to apply to generated selectors.",
"format": "html-selector",
"type": "string"
},
"remotes": {
"description": "A list of remote application names that the host application should consume.",
"type": "array",
"x-deprecated": "Use the `mfe-host` or `mfe-remote` generators instead. Support for generating MFE applications using the application generator will be removed in an upcoming version."
},
"routing": {
"default": false,
"description": "Generate a routing module.",
"type": "boolean",
"x-prompt": "Would you like to configure routing for this application?"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
},
"skipTests": {
"alias": "S",
"default": false,
"description": "Skip creating spec files.",
"type": "boolean"
},
"standaloneConfig": {
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Create an application with stricter type checking and build optimization options.",
"type": "boolean"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"enum": [
"css",
"scss",
"sass",
"less"
],
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "SASS(.sass) [ http://sass-lang.com ]",
"value": "sass"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"karma",
"jest",
"none"
],
"type": "string"
},
"viewEncapsulation": {
"description": "Specifies the view encapsulation strategy.",
"enum": [
"Emulated",
"None",
"ShadowDom"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Creates an Angular application.",
"type": "object"
} | MIT | en |
nrwl/nx | fb54f6758103973b530cc729a04df12e5a5c8a3f | 2023-04-20T18:35:04 | packages/plugin/src/generators/create-package/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxPluginCreatePackage",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a framework package that uses Nx CLI.",
"properties": {
"compiler": {
"default": "tsc",
"description": "The compiler used by the build and test targets.",
"enum": [
"tsc",
"swc"
],
"type": "string"
},
"directory": {
"description": "A directory where the app is placed.",
"type": "string"
},
"e2eTestRunner": {
"default": "jest",
"description": "Test runner to use for end to end (E2E) tests.",
"enum": [
"jest",
"none"
],
"type": "string"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The package name of cli, e.g. `create-framework-package`. Note this must be a valid NPM name to be published.",
"type": "string",
"x-priority": "important"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The name of the generator project.",
"type": "string",
"x-priority": "important",
"x-prompt": "What is the name of the project for the generator?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"tags": {
"alias": "t",
"description": "Add tags to the library (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name",
"project"
],
"title": "Create a framework package",
"type": "object"
} | MIT | en |
nrwl/nx | 9940a0c54467414f0b6365286d4ca5d625ddc1ad | 2023-07-07T16:43:29 | packages/cypress/src/generators/configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxCypressE2EConfigGenerator",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Add a Cypress configuration to an existing project.",
"examplesFile": "../../../docs/cypress-e2e-config-examples.md",
"properties": {
"baseUrl": {
"description": "The address (with the port) which your application is running on. If you wish to start your application when running the e2e target, then use --devServerTarget instead.",
"type": "string"
},
"bundler": {
"default": "webpack",
"description": "The Cypress bundler to use.",
"enum": [
"vite",
"webpack",
"none"
],
"type": "string",
"x-prompt": "Which Cypress bundler do you want to use?"
},
"devServerTarget": {
"description": "A devServerTarget,'<projectName>:<targetName>[:<configName>], that will be used to run tests against. This is usually the app this project will be used in. Pass --baseUrl if you wish to not use a devServerTarget.",
"type": "string",
"x-priority": "important"
},
"directory": {
"default": "cypress",
"description": "A directory where the project is placed relative from the project root",
"type": "string",
"x-priority": "important"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"port": {
"description": "Set the 'port' option on the e2e target. It's recommend to set a different port so you can run tests e2e targets in parallel. Most dev servers support using '0' to automatically find a free port. The value 'cypress-auto' can be used if the underlying dev server does not support automatically finding a free port.",
"oneOf": [
{
"enum": [
"cypress-auto"
],
"type": "string"
},
{
"type": "number"
}
],
"x-priority": "important"
},
"project": {
"$default": {
"$source": "projectName"
},
"description": "The project to add a Cypress configuration to",
"type": "string",
"x-priority": "important",
"x-prompt": "What project do you want to add Cypress to?"
},
"rootProject": {
"default": false,
"description": "Create a application at the root of the workspace",
"hidden": true,
"type": "boolean",
"x-priority": "internal"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [
"project"
],
"title": "Add a Cypress Configuration.",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/remix/src/generators/setup/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxRemixSetup",
"$schema": "https://json-schema.org/schema",
"description": "Generate initial files required for Remix to work within the workspace.",
"properties": {
"packageManager": {
"description": "The package manager to setup for",
"enum": [
"yarn",
"npm",
"pnpm"
],
"type": "string"
}
},
"title": "",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/web/src/generators/static-serve/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWebStaticServe",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Add a new serve target to serve a build apps static files. This allows for faster serving of the static build files by reusing the case. Helpful when reserving the app over and over again like in e2e tests.",
"properties": {
"buildTarget": {
"description": "Name of the build target to serve",
"type": "string"
},
"outputPath": {
"description": "Path to the directory of the built files. This is only needed if buildTarget doesn't specify an outputPath executor option.",
"type": "string"
},
"targetName": {
"default": "serve-static",
"description": "Name of the serve target to add. Defaults to 'serve-static'.",
"type": "string"
}
},
"required": [
"buildTarget"
],
"title": "Static Serve Configuration",
"type": "object"
} | MIT | en |
nrwl/nx | deb0f1a49294eafe18c407a96c95e40af15d3738 | 2024-01-30T21:29:05 | packages/react/src/generators/component/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactComponent",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Create a React Component for Nx.",
"examplesFile": "../../../docs/component-examples.md",
"properties": {
"classComponent": {
"alias": "C",
"default": false,
"description": "Use class components instead of functional component.",
"type": "boolean"
},
"directory": {
"alias": "dir",
"description": "The directory at which to create the component file. When `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. Otherwise, it will be relative to the project root.",
"type": "string",
"x-priority": "important"
},
"export": {
"alias": "e",
"default": false,
"description": "When true, the component is exported from the project `index.ts` (if it exists).",
"type": "boolean",
"x-prompt": "Should this component be exported in the project?"
},
"fileName": {
"description": "Create a component with this file name.",
"type": "string"
},
"flat": {
"default": false,
"description": "Create component at the source root rather than its own directory.",
"type": "boolean",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. This option will be removed in Nx v19."
},
"globalCss": {
"default": false,
"description": "Default is `false`. When `true`, the component is generated with `*.css`/`*.scss` instead of `*.module.css`/`*.module.scss`.",
"type": "boolean"
},
"inSourceTests": {
"default": false,
"description": "When using Vitest, separate spec files will not be generated and instead will be included within the source files. Read more on the Vitest docs site: https://vitest.dev/guide/in-source.html",
"type": "boolean"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the component.",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use for the component?"
},
"nameAndDirectoryFormat": {
"description": "Whether to generate the component in the directory as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"pascalCaseDirectory": {
"alias": "R",
"default": false,
"description": "Use pascal case directory name (e.g. `App/App.tsx`).",
"type": "boolean",
"x-deprecated": "Provide the `directory` in pascal-case and use the `as-provided` format. This option will be removed in Nx v19."
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. `App.tsx`).",
"type": "boolean",
"x-deprecated": "Provide the `name` in pascal-case and use the `as-provided` format. This option will be removed in Nx v19."
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The name of the project.",
"type": "string",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v19."
},
"routing": {
"description": "Generate a library with routes.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipTests": {
"default": false,
"description": "When true, does not create `spec.ts` test files for the new component.",
"type": "boolean",
"x-priority": "internal"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ https://sass-lang.com ]",
"value": "scss"
},
{
"label": "LESS [ https://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
}
},
"required": [
"name"
],
"title": "Create a React Component",
"type": "object"
} | MIT | en |
nrwl/nx | deb0f1a49294eafe18c407a96c95e40af15d3738 | 2024-01-30T21:29:05 | packages/plugin/src/generators/migration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxPluginMigration",
"$schema": "https://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create a Migration for an Nx Plugin.",
"examples": [
{
"command": "nx g migration my-migration --project=my-plugin --version=1.0.0",
"description": "Adds a new migration to the project `my-plugin`, which will be triggered when migrating to version 1.0.0 or above from a previous version."
}
],
"properties": {
"description": {
"description": "Migration description.",
"type": "string"
},
"directory": {
"aliases": [
"dir"
],
"description": "The directory at which to create the migration file. When `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. Otherwise, it will be relative to the workspace root.",
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Migration name.",
"type": "string",
"x-priority": "important"
},
"nameAndDirectoryFormat": {
"description": "Whether to generate the migration in the directory as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"packageJsonUpdates": {
"alias": "p",
"default": false,
"description": "Whether or not to include `package.json` updates.",
"type": "boolean"
},
"packageVersion": {
"alias": "v",
"description": "Version to use for the migration.",
"type": "string",
"x-priority": "important",
"x-prompt": "What version would you like to use for the migration?"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The name of the project.",
"type": "string",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v19."
},
"skipLintChecks": {
"default": false,
"description": "Do not eslint configuration for plugin json files.",
"type": "boolean"
}
},
"required": [
"packageVersion"
],
"title": "Create a Migration for an Nx Plugin",
"type": "object"
} | MIT | en |
nrwl/nx | 5b7dba1cb78cabcf631129b4ce8163406b9c1328 | 2022-12-02T16:58:07 | packages/react/src/generators/library/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactLibrary",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a React Library for an Nx workspace.",
"examples": [
{
"command": "nx g lib mylib --directory=myapp",
"description": "Generate `libs/myapp/mylib`"
},
{
"command": "nx g lib mylib --appProject=myapp",
"description": "Generate a library with routes and add them to `myapp`"
}
],
"properties": {
"appProject": {
"alias": "a",
"description": "The application project to add the library route to.",
"type": "string"
},
"buildable": {
"default": false,
"description": "Generate a buildable library that uses rollup to bundle. Use 'bundler' option instead for greater control (none, vite, rollup).",
"type": "boolean",
"x-deprecated": true
},
"bundler": {
"default": "none",
"description": "The bundler to use. Choosing 'none' means this library is not buildable.",
"enum": [
"none",
"vite",
"rollup"
],
"type": "string",
"x-prompt": "Which bundler would you like to use to build the library? Choose 'none' to skip build setup."
},
"compiler": {
"default": "babel",
"description": "Which compiler to use. Only applies to `bundler: 'rollup'`.",
"enum": [
"babel",
"swc"
],
"type": "string"
},
"component": {
"default": true,
"description": "Generate a default component.",
"type": "boolean"
},
"directory": {
"alias": "dir",
"description": "A directory where the lib is placed.",
"type": "string"
},
"globalCss": {
"default": false,
"description": "When `true`, the stylesheet is generated using global CSS instead of CSS modules (e.g. file is `*.css` rather than `*.module.css`).",
"type": "boolean"
},
"importPath": {
"description": "The library name used to import it, like `@myorg/my-awesome-lib`.",
"type": "string"
},
"inSourceTests": {
"default": false,
"description": "When using Vitest, separate spec files will not be generated and instead will be included within the source files.",
"type": "boolean"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"minimal": {
"default": false,
"description": "Create a React library with a minimal setup, no separate test files.",
"type": "boolean"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Library name",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the library?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. `App.tsx`).",
"type": "boolean"
},
"publishable": {
"description": "Create a publishable library.",
"type": "boolean"
},
"routing": {
"description": "Generate library with routes.",
"type": "boolean"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean"
},
"skipTsConfig": {
"default": false,
"description": "Do not update `tsconfig.json` for development experience.",
"type": "boolean"
},
"standaloneConfig": {
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Whether to enable tsconfig strict mode or not.",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "Stylus(.styl) [ http://stylus-lang.com ]",
"value": "styl"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the library (used for linting).",
"type": "string"
},
"unitTestRunner": {
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"vitest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Create a React Library",
"type": "object"
} | MIT | en |
nrwl/nx | 7192141c44b2c72fc14156ecaa22f4b105b1f1df | 2024-01-18T15:56:54 | packages/react/src/generators/remote/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "GeneratorReactRemote",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create Module Federation configuration files for given React Remote Application.",
"properties": {
"classComponent": {
"alias": "C",
"default": false,
"description": "Use class components instead of functional component.",
"type": "boolean"
},
"compiler": {
"default": "babel",
"description": "The compiler to use.",
"enum": [
"babel",
"swc"
],
"type": "string"
},
"devServerPort": {
"description": "The port for the dev server of the remote app.",
"type": "number",
"x-priority": "important"
},
"directory": {
"alias": "dir",
"description": "The directory of the new application.",
"type": "string",
"x-priority": "important"
},
"dynamic": {
"default": false,
"description": "Should the host application use dynamic federation?",
"type": "boolean",
"x-priority": "internal"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (e2e) tests.",
"enum": [
"cypress",
"playwright",
"none"
],
"type": "string"
},
"globalCss": {
"default": false,
"description": "Default is false. When true, the component is generated with *.css/*.scss instead of *.module.css/*.module.scss.",
"type": "boolean"
},
"host": {
"description": "The host / shell application for this remote.",
"type": "string",
"x-priority": "important"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the remote application to generate the Module Federation configuration",
"pattern": "^[a-zA-Z][^:]*$",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use as the remote application?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. App.tsx).",
"type": "boolean"
},
"projectNameAndRootFormat": {
"description": "Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"routing": {
"default": false,
"description": "Generate application with routes.",
"type": "boolean"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint \"parserOptions.project\" option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipNxJson": {
"default": false,
"description": "Skip updating workspace.json with default options based on values provided to this app (e.g. babel, style).",
"type": "boolean",
"x-priority": "internal"
},
"ssr": {
"default": false,
"description": "Whether to configure SSR for the host application",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Creates an application with strict mode and strict type checking.",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"typescriptConfiguration": {
"default": true,
"description": "Whether the module federation configuration and webpack configuration files should use TS.",
"type": "boolean"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Generate Module Federation Setup for React Remote App",
"type": "object"
} | MIT | en |
nrwl/nx | 8dec11ecbe981d82157473647aa038c85705c680 | 2023-05-02T17:43:26 | packages/workspace/src/generators/preset/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWorkspacePreset",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Creates applications in a new workspace.",
"properties": {
"bundler": {
"default": "vite",
"description": "The bundler to use for building the application.",
"enum": [
"webpack",
"vite",
"rspack",
"esbuild"
],
"type": "string"
},
"docker": {
"default": false,
"description": "Generate a Dockerfile",
"type": "boolean"
},
"e2eTestRunner": {
"description": "The tool to use for running e2e tests.",
"enum": [
"cypress",
"jest",
"detox",
"none"
],
"type": "string"
},
"framework": {
"description": "The framework which the application is using",
"enum": [
"express",
"koa",
"fastify",
"nest",
"none"
],
"type": "string"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"description": "The name of the application.",
"type": "string"
},
"nextAppDir": {
"default": false,
"description": "Enable experimental app/ for the project",
"type": "boolean"
},
"npmScope": {
"description": "Npm scope for importing libs.",
"type": "string"
},
"packageManager": {
"description": "The package manager used to install dependencies.",
"enum": [
"npm",
"yarn",
"pnpm"
],
"type": "string"
},
"preset": {
"description": "The name of the preset.",
"type": "string"
},
"routing": {
"default": true,
"description": "Add routing to the generated application.",
"type": "boolean"
},
"standaloneApi": {
"default": false,
"description": "Use Standalone Components if generating an Angular application.",
"type": "boolean"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configurations into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
}
},
"required": [
"preset",
"name"
],
"title": "Creates applications in a new workspace",
"type": "object"
} | MIT | en |
nrwl/nx | 212fb00548ee91d56ba01ed03cd5abd605b803aa | 2021-03-25T00:11:32 | packages/web/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"id": "NxWebApp",
"properties": {
"babelJest": {
"default": false,
"description": "Use babel instead ts-jest",
"type": "boolean"
},
"directory": {
"description": "The directory of the new application.",
"type": "string"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (e2e) tests",
"enum": [
"cypress",
"none"
],
"type": "string"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"tslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the application?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files",
"type": "boolean"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "Stylus(.styl)[ http://stylus-lang.com ]",
"value": "styl"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"description": "Add tags to the application (used for linting)",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [],
"title": "Create a Web Application for Nx",
"type": "object"
} | MIT | en |
nrwl/nx | f1911a71f3ccecd26ecde0c1c1c765e89df04e17 | 2021-06-23T00:30:38 | packages/storybook/src/generators/cypress-project/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "cypress-configure",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"properties": {
"directory": {
"description": "A directory where the project is placed",
"type": "string"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"tslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Library or application name",
"type": "string"
},
"standaloneConfig": {
"default": false,
"description": "Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
} | MIT | en |
nrwl/nx | 79f5fc3108dead7f87011e41b3ad35656e2d579c | 2023-03-08T16:42:09 | packages/node/src/generators/application/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "SchematicsNxNodeApp",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Nx Application Options Schema.",
"properties": {
"babelJest": {
"default": false,
"description": "Use `babel` instead of `ts-jest`.",
"type": "boolean"
},
"bundler": {
"default": "esbuild",
"description": "Bundler which is used to package the application",
"enum": [
"esbuild",
"webpack"
],
"type": "string",
"x-priority": "important"
},
"directory": {
"description": "The directory of the new application.",
"type": "string",
"x-priority": "important"
},
"docker": {
"description": "Add a docker build target",
"type": "boolean"
},
"e2eTestRunner": {
"default": "jest",
"description": "Test runner to use for end to end (e2e) tests",
"enum": [
"jest",
"none"
],
"type": "string"
},
"framework": {
"default": "none",
"description": "Generate the node application using a framework",
"enum": [
"express",
"fastify",
"koa",
"nest",
"none"
],
"type": "string",
"x-priority": "important",
"x-prompt": "Which framework do you want to use?"
},
"frontendProject": {
"description": "Frontend project that needs to access this application. This sets up proxy configuration.",
"type": "string",
"x-priority": "important"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application.",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use for the node application?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case file names.",
"type": "boolean"
},
"port": {
"default": 3000,
"description": "The port which the server will be run on",
"type": "number"
},
"rootProject": {
"default": false,
"description": "Create node application at the root of the workspace",
"hidden": true,
"type": "boolean",
"x-priority": "internal"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"tags": {
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Nx Application Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | deb0f1a49294eafe18c407a96c95e40af15d3738 | 2024-01-30T21:29:05 | packages/nest/src/generators/controller/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestControllerGenerator",
"$schema": "https://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Nest Controller Options Schema.",
"properties": {
"directory": {
"aliases": [
"dir",
"path"
],
"description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.",
"type": "string"
},
"flat": {
"default": false,
"description": "Flag to indicate if a directory is created.",
"type": "boolean",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19."
},
"language": {
"description": "Nest controller language.",
"enum": [
"js",
"ts"
],
"type": "string"
},
"module": {
"description": "Allows specification of the declaring module.",
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the controller.",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"nameAndDirectoryFormat": {
"description": "Whether to generate the component in the directory as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The Nest project to target.",
"type": "string",
"x-deprecated": "Provide The `directory` option instead and use the `as-provided` format. the project will be determined from the directory provided. it will be removed in nx v19."
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipImport": {
"default": false,
"description": "Flag to skip the module import.",
"type": "boolean"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Nest Controller Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/next/src/generators/cypress-component-configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "CypressComponentConfiguration",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Add Cypress Componet Testing to an existing NextJS project.",
"examples": [
{
"command": "nx g @nx/next:cypress-component-configuration --project=my-next-project",
"description": "Add component testing to your Next project"
},
{
"command": "nx g @nx/next:cypress-component-configuration --project=my-next-project --generate-tests",
"description": "Add component testing to your Next project and generate component tests for your existing components"
}
],
"examplesFile": "../../../docs/cypress-component-configuration-examples.md",
"properties": {
"generateTests": {
"default": false,
"description": "Generate default component tests for existing components in the project",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Automatically generate tests for components declared in this project?"
},
"project": {
"description": "The name of the project to add cypress component testing configuration to",
"type": "string",
"x-dropdown": "projects",
"x-priority": "important",
"x-prompt": "What project should we add Cypress component testing to?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [
"project"
],
"title": "NextJS Component Testing Configuration",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/js/src/generators/convert-to-swc/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxTypescriptLibrary",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Convert a TSC library to SWC.",
"examples": [
{
"command": "nx g swc mylib",
"description": "Convert `libs/myapp/mylib` to SWC."
}
],
"properties": {
"project": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Library name.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use for the library?"
},
"targets": {
"default": [
"build"
],
"description": "List of targets to convert.",
"items": {
"description": "Target to convert.",
"type": "string"
},
"type": "array"
}
},
"required": [
"project"
],
"title": "Convert a TSC library to SWC",
"type": "object"
} | MIT | en |
nrwl/nx | 06a885aca2db9967446b5b33392258e77241f312 | 2023-04-21T19:15:28 | packages/next/src/generators/cypress-component-configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "CypressComponentConfiguration",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Add Cypress Componet Testing to an existing NextJS project.",
"examples": [
{
"command": "nx g @nrwl/next:cypress-component-configuration --project=my-next-project",
"description": "Add component testing to your Next project"
},
{
"command": "nx g @nrwl/next:cypress-component-configuration --project=my-next-project --generate-tests",
"description": "Add component testing to your Next project and generate component tests for your existing components"
}
],
"examplesFile": "../../../docs/cypress-component-configuration-examples.md",
"properties": {
"generateTests": {
"default": false,
"description": "Generate default component tests for existing components in the project",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Automatically generate tests for components declared in this project?"
},
"project": {
"description": "The name of the project to add cypress component testing configuration to",
"type": "string",
"x-dropdown": "projects",
"x-priority": "important",
"x-prompt": "What project should we add Cypress component testing to?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [
"project"
],
"title": "NextJS Component Testing Configuration",
"type": "object"
} | MIT | en |
nrwl/nx | d7536aa7e3e1d87fe80f99e5255533572db0d79d | 2023-01-24T00:35:15 | packages/react/src/generators/storybook-configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactStorybookConfigure",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Set up Storybook for a React app or library.",
"examplesFile": "../../../docs/storybook-configuration-examples.md",
"properties": {
"bundler": {
"description": "The Storybook builder to use.",
"enum": [
"vite",
"webpack"
],
"x-priority": "important"
},
"configureCypress": {
"default": true,
"description": "Run the cypress-configure generator.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Configure a cypress e2e app to run against the storybook instance?"
},
"configureTestRunner": {
"description": "Add a Storybook Test-Runner target.",
"type": "boolean"
},
"cypressDirectory": {
"description": "A directory where the Cypress project will be placed. Placed at the root by default.",
"type": "string"
},
"generateCypressSpecs": {
"default": true,
"description": "Automatically generate test files in the Cypress E2E app generated by the `cypress-configure` generator.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Automatically generate test files in the Cypress E2E app generated by the cypress-configure generator?"
},
"generateStories": {
"default": true,
"description": "Automatically generate `*.stories.ts` files for components declared in this project?",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Automatically generate *.stories.ts files for components declared in this project?"
},
"ignorePaths": {
"description": "Paths to ignore when looking for components.",
"examples": [
"apps/my-app/src/not-stories/**",
"**/**/src/**/not-stories/**",
"libs/my-lib/**/*.something.ts",
"**/**/src/**/*.other.*",
"libs/my-lib/src/not-stories/**,**/**/src/**/*.other.*,apps/my-app/**/*.something.ts"
],
"items": {
"description": "Path to ignore.",
"type": "string"
},
"type": "array"
},
"js": {
"default": false,
"description": "Generate JavaScript story files rather than TypeScript story files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"aliases": [
"project",
"projectName"
],
"description": "Project for which to generate Storybook configuration.",
"type": "string",
"x-dropdown": "projects",
"x-priority": "important",
"x-prompt": "For which project do you want to generate Storybook configuration?"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"storybook7betaConfiguration": {
"default": false,
"description": "Configure your workspace to use Storybook 7, even though Storybook v7 is still in beta.",
"hidden": true,
"type": "boolean"
},
"tsConfiguration": {
"default": false,
"description": "Configure your project with TypeScript. Generate main.ts and preview.ts files, instead of main.js and preview.js.",
"type": "boolean"
}
},
"required": [
"name"
],
"title": "React Storybook Configure",
"type": "object"
} | MIT | en |
nrwl/nx | dcef0770325d40d8a41f5841c179ffeb6a1b2549 | 2024-01-16T13:44:38 | packages/remix/generators.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"extends": [
"@nx/react"
],
"generators": {
"action": {
"description": "Add an action function to an existing route",
"implementation": "./src/generators/action/action.impl",
"schema": "./src/generators/action/schema.json"
},
"application": {
"aliases": [
"app"
],
"description": "Generate a new Remix application",
"implementation": "./src/generators/application/application.impl",
"schema": "./src/generators/application/schema.json",
"x-type": "application"
},
"cypress": {
"description": "Generate a project for testing Remix apps using Cypress",
"implementation": "./src/generators/cypress/cypress.impl",
"schema": "./src/generators/cypress/schema.json"
},
"cypress-component-configuration": {
"description": "Generate a Cypress Component Testing configuration for a Remix project",
"implementation": "./src/generators/cypress-component-configuration/cypress-component-configuration.impl",
"schema": "./src/generators/cypress-component-configuration/schema.json"
},
"error-boundary": {
"description": "Add an ErrorBoundary to an existing route",
"implementation": "./src/generators/error-boundary/error-boundary.impl",
"schema": "./src/generators/error-boundary/schema.json"
},
"init": {
"description": "Initialize the `@nx/remix` plugin.",
"hidden": true,
"implementation": "./src/generators/init/init",
"schema": "./src/generators/init/schema.json"
},
"library": {
"aliases": [
"lib"
],
"description": "Generate a new library",
"implementation": "./src/generators/library/library.impl",
"schema": "./src/generators/library/schema.json",
"x-type": "library"
},
"loader": {
"description": "Add a loader function to an existing route",
"implementation": "./src/generators/loader/loader.impl",
"schema": "./src/generators/loader/schema.json"
},
"meta": {
"description": "Add a meta function to an existing route",
"implementation": "./src/generators/meta/meta.impl",
"schema": "./src/generators/meta/schema.json"
},
"preset": {
"description": "Generate a new Remix workspace",
"hidden": true,
"implementation": "./src/generators/preset/preset.impl",
"schema": "./src/generators/preset/schema.json"
},
"resource-route": {
"description": "Generate a new resource route",
"implementation": "./src/generators/resource-route/resource-route.impl",
"schema": "./src/generators/resource-route/schema.json"
},
"route": {
"description": "Generate a new route",
"implementation": "./src/generators/route/route.impl",
"schema": "./src/generators/route/schema.json"
},
"setup": {
"description": "Setup a Remix in an existing workspace",
"hidden": true,
"implementation": "./src/generators/setup/setup.impl",
"schema": "./src/generators/setup/schema.json"
},
"setup-tailwind": {
"description": "Generates a TailwindCSS configuration for the Remix application",
"implementation": "./src/generators/setup-tailwind/setup-tailwind.impl",
"schema": "./src/generators/setup-tailwind/schema.json"
},
"storybook-configuration": {
"description": "Generates a Storybook configuration for a Remix application",
"implementation": "./src/generators/storybook-configuration/storybook-configuration.impl",
"schema": "./src/generators/storybook-configuration/schema.json"
},
"style": {
"description": "Generates a new stylesheet and adds it to an existing route",
"implementation": "./src/generators/style/style.impl",
"schema": "./src/generators/style/schema.json"
}
},
"name": "NxRemix",
"version": "0.0.1"
} | MIT | en |
nrwl/nx | 1fc52349a7ccaeeb5791a4ea157ca6b5594d2439 | 2022-10-09T12:49:29 | packages/angular/src/generators/ngrx/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNgrxGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Adds NgRx support to an application or library.",
"examples": [
{
"command": "nx g @nrwl/angular:ngrx --root --module=apps/my-app/src/app/app.module.ts --facade=false placeholder",
"description": "Add root ngrx configration to the `my-app` application"
},
{
"command": "nx g @nrwl/angular:ngrx --module=libs/my-lib/src/lib/my-lib.module.ts --facade=true --root=false users",
"description": "Add a `users` state with a facade to the `my-lib` library. It will be tracked under the default `+state` folder in the lib"
}
],
"properties": {
"barrels": {
"default": false,
"description": "Use barrels to re-export actions, state and selectors.",
"type": "boolean"
},
"directory": {
"default": "+state",
"description": "The name of the folder used to contain/group the generated NgRx files.",
"type": "string"
},
"facade": {
"default": false,
"description": "Create a Facade class for the the feature.",
"type": "boolean",
"x-prompt": "Would you like to use a Facade with your NgRx state?"
},
"minimal": {
"default": true,
"description": "Only register the root state management setup or feature state.",
"type": "boolean"
},
"module": {
"description": "The path to the `NgModule` where the feature state will be registered. The host directory will create/use the new state directory.",
"type": "string",
"x-prompt": "What is the path to the module where this NgRx state should be registered?"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "Name of the NgRx feature state, such as `products` or `users`. Recommended to use the plural form of the name.",
"type": "string",
"x-prompt": "What name would you like to use for the NgRx feature state? An example would be `users`."
},
"root": {
"default": false,
"description": "Setup root or feature state management with NgRx.",
"type": "boolean",
"x-prompt": "Is this the root state of the application?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipImport": {
"default": false,
"description": "Generate NgRx feature files without registering the feature in the NgModule.",
"type": "boolean"
},
"skipPackageJson": {
"default": false,
"description": "Do not update the `package.json` with NgRx dependencies.",
"type": "boolean"
}
},
"required": [
"module",
"name"
],
"title": "Add NgRx support to an application or library.",
"type": "object"
} | MIT | en |
nrwl/nx | b9ca7ce09f8e0ac23e509c0ede27bf3e6d77abf2 | 2023-08-17T14:59:15 | packages/angular/src/generators/setup-ssr/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "GeneratorAngularUniversalSetup",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create the additional configuration required to enable SSR via Angular Universal for an Angular application.",
"properties": {
"appId": {
"default": "serverApp",
"description": "The `appId` to use with `withServerTransition`. _Note: This is only used in Angular versions <16.0.0. It's deprecated since Angular 16._",
"format": "html-selector",
"type": "string"
},
"hydration": {
"description": "Set up Hydration for the SSR application. _Note: This is only supported in Angular versions >= 16.0.0_.",
"type": "boolean"
},
"main": {
"default": "main.server.ts",
"description": "The name of the main entry-point file.",
"format": "path",
"type": "string"
},
"project": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the application to generate the Angular Universal configuration for.",
"type": "string",
"x-dropdown": "projects",
"x-prompt": "What app would you like to generate an Angular Universal configuration for?"
},
"rootModuleClassName": {
"default": "AppServerModule",
"description": "The name of the root module class.",
"type": "string"
},
"rootModuleFileName": {
"default": "app.server.module.ts",
"description": "The name of the root module file",
"format": "path",
"type": "string"
},
"serverFileName": {
"default": "server.ts",
"description": "The name of the Express server file.",
"type": "string"
},
"serverPort": {
"default": 4000,
"description": "The port for the Express server.",
"type": "number"
},
"skipFormat": {
"description": "Skip formatting the workspace after the generator completes.",
"type": "boolean",
"x-priority": "internal"
},
"standalone": {
"description": "Use Standalone Components to bootstrap SSR. _Note: This is only supported in Angular versions >= 14.1.0_.",
"type": "boolean"
}
},
"required": [
"project"
],
"title": "Generate Angular Universal (SSR) setup for an Angular App",
"type": "object"
} | MIT | en |
nrwl/nx | 67f47c287a6b571bbb6940ff31971d184bd50b8a | 2023-11-01T18:52:29 | packages/react/src/generators/federate-module/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactFederateModule",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create a federated module, which can be loaded by a remote host.",
"examples": [
{
"command": "nx g federate-module MyModule --path=./src/component/my-cmp.ts --remote=my-remote-app --remoteDirectory=apps/my-remote-app",
"description": "Create a federated module from my-remote-app, that exposes my-cmp from ./src/component/my-cmp.ts as MyModule."
}
],
"properties": {
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (e2e) tests.",
"enum": [
"cypress",
"none"
],
"type": "string"
},
"host": {
"description": "The host / shell application for this remote.",
"type": "string"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"description": "The name of the module.",
"pattern": "^[a-zA-Z][^:]*$",
"type": "string",
"x-priority": "important",
"x-prompt": "What name would you like to use for the module?"
},
"path": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The path to locate the federated module. This path should be relative to the workspace root and the file should exist.",
"type": "string",
"x-prompt": "What is the path to the module to be federated?"
},
"projectNameAndRootFormat": {
"description": "Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"remote": {
"description": "The name of the remote.",
"type": "string",
"x-prompt": "What is/should the remote be named?"
},
"remoteDirectory": {
"description": "The directory of the new remote application if one needs to be created.",
"type": "string"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"style": {
"alias": "s",
"default": "none",
"description": "The file extension to be used for style files.",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name",
"path",
"remote"
],
"title": "Federate Module",
"type": "object"
} | MIT | en |
nrwl/nx | e4758358b0cf9d3013ddfd30ae9ea387866f5144 | 2024-01-22T18:51:41 | packages/detox/src/generators/init/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$schema": "http://json-schema.org/schema",
"description": "Add Detox Schematics.",
"properties": {
"keepExistingVersions": {
"default": false,
"description": "Keep existing dependencies versions",
"type": "boolean",
"x-priority": "internal"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"updatePackageScripts": {
"default": false,
"description": "Update `package.json` scripts with inferred targets",
"type": "boolean",
"x-priority": "internal"
}
},
"required": [],
"title": "Add Detox Schematics",
"type": "object"
} | MIT | en |
nrwl/nx | 2ab66dd4104dac61a4a6c37546c5e18b53341a83 | 2023-03-09T11:28:31 | packages/angular/src/generators/remote/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxMFRemote",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create an Angular Remote Module Federation Application.",
"examples": [
{
"command": "nx g @nrwl/angular:remote appName --host=host --port=4201",
"description": "Create an Angular app with configuration in place for Module Federation. If host is provided, attach this remote app to host app's configuration."
}
],
"properties": {
"addTailwind": {
"default": false,
"description": "Whether to configure Tailwind CSS for the application.",
"type": "boolean"
},
"backendProject": {
"description": "Backend project that provides data to this application. This sets up `proxy.config.json`.",
"type": "string"
},
"directory": {
"description": "The directory of the new application.",
"type": "string"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (E2E) tests.",
"enum": [
"protractor",
"cypress",
"none"
],
"type": "string"
},
"host": {
"description": "The name of the host app to attach this remote app to.",
"type": "string",
"x-dropdown": "projects",
"x-priority": "important"
},
"inlineStyle": {
"alias": "s",
"default": false,
"description": "Specifies if the style will be in the ts file.",
"type": "boolean"
},
"inlineTemplate": {
"alias": "t",
"default": false,
"description": "Specifies if the template will be in the ts file.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint",
"none"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name to give to the remote Angular app.",
"type": "string"
},
"port": {
"description": "The port on which this app should be served.",
"type": "number"
},
"prefix": {
"alias": "p",
"description": "The prefix to apply to generated selectors.",
"format": "html-selector",
"type": "string"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean",
"x-priority": "internal"
},
"skipPackageJson": {
"default": false,
"description": "Do not add dependencies to `package.json`.",
"type": "boolean",
"x-priority": "internal"
},
"skipTests": {
"alias": "S",
"default": false,
"description": "Skip creating spec files.",
"type": "boolean"
},
"ssr": {
"default": false,
"description": "Whether to configure SSR for the remote application to be consumed by a host application using SSR.",
"type": "boolean"
},
"standalone": {
"default": false,
"description": "Whether to generate a remote application with standalone components. _Note: This is only supported in Angular versions >= 14.1.0_",
"type": "boolean"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"strict": {
"default": true,
"description": "Create an application with stricter type checking and build optimization options.",
"type": "boolean"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"enum": [
"css",
"scss",
"sass",
"less"
],
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "SASS(.sass) [ http://sass-lang.com ]",
"value": "sass"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
},
"viewEncapsulation": {
"description": "Specifies the view encapsulation strategy.",
"enum": [
"Emulated",
"None",
"ShadowDom"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Nx Module Federation Remote App",
"type": "object"
} | MIT | en |
nrwl/nx | a9974d3f25add9afcd6e2b416d490de60ee92d6e | 2024-01-30T16:33:13 | packages/nuxt/src/generators/storybook-configuration/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNuxtStorybookConfigure",
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"description": "Set up Storybook for a Nuxt project.",
"examplesFile": "../../../docs/storybook-configuration-examples.md",
"properties": {
"configureStaticServe": {
"default": true,
"description": "Specifies whether to configure a static file server target for serving storybook. Helpful for speeding up CI build/test times.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Configure a static file server for the storybook instance?"
},
"generateStories": {
"default": true,
"description": "Automatically generate `*.stories.ts` files for components declared in this project?",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Automatically generate *.stories.ts files for components declared in this project?"
},
"ignorePaths": {
"default": [
"*.stories.ts,*.stories.tsx,*.stories.js,*.stories.jsx,*.stories.mdx"
],
"description": "Paths to ignore when looking for components.",
"examples": [
"apps/my-app/src/not-stories/**",
"**/**/src/**/not-stories/**",
"libs/my-lib/**/*.something.ts",
"**/**/src/**/*.other.*",
"libs/my-lib/src/not-stories/**,**/**/src/**/*.other.*,apps/my-app/**/*.something.ts"
],
"items": {
"description": "Path to ignore.",
"type": "string"
},
"type": "array"
},
"interactionTests": {
"alias": [
"configureTestRunner"
],
"default": true,
"description": "Set up Storybook interaction tests.",
"type": "boolean",
"x-priority": "important",
"x-prompt": "Do you want to set up Storybook interaction tests?"
},
"js": {
"default": false,
"description": "Generate JavaScript story files rather than TypeScript story files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"project": {
"$default": {
"$source": "argv",
"index": 0
},
"aliases": [
"name",
"projectName"
],
"description": "Project for which to generate Storybook configuration.",
"type": "string",
"x-dropdown": "projects",
"x-priority": "important",
"x-prompt": "For which project do you want to generate Storybook configuration?"
},
"tsConfiguration": {
"default": true,
"description": "Configure your project with TypeScript. Generate main.ts and preview.ts files, instead of main.js and preview.js.",
"type": "boolean"
}
},
"required": [
"project"
],
"title": "Nuxt Storybook Configure",
"type": "object"
} | MIT | en |
nrwl/nx | 6dae32cc3af4f76f4de7f296a7c7c34ecfc1d62b | 2022-03-24T16:00:06 | packages/nest/src/generators/filter/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestFilterGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Nest Filter Options Schema.",
"properties": {
"directory": {
"aliases": [
"dir",
"path"
],
"description": "Directory where the generated files are placed.",
"type": "string"
},
"flat": {
"default": true,
"description": "Flag to indicate if a directory is created.",
"type": "boolean"
},
"language": {
"description": "Nest filter language.",
"enum": [
"js",
"ts"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the filter.",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The Nest project to target.",
"type": "string",
"x-prompt": "What Nest project would you like to target?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name",
"project"
],
"title": "Nest Filter Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | 6dae32cc3af4f76f4de7f296a7c7c34ecfc1d62b | 2022-03-24T16:00:06 | packages/nest/src/generators/gateway/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxNestGatewayGenerator",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Nest Gateway Options Schema.",
"properties": {
"directory": {
"aliases": [
"dir",
"path"
],
"description": "Directory where the generated files are placed.",
"type": "string"
},
"flat": {
"default": true,
"description": "Flag to indicate if a directory is created.",
"type": "boolean"
},
"language": {
"description": "Nest gateway language.",
"enum": [
"js",
"ts"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the gateway.",
"type": "string",
"x-prompt": "What name would you like to use?"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The Nest project to target.",
"type": "string",
"x-prompt": "What Nest project would you like to target?"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name",
"project"
],
"title": "Nest Gateway Options Schema",
"type": "object"
} | MIT | en |
nrwl/nx | 8df1834f2ce176a4b815e99db76ed9bb86ffedc2 | 2022-12-14T04:02:20 | packages/react/src/generators/host/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "GeneratorReactHost",
"$schema": "http://json-schema.org/schema",
"additionalProperties": false,
"cli": "nx",
"description": "Create Module Federation configuration files for given React Host Application.",
"properties": {
"classComponent": {
"alias": "C",
"default": false,
"description": "Use class components instead of functional component.",
"type": "boolean"
},
"compiler": {
"default": "babel",
"description": "The compiler to use",
"enum": [
"babel",
"swc"
],
"type": "string"
},
"devServerPort": {
"default": 4200,
"description": "The port for the dev server of the remote app.",
"type": "number"
},
"directory": {
"alias": "dir",
"description": "The directory of the new application.",
"type": "string"
},
"e2eTestRunner": {
"default": "cypress",
"description": "Test runner to use for end to end (e2e) tests.",
"enum": [
"cypress",
"none"
],
"type": "string"
},
"globalCss": {
"default": false,
"description": "Default is false. When true, the component is generated with *.css/*.scss instead of *.module.css/*.module.scss",
"type": "boolean"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the host application to generate the Module Federation configuration",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-prompt": "What name would you like to use as the host application?"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. App.tsx).",
"type": "boolean"
},
"remotes": {
"default": [],
"description": "A list of remote application names that the host application should consume.",
"type": "array"
},
"setParserOptionsProject": {
"default": false,
"description": "Whether or not to configure the ESLint \"parserOptions.project\" option. We do not do this by default for lint performance reasons.",
"type": "boolean"
},
"skipFormat": {
"default": false,
"description": "Skip formatting files.",
"type": "boolean"
},
"skipWorkspaceJson": {
"default": false,
"description": "Skip updating workspace.json with default options based on values provided to this app (e.g. babel, style).",
"type": "boolean"
},
"ssr": {
"default": false,
"description": "Whether to configure SSR for the host application",
"type": "boolean"
},
"standaloneConfig": {
"description": "Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json",
"type": "boolean"
},
"strict": {
"default": true,
"description": "Creates an application with strict mode and strict type checking",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "Stylus(.styl) [ http://stylus-lang.com ]",
"value": "styl"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
},
"tags": {
"alias": "t",
"description": "Add tags to the application (used for linting).",
"type": "string"
},
"unitTestRunner": {
"default": "jest",
"description": "Test runner to use for unit tests.",
"enum": [
"jest",
"none"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "Generate Module Federation Setup for React Host App",
"type": "object"
} | MIT | en |
nrwl/nx | 6dae32cc3af4f76f4de7f296a7c7c34ecfc1d62b | 2022-03-24T16:00:06 | packages/react/src/generators/component/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxReactComponent",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Create a React Component for Nx.",
"examples": [
{
"command": "nx g component my-component --project=mylib",
"description": "Generate a component in the mylib library"
},
{
"command": "nx g component my-component --project=mylib --classComponent",
"description": "Generate a class component in the mylib library"
}
],
"properties": {
"classComponent": {
"alias": "C",
"default": false,
"description": "Use class components instead of functional component.",
"type": "boolean"
},
"directory": {
"alias": "dir",
"description": "Create the component under this directory (can be nested).",
"type": "string"
},
"export": {
"alias": "e",
"default": false,
"description": "When true, the component is exported from the project `index.ts` (if it exists).",
"type": "boolean",
"x-prompt": "Should this component be exported in the project?"
},
"fileName": {
"description": "Create a component with this file name.",
"type": "string"
},
"flat": {
"default": false,
"description": "Create component at the source root rather than its own directory.",
"type": "boolean"
},
"globalCss": {
"default": false,
"description": "Default is `false`. When `true`, the component is generated with `*.css`/`*.scss` instead of `*.module.css`/`*.module.scss`.",
"type": "boolean"
},
"js": {
"default": false,
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the component.",
"type": "string",
"x-prompt": "What name would you like to use for the component?"
},
"pascalCaseDirectory": {
"alias": "R",
"default": false,
"description": "Use pascal case directory name (e.g. `App/App.tsx`).",
"type": "boolean"
},
"pascalCaseFiles": {
"alias": "P",
"default": false,
"description": "Use pascal case component file name (e.g. `App.tsx`).",
"type": "boolean"
},
"project": {
"$default": {
"$source": "projectName"
},
"alias": "p",
"description": "The name of the project.",
"type": "string",
"x-prompt": "What is the name of the project for this component?"
},
"routing": {
"description": "Generate a library with routes.",
"type": "boolean"
},
"skipTests": {
"default": false,
"description": "When true, does not create `spec.ts` test files for the new component.",
"type": "boolean"
},
"style": {
"alias": "s",
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "Stylus(.styl) [ http://stylus-lang.com ]",
"value": "styl"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
},
{
"label": "styled-components [ https://styled-components.com ]",
"value": "styled-components"
},
{
"label": "emotion [ https://emotion.sh ]",
"value": "@emotion/styled"
},
{
"label": "styled-jsx [ https://www.npmjs.com/package/styled-jsx ]",
"value": "styled-jsx"
},
{
"label": "None",
"value": "none"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
}
},
"required": [
"name",
"project"
],
"title": "Create a React Component",
"type": "object"
} | MIT | en |
nrwl/nx | 8f705e31e2f7dd0399851efc17e62ba4f35e6642 | 2024-05-09T01:54:41 | packages/remix/src/generators/resource-route/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxRemixResourceRoute",
"$schema": "https://json-schema.org/schema",
"description": "Generate a resource route.",
"examples": [
{
"command": "g resource-route 'path/to/page'",
"description": "Generate resource route at /path/to/page"
}
],
"properties": {
"action": {
"default": false,
"description": "Generate an action function",
"type": "boolean"
},
"loader": {
"default": true,
"description": "Generate a loader function",
"type": "boolean"
},
"nameAndDirectoryFormat": {
"description": "Whether to generate the styles in the path as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
"enum": [
"as-provided",
"derived"
],
"type": "string"
},
"path": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The route path or path to the filename of the route.",
"type": "string",
"x-prompt": "What is the path of the route? (e.g. 'apps/demo/app/routes/foo/bar')"
},
"project": {
"description": "The name of the project.",
"pattern": "^[a-zA-Z].*$",
"type": "string",
"x-deprecated": "Provide the `path` option instead and use the `as-provided` format. The project will be determined from the path provided. It will be removed in Nx v20."
},
"skipChecks": {
"default": false,
"description": "Skip route error detection",
"type": "boolean"
}
},
"required": [
"path"
],
"title": "Create a Resource Route",
"type": "object"
} | MIT | en |
nrwl/nx | 338dc64d91e778c892d2a7d997b997d89b184343 | 2023-04-19T19:29:31 | packages/workspace/src/generators/preset/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWorkspacePreset",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"description": "Creates applications in a new workspace.",
"properties": {
"bundler": {
"default": "vite",
"description": "The bundler to use for building the application.",
"enum": [
"webpack",
"vite",
"rspack"
],
"type": "string"
},
"docker": {
"default": false,
"description": "Generate a Dockerfile",
"type": "boolean"
},
"framework": {
"description": "The framework which the application is using",
"enum": [
"express",
"koa",
"fastify",
"nest",
"none"
],
"type": "string"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"eslint"
],
"type": "string"
},
"name": {
"description": "The name of the application.",
"type": "string"
},
"nextAppDir": {
"default": false,
"description": "Enable experimental app/ for the project",
"type": "boolean"
},
"npmScope": {
"description": "Npm scope for importing libs.",
"type": "string"
},
"packageManager": {
"description": "The package manager used to install dependencies.",
"enum": [
"npm",
"yarn",
"pnpm"
],
"type": "string"
},
"preset": {
"description": "The name of the preset.",
"type": "string"
},
"routing": {
"default": true,
"description": "Add routing to the generated application.",
"type": "boolean"
},
"standaloneApi": {
"default": false,
"description": "Use Standalone Components if generating an Angular application.",
"type": "boolean"
},
"standaloneConfig": {
"default": true,
"description": "Split the project configurations into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean",
"x-deprecated": "Nx only supports standaloneConfig"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string",
"x-prompt": {
"items": [
{
"label": "CSS",
"value": "css"
},
{
"label": "SASS(.scss) [ http://sass-lang.com ]",
"value": "scss"
},
{
"label": "LESS [ http://lesscss.org ]",
"value": "less"
}
],
"message": "Which stylesheet format would you like to use?",
"type": "list"
}
}
},
"title": "Creates applications in a new workspace",
"type": "object"
} | MIT | en |
nrwl/nx | 678818a58b37bb395415665232f7acaac4bd21f6 | 2021-05-12T16:20:12 | packages/workspace/src/generators/new/schema.json | 22,349 | 2024-05-28T16:46:14.129163Z | {
"$id": "NxWorkspaceNew",
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"properties": {
"appName": {
"description": "Application name.",
"type": "string"
},
"cli": {
"default": "nx",
"description": "CLI used for generating code and running tasks",
"enum": [
"nx",
"angular"
],
"type": "string"
},
"commit": {
"default": true,
"description": "Initial repository commit information.",
"oneOf": [
{
"type": "boolean"
},
{
"properties": {
"email": {
"format": "email",
"type": "string"
},
"message": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"email"
],
"type": "object"
}
]
},
"defaultBase": {
"default": "master",
"description": "Default base branch for affected.",
"type": "string"
},
"linter": {
"default": "eslint",
"description": "The tool to use for running lint checks.",
"enum": [
"tslint",
"eslint"
],
"type": "string"
},
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "The name of the workspace.",
"type": "string",
"x-prompt": "What name would you like to use for the workspace?"
},
"npmScope": {
"description": "Npm scope for importing libs.",
"type": "string"
},
"nxCloud": {
"default": false,
"description": "Connect the workspace to the free tier of the distributed cache provided by Nx Cloud",
"type": "boolean"
},
"packageManager": {
"description": "The package manager used to install dependencies.",
"enum": [
"npm",
"yarn",
"pnpm"
],
"type": "string"
},
"preset": {
"description": "What to create in the new workspace",
"type": "string"
},
"skipGit": {
"alias": "g",
"default": false,
"description": "Skip initializing a git repository.",
"type": "boolean"
},
"skipInstall": {
"default": false,
"description": "Skip installing dependency packages.",
"type": "boolean"
},
"style": {
"default": "css",
"description": "The file extension to be used for style files.",
"type": "string"
}
},
"title": "Create an empty workspace",
"type": "object"
} | MIT | en |
Subsets and Splits