UNPKG

2.23 kBJSONView Raw
1{
2 "$schema": "http://json-schema.org/schema",
3 "$id": "SchematicsNgRxFeature",
4 "title": "NgRx Feature State Options Schema",
5 "type": "object",
6 "properties": {
7 "path": {
8 "type": "string",
9 "format": "path",
10 "description": "The path to create the feature.",
11 "visible": false,
12 "$default": {
13 "$source": "workingDirectory"
14 }
15 },
16 "project": {
17 "type": "string",
18 "description": "The name of the project.",
19 "aliases": ["p"]
20 },
21 "name": {
22 "description": "The name of the feature.",
23 "type": "string",
24 "$default": {
25 "$source": "argv",
26 "index": 0
27 },
28 "x-prompt": "What should be the name of the feature?"
29 },
30 "flat": {
31 "type": "boolean",
32 "default": true,
33 "description": "Flag to indicate if a dir is created."
34 },
35 "module": {
36 "type": "string",
37 "description": "Specifies the declaring module.",
38 "aliases": ["m"]
39 },
40 "skipTests": {
41 "type": "boolean",
42 "default": false,
43 "description": "When true, does not create test files."
44 },
45 "reducers": {
46 "type": "string",
47 "description": "Specifies the reducers file.",
48 "aliases": ["r"]
49 },
50 "group": {
51 "type": "boolean",
52 "default": false,
53 "description": "Group actions, reducers and effects within relative subfolders",
54 "aliases": ["g"]
55 },
56 "api": {
57 "type": "boolean",
58 "default": false,
59 "description": "Specifies if api success and failure actions, reducer, and effects should be generated as part of this feature.",
60 "aliases": ["a"],
61 "x-prompt": "Should we generate and wire success and failure actions?"
62 },
63 "prefix": {
64 "description": "The prefix of the action, effect and reducer.",
65 "type": "string",
66 "default": "load",
67 "x-prompt": "What should be the prefix of the action, effect and reducer?"
68 },
69 "entity": {
70 "description": "Toggle whether an entity is created as part of the feature",
71 "type": "boolean",
72 "aliases": ["e"],
73 "x-prompt": "Should we use @ngrx/entity to create the reducer?",
74 "default": false
75 }
76 },
77 "required": []
78}