forked from nrwl/nx
/
schema.json
86 lines (86 loc) · 3.09 KB
/
schema.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
{
"$schema": "http://json-schema.org/schema",
"id": "SchematicsNxNgrx",
"title": "Add NgRx support to an application or library",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the NgRx feature state, such as \"products\" or \"users\"). Recommended to use the plural form of the name.",
"$default": {
"$source": "argv",
"index": 0
},
"x-prompt": "What name would you like to use for the NgRx feature state? An example would be \"users\"."
},
"module": {
"type": "string",
"description": "The path to NgModule where the feature state will be registered. The host directory will create/use the new state directory.",
"x-prompt": "What is the path to the module where this NgRx state should be registered?"
},
"directory": {
"type": "string",
"default": "+state",
"description": "The name of the folder used to contain/group the generated NgRx files."
},
"root": {
"type": "boolean",
"default": false,
"description": "Setup root or feature state management with NgRx.",
"x-prompt": "Is this the root state of the application?"
},
"facade": {
"type": "boolean",
"default": false,
"description": "Create a Facade class for the the Feature.",
"x-prompt": "Would you like to use a Facade with your NgRx state?"
},
"skipImport": {
"type": "boolean",
"default": false,
"description": "Generate NgRx feature files without registering the feature in the NgModule."
},
"onlyAddFiles": {
"type": "boolean",
"default": false,
"description": "**Deprecated**, use `skipImport`. Only add new NgRx files, without changing the module file (e.g., --onlyAddFiles)."
},
"minimal": {
"type": "boolean",
"default": true,
"description": "Only register the root state management setup or feature state."
},
"onlyEmptyRoot": {
"type": "boolean",
"default": false,
"description": "**Deprecated**, use `minimal`. Do not generate any files. Only generate StoreModule.forRoot and EffectsModule.forRoot (e.g., --onlyEmptyRoot)."
},
"skipFormat": {
"description": "Skip formatting of generated files.",
"type": "boolean",
"default": false
},
"skipPackageJson": {
"type": "boolean",
"default": false,
"description": "Do not update the package.json with NgRx dependencies."
},
"syntax": {
"type": "string",
"enum": ["classes", "creators"],
"default": "creators",
"description": "Specifies whether to use class-based or creator functions for actions, reducers, and effects."
},
"useDataPersistence": {
"type": "boolean",
"default": false,
"description": "Generate NgRx Effects with the DataPersistence helper service. Set to false to use plain effects data persistence operators."
},
"barrels": {
"type": "boolean",
"default": false,
"description": "Use barrels to re-export actions, state, and selectors."
}
},
"required": ["module"]
}