Leosvel Pérez Espinosa 28c53f942b
feat(misc): handle artifact generators' path options including file extensions (#29111)
<!-- Please make sure you have read the submission guidelines before
posting an PR -->
<!--
https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr
-->

<!-- Please make sure that your commit message follows our format -->
<!-- Example: `fix(nx): must begin with lowercase` -->

<!-- If this is a particularly complex change or feature addition, you
can request a dedicated Nx release for this pull request branch. Mention
someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they
will confirm if the PR warrants its own release for testing purposes,
and generate it for you if appropriate. -->

## Current Behavior
<!-- This is the behavior we have today -->

Artifact generators don't handle consistently receiving a file extension
in the `path` option.

## Expected Behavior
<!-- This is the behavior we should expect with the changes in this PR
-->

Artifact generators should handle receiving a file extension in the
`path` option. If the file extension is passed, the file path will be
treated as "complete" and used fully as provided. If the `path` provided
doesn't contain a file extension, the default extension will be appended
to it (or the one provided in a related option, e.g. `--language`,
`--js`, etc) together with the suffix for generators that use it.

## Related Issue(s)
<!-- Please link the issue being fixed so it gets closed when this is
merged. -->

Fixes #
2024-12-09 09:13:15 -05:00

88 lines
2.8 KiB
JSON

{
"name": "resource",
"factory": "./src/generators/resource/resource",
"schema": {
"$schema": "https://json-schema.org/schema",
"$id": "NxNestResourceGenerator",
"title": "Nest Resource Options Schema",
"description": "Nest Resource Options Schema.",
"cli": "nx",
"type": "object",
"examples": [
{
"description": "Generate `myapp/src/app/entities/foo.entity.ts`, `myapp/src/app/dto/create-foo.dto.ts`, `myapp/src/app/dto/update-foo.dto.ts`, `myapp/src/app/foo.service.ts`, `myapp/src/app/foo.controller.ts`, and `myapp/src/app/foo.module.ts`",
"command": "nx g @nx/nest:resource myapp/src/app/foo"
}
],
"properties": {
"path": {
"type": "string",
"description": "The file path to the resource. Relative to the current working directory.",
"$default": { "$source": "argv", "index": 0 },
"x-prompt": "What is the resource file path?"
},
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false,
"x-priority": "internal"
},
"unitTestRunner": {
"description": "Test runner to use for unit tests.",
"type": "string",
"enum": ["jest", "none"],
"default": "jest"
},
"type": {
"type": "string",
"description": "The transport layer.",
"default": "rest",
"enum": [
"rest",
"graphql-code-first",
"graphql-schema-first",
"microservice",
"ws"
],
"x-prompt": {
"message": "What transport layer do you use?",
"type": "list",
"items": [
{ "value": "rest", "label": "REST API" },
{ "value": "graphql-code-first", "label": "GraphQL (code first)" },
{
"value": "graphql-schema-first",
"label": "GraphQL (schema first)"
},
{ "value": "microservice", "label": "Microservice (non-HTTP)" },
{ "value": "ws", "label": "WebSockets" }
]
}
},
"skipImport": {
"type": "boolean",
"description": "Flag to skip the module import.",
"default": false
},
"crud": {
"type": "boolean",
"description": "When true, CRUD entry points are generated.",
"default": true,
"x-prompt": {
"message": "Would you like to generate CRUD entry points?",
"type": "confirmation"
}
}
},
"additionalProperties": false,
"required": ["path"],
"presets": []
},
"description": "Run the `resource` NestJS generator with Nx project support.",
"implementation": "/packages/nest/src/generators/resource/resource.ts",
"aliases": [],
"hidden": false,
"path": "/packages/nest/src/generators/resource/schema.json",
"type": "generator"
}