nx/docs/generated/packages/remix/generators/resource-route.json
2024-01-30 16:29:05 -05:00

59 lines
2.1 KiB
JSON

{
"name": "resource-route",
"implementation": "/packages/remix/src/generators/resource-route/resource-route.impl.ts",
"schema": {
"$schema": "https://json-schema.org/schema",
"$id": "NxRemixResourceRoute",
"title": "Create a Resource Route",
"type": "object",
"description": "Generate a resource route.",
"examples": [
{
"command": "g resource-route 'path/to/page'",
"description": "Generate resource route at /path/to/page"
}
],
"properties": {
"path": {
"type": "string",
"description": "The route path or path to the filename of the route.",
"$default": { "$source": "argv", "index": 0 },
"x-prompt": "What is the path of the route? (e.g. 'apps/demo/app/routes/foo/bar')"
},
"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`).",
"type": "string",
"enum": ["as-provided", "derived"]
},
"project": {
"type": "string",
"description": "The name of the project.",
"pattern": "^[a-zA-Z].*$",
"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."
},
"action": {
"type": "boolean",
"description": "Generate an action function",
"default": false
},
"loader": {
"type": "boolean",
"description": "Generate a loader function",
"default": true
},
"skipChecks": {
"type": "boolean",
"description": "Skip route error detection",
"default": false
}
},
"required": ["path"],
"presets": []
},
"description": "Generate a new resource route",
"aliases": [],
"hidden": false,
"path": "/packages/remix/src/generators/resource-route/schema.json",
"type": "generator"
}