396ffc4636
Co-authored-by: Katerina Skroumpelou <sk.katherine@gmail.com> Co-authored-by: Jack Hsu <jack.hsu@gmail.com> Co-authored-by: Colum Ferry <cferry09@gmail.com> Co-authored-by: Leosvel Pérez Espinosa <leosvel.perez.espinosa@gmail.com> Co-authored-by: Emily Xiong <xiongemi@gmail.com> Co-authored-by: Nicholas Cunningham <ndcunningham@gmail.com>
83 lines
2.6 KiB
JSON
83 lines
2.6 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": {
|
|
"name": {
|
|
"type": "string",
|
|
"description": "Library name",
|
|
"$default": { "$source": "argv", "index": 0 },
|
|
"x-prompt": "What name would you like to use for the library?",
|
|
"pattern": "^[a-zA-Z].*$"
|
|
},
|
|
"directory": {
|
|
"type": "string",
|
|
"description": "A directory where the lib is placed.",
|
|
"alias": "dir",
|
|
"x-priority": "important"
|
|
},
|
|
"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`).",
|
|
"type": "string",
|
|
"enum": ["as-provided", "derived"]
|
|
},
|
|
"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": ["jest", "vitest", "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": ["name"],
|
|
"presets": []
|
|
},
|
|
"description": "Generate a new library",
|
|
"aliases": ["lib"],
|
|
"x-type": "library",
|
|
"hidden": false,
|
|
"path": "/packages/remix/src/generators/library/schema.json",
|
|
"type": "generator"
|
|
}
|