feat(schematics): add message prompts for individual schematics (ngrx…

…#2143)
jordanpowell88 · Nov 14, 2019 · 4723c37 · 4723c37
1 parent 016a19b
commit 4723c37
Show file tree

Hide file tree

Showing 7 changed files with 36 additions and 18 deletions.
diff --git a/modules/schematics/src/action/schema.json b/modules/schematics/src/action/schema.json
@@ -10,7 +10,8 @@
       "$default": {
         "$source": "argv",
         "index": 0
-      }
+      },
+      "x-prompt": "What should be the name of the action?"
     },
     "path": {
       "type": "string",
@@ -44,14 +45,16 @@
       "default": false,
       "description":
         "Specifies if api success and failure actions should be generated.",
-      "aliases": ["a"]
+      "aliases": ["a"],
+      "x-prompt": "Should we generate success and failure actions?"
     },
     "creators": {
       "type": "boolean",
       "default": false,
       "description":
         "Specifies whether to use creator functions for handling actions and reducers.",
-      "aliases": ["c"]
+      "aliases": ["c"],
+      "x-prompt": "Do you want to use the create function?"
     }
   },
   "required": []

diff --git a/modules/schematics/src/container/schema.json b/modules/schematics/src/container/schema.json
@@ -21,7 +21,8 @@
       "$default": {
         "$source": "argv",
         "index": 0
-      }
+      },
+      "x-prompt": "What should be the name of the container component?"
     },
     "inlineStyle": {
       "description": "Specifies if the style will be in the ts file.",

diff --git a/modules/schematics/src/effect/schema.json b/modules/schematics/src/effect/schema.json
@@ -10,7 +10,8 @@
       "$default": {
         "$source": "argv",
         "index": 0
-      }
+      },
+      "x-prompt": "What should be the name of the Effect?"
     },
     "path": {
       "type": "string",
@@ -38,7 +39,8 @@
       "default": "",
       "description": "Allows specification of the declaring module.",
       "alias": "m",
-      "subtype": "filepath"
+      "subtype": "filepath",
+      "x-prompt": "To which module (path) should the effect be registered in?"
     },
     "root": {
       "type": "boolean",
@@ -62,14 +64,16 @@
       "default": false,
       "description":
         "Specifies if effect has api success and failure actions wired up",
-      "aliases": ["a"]
+      "aliases": ["a"],
+      "x-prompt": "Should we wire up success and failure actions?"
     },
     "creators": {
       "type": "boolean",
       "default": false,
       "description":
         "Specifies whether to use creator functions for handling actions, reducers, and effects.",
-      "aliases": ["c"]
+      "aliases": ["c"],
+      "x-prompt": "Do you want to use the create function?"
     },
     "minimal": {
       "type": "boolean",

diff --git a/modules/schematics/src/entity/schema.json b/modules/schematics/src/entity/schema.json
@@ -10,7 +10,8 @@
       "$default": {
         "$source": "argv",
         "index": 0
-      }
+      },
+      "x-prompt": "What should be the name of the entity?"
     },
     "path": {
       "type": "string",
@@ -55,7 +56,8 @@
       "default": false,
       "description":
         "Specifies whether to use creator functions for handling actions and reducers.",
-      "aliases": ["c"]
+      "aliases": ["c"],
+      "x-prompt": "Do you want to use the create function?"
     }
   },
   "required": []

diff --git a/modules/schematics/src/feature/schema.json b/modules/schematics/src/feature/schema.json
@@ -21,7 +21,8 @@
       "$default": {
         "$source": "argv",
         "index": 0
-      }
+      },
+      "x-prompt": "What should be the name of the feature?"
     },
     "flat": {
       "type": "boolean",
@@ -55,14 +56,16 @@
       "default": false,
       "description":
         "Specifies if api success and failure actions, reducer, and effects should be generated as part of this feature.",
-      "aliases": ["a"]
+      "aliases": ["a"],
+      "x-prompt": "Should we generate and wire success and failure actions?"
     },
     "creators": {
       "type": "boolean",
       "default": false,
       "description":
         "Specifies if the actions, reducers, and effects should be created using creator functions",
-      "aliases": ["c"]
+      "aliases": ["c"],
+      "x-prompt": "Do you want to use the create functions?"
     }
   },
   "required": []

diff --git a/modules/schematics/src/reducer/schema.json b/modules/schematics/src/reducer/schema.json
@@ -10,7 +10,8 @@
       "$default": {
         "$source": "argv",
         "index": 0
-      }
+      },
+      "x-prompt": "What should be the name of the reducer?"
     },
     "path": {
       "type": "string",
@@ -59,14 +60,16 @@
       "default": false,
       "description":
         "Specifies if api success and failure actions should be added to the reducer",
-      "aliases": ["a"]
+      "aliases": ["a"],
+      "x-prompt": "Should we add success and failure actions to the reducer?"
     },
     "creators": {
       "type": "boolean",
       "default": false,
       "description":
         "Specifies whether to use creator functions for handling actions and reducers.",
-      "aliases": ["c"]
+      "aliases": ["c"],
+      "x-prompt": "Do you want to use the create function?"
     }
   },
   "required": []

diff --git a/modules/schematics/src/store/schema.json b/modules/schematics/src/store/schema.json
@@ -10,7 +10,8 @@
       "$default": {
         "$source": "argv",
         "index": 0
-      }
+      },
+      "x-prompt": "What should be the name of the state?"
     },
     "path": {
       "type": "string",
@@ -38,7 +39,8 @@
       "default": "",
       "description": "Allows specification of the declaring module.",
       "alias": "m",
-      "subtype": "filepath"
+      "subtype": "filepath",
+      "x-prompt": "To which module (path) should the state be registered in?"
     },
     "statePath": {
       "type": "string",