Jack Hsu 27edf71cef
feat(misc): make directory a required option for generators (#28093)
<!-- 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 -->

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

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

Fixes #

---------

Co-authored-by: Colum Ferry <cferry09@gmail.com>
Co-authored-by: Nicholas Cunningham <ndcunningham@gmail.com>
2024-10-01 09:29:44 -04:00

74 lines
2.6 KiB
JSON

{
"name": "application",
"factory": "./src/generators/application/application#detoxApplicationGeneratorInternal",
"schema": {
"$schema": "https://json-schema.org/schema",
"title": "Create Detox Configuration for the workspace",
"description": "Create Detox Configuration for the workspace.",
"type": "object",
"properties": {
"appProject": {
"type": "string",
"description": "Name of the frontend project to be tested.",
"$default": { "$source": "projectName" },
"x-prompt": "What is the name of the frontend project to test?"
},
"e2eDirectory": {
"type": "string",
"description": "A directory where the project is placed relative current working directory (CWD).",
"$default": { "$source": "argv", "index": 0 },
"x-prompt": "Which directory do you want to create the E2E project in?"
},
"e2eName": {
"type": "string",
"description": "Name of the E2E Project."
},
"appName": {
"type": "string",
"description": "Name of the app to be tested if different from appProject"
},
"appDisplayName": {
"type": "string",
"description": "Display name of the app to be tested if different from appProject"
},
"framework": {
"type": "string",
"description": "App framework to test",
"enum": ["react-native", "expo"],
"x-prompt": "What app framework should detox test?"
},
"linter": {
"description": "The tool to use for running lint checks.",
"type": "string",
"enum": ["eslint", "none"],
"default": "eslint"
},
"js": {
"description": "Generate JavaScript files rather than TypeScript files.",
"type": "boolean",
"default": false
},
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false,
"x-priority": "internal"
},
"setParserOptionsProject": {
"type": "boolean",
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"default": false
}
},
"required": ["e2eDirectory", "appProject", "framework"],
"presets": []
},
"aliases": ["app"],
"x-type": "application",
"description": "Create a Detox application.",
"implementation": "/packages/detox/src/generators/application/application#detoxApplicationGeneratorInternal.ts",
"hidden": false,
"path": "/packages/detox/src/generators/application/schema.json",
"type": "generator"
}