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

78 lines
2.3 KiB
JSON

{
"name": "library",
"implementation": "/packages/remix/src/generators/library/library.impl#remixLibraryGeneratorInternal.ts",
"schema": {
"$schema": "https://json-schema.org/schema",
"$id": "NxRemixLibrary",
"title": "Create a Library",
"description": "Generate a Remix library to help structure workspace and application.",
"type": "object",
"examples": [
{
"command": "g lib mylib --directory=myapp",
"description": "Generate libs/myapp/mylib"
}
],
"properties": {
"directory": {
"type": "string",
"description": "A directory where the lib is placed.",
"alias": "dir",
"$default": { "$source": "argv", "index": 0 },
"x-prompt": "Which directory do you want to create the library in?"
},
"name": {
"type": "string",
"description": "Library name",
"pattern": "^[a-zA-Z].*$",
"x-priority": "important"
},
"tags": {
"type": "string",
"description": "Add tags to the library (used for linting)"
},
"style": {
"type": "string",
"description": "Generate a stylesheet",
"enum": ["none", "css"],
"default": "css"
},
"buildable": {
"type": "boolean",
"description": "Should the library be buildable?",
"default": false
},
"unitTestRunner": {
"type": "string",
"enum": ["vitest", "jest", "none"],
"description": "Test Runner to use for Unit Tests",
"x-prompt": "What test runner should be used?",
"default": "vitest"
},
"importPath": {
"type": "string",
"description": "The library name used to import it, like @myorg/my-awesome-lib"
},
"js": {
"type": "boolean",
"description": "Generate JavaScript files rather than TypeScript files",
"default": false
},
"skipFormat": {
"type": "boolean",
"description": "Skip formatting files after generator runs",
"default": false,
"x-priority": "internal"
}
},
"required": ["directory"],
"presets": []
},
"description": "Generate a new library",
"aliases": ["lib"],
"x-type": "library",
"hidden": false,
"path": "/packages/remix/src/generators/library/schema.json",
"type": "generator"
}