12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667 |
- {
- "$schema": "http://json-schema.org/draft-07/schema",
- "$id": "SchematicsAngularPipe",
- "title": "Angular Pipe Options Schema",
- "type": "object",
- "additionalProperties": false,
- "description": "Creates a new pipe in your project. Pipes are used to transform data for display in templates. They take input values and apply a specific transformation, such as formatting dates, currency, or filtering arrays. This schematic generates the necessary files and boilerplate code for a new pipe.",
- "properties": {
- "name": {
- "type": "string",
- "description": "The name for the new pipe. This will be used to create the pipe's class and spec files (e.g., `my-pipe.pipe.ts` and `my-pipe.pipe.spec.ts`).",
- "$default": {
- "$source": "argv",
- "index": 0
- },
- "x-prompt": "What name would you like to use for the pipe?"
- },
- "path": {
- "type": "string",
- "format": "path",
- "$default": {
- "$source": "workingDirectory"
- },
- "description": "The path where the pipe files should be created, relative to the workspace root. If not provided, the pipe will be created in the current directory.",
- "visible": false
- },
- "project": {
- "type": "string",
- "description": "The name of the project where the pipe should be created. If not specified, the CLI will determine the project from the current directory.",
- "$default": {
- "$source": "projectName"
- }
- },
- "flat": {
- "type": "boolean",
- "default": true,
- "description": "Creates the new pipe files at the top level of the current project. If set to false, a new folder with the pipe's name will be created to contain the files."
- },
- "skipTests": {
- "type": "boolean",
- "description": "Prevent the generation of a unit test file `spec.ts` for the new pipe.",
- "default": false
- },
- "skipImport": {
- "type": "boolean",
- "default": false,
- "description": "Do not automatically import the new pipe into its closest NgModule."
- },
- "standalone": {
- "description": "Generate a standalone pipe. Standalone pipes are self-contained and don't need to be declared in an NgModule. They can be used independently or imported directly into other standalone components, directives, or pipes.",
- "type": "boolean",
- "default": true,
- "x-user-analytics": "ep.ng_standalone"
- },
- "module": {
- "type": "string",
- "description": "Specify the NgModule where the pipe should be declared. If not provided, the CLI will attempt to find the closest NgModule in the pipe's path.",
- "alias": "m"
- },
- "export": {
- "type": "boolean",
- "default": false,
- "description": "Automatically export the pipe from the specified NgModule, making it accessible to other modules in the application."
- }
- },
- "required": ["name", "project"]
- }
|