feat/labs-6-accept-options (#28)

1. include `d.ts` files
1. configure schematic to accept options
- argv[0] - entity-name
- path
- init - initialize with NgRx files


`ng g @briebug/ngrx-entity-schematic:ngrx-entity-schematic customers --init --path src/app/customers-state`

or locally

`yarn launch customers --init --path src/app/customers-state`

Author: schuchard

.gitignore

@@ -41,4 +41,4 @@ Thumbs.db
 src/**/*.js
 !src/**/__files__/**/*.js
 src/**/*.js.map
-src/**/*.d.ts
+src/**.d.ts

.vscode/launch.json

@@ -7,7 +7,7 @@
     {
       "type": "node",
       "request": "attach",
-      "name": "Attach Node",
+      "name": "Attach Schematic",
       "port": 9229,
       "restart": false,
       "protocol": "inspector"

README.md

@@ -1,6 +1,29 @@
 # NgRx Entity Generator
 
-## Usage
+## How to Use
+
+### Run schematic
+
+Generate Entity files
+
+```shell
+ng g @briebug/ngrx-entity-schematic:ngrx-entity-schematic ENTITY_NAME
+```
+
+Generate Entity files at a specific relative path
+
+```shell
+ng g @briebug/ngrx-entity-schematic:ngrx-entity-schematic ENTITY_NAME --path RELATIVE/PATH
+```
+
+Generate Entity files with NgRx setup files
+
+```shell
+ng g @briebug/ngrx-entity-schematic:ngrx-entity-schematic ENTITY_NAME --init
+```
+
+- `ENTITY_NAME`, `--path`, and `--init` flags can be used together.
+- `ENTITY_NAME` is **required** as the first argument after the schematic name
 
 ## Development
 
@@ -12,10 +35,10 @@ yarn link:schematic
 
 ### Run schematic locally
 
-Compile the schematic code
+You can run or re-run schematic against `sandbox-app` and pass options
 
 ```shell
-yarn build:schematic
+yarn launch ENTITY_NAME --init
 ```
 
 Reset the `sandbox-app` to it's version controlled state, then execute the schematic locally against the `sandbox-app`.
@@ -24,6 +47,12 @@ Reset the `sandbox-app` to it's version controlled state, then execute the schem
 yarn clean:launch
 ```
 
+Compile the schematic code if changes have been made to `./src/*`
+
+```shell
+yarn build:schematic
+```
+
 ### Copy `schematic-src` files into schematic template files
 
 Read the blueprint app, `/schematic-src`, and copy all the necessary files into the schematic folder, `/src/__files__`. During the copy, replace all "entity" placeholders with their respective template placeholder. Run this if changes to the `schematic-src` app have been made.
@@ -41,19 +70,19 @@ yarn build:run:fileBuilder
 
 #### About
 
-This schematic uses a template project that's the working blueprint for what the schematic will eventually generate. This pattern was chosen to provide a faster and easier development cycle when testing the template app as a standalone application with the typical dev feedback provided by the Angular CLI. The alternative would involve developing against the template files (which include template variable like `<%= classify(name) %>`) and having to run the schematic locally on every change.
+This schematic uses a template project that acts as the working blueprint for what the schematic will eventually generate. This pattern was chosen to provide a faster and easier development cycle when testing the blueprint app as a standalone application providing the typical dev feedback by the Angular  CLI and other devtools. The alternative would involve developing against the template files (which include template variables like `<%= classify(name) %>`) and having to run the schematic locally on every change.
 
 ### Developing the `buildFiles` script
 
-When editing the script that copies and modifies the blueprint files into the schematic directory. The following commands all for quick dev feedback and debugging.
+This script copies and modifies the blueprint Entity files into the schematic `__files__` directory. The following commands allow for quick dev feedback and debugging.
 
 Compile the `buildFiles` script into `/tmp` in one shell
 
 ```shell
 build:fileBuilder
 ```
 
-In another shell, run the script and watch the `/tmp` dir for changes. Allows for attaching a debugger on port `9222`. See the attached `.vscode/launch.json` file for debugging with VSCode.
+In another shell, run the following script which will watch the `/tmp` dir for changes. Allows for attaching a debugger on port `9222`. See the attached `.vscode/launch.json` file for debugging with VSCode. Run the `Attach Schematic` debugger.
 
 ```shell
 run:fileBuilder
@@ -65,12 +94,12 @@ Once both of these are run, changes to `./buildFiles.ts` should recompile and tr
 
 ### ./src
 
-This is the schematic code that's executed when running `ng g @briebug/ngrx-entity-schematic`.
+This is the schematic code that's executed when running `ng g @briebug/ngrx-entity-schematic:ngrx-entity-schematic`.
 
 ### ./schematic-src
 
-This the blueprint used for generating the schematic, specifically in template files in `./src/ngrx-entity/__files__`. This is a working application that defines the final form of the schematic.
+This is the blueprint app used for generating the schematic, specifically the template files in `./src/ngrx-entity/__files__`. This is a working application that defines the final form of the schematic.
 
 ### ./sandbox-app
 
-This is an application that's used for testing the schematic locally for development.
+This is an application that's used for testing the schematic locally during development.

src/ngrx-entity/index.d.ts

@@ -0,0 +1,3 @@
+import { Rule } from '@angular-devkit/schematics';
+import { NgRxOptions } from './utility/util';
+export default function (options: NgRxOptions): Rule;

src/ngrx-entity/index.ts

@@ -10,6 +10,7 @@ import {
   template,
   filter,
   noop,
+  SchematicsException,
 } from '@angular-devkit/schematics';
 import { NgRxOptions } from './utility/util';
 import { parseName } from './utility/parseName';
@@ -22,19 +23,27 @@ export default function(options: NgRxOptions): Rule {
 
 function addNgRxFiles(options: NgRxOptions): Rule {
   return (tree: Tree, context: SchematicContext) => {
-    const path = './src/app/state'; // read path from where uses runs schematic?
-    const entityName = 'orders';
-    context.logger.debug(`adding NgRX files to ${path} dir`);
+    if (!options.name) {
+      throw new SchematicsException('Entity name is required');
+    }
 
-    const parsedPath = parseName(path, entityName);
+    if (!options.path) {
+      // todo: determine default based on current working dir
+      options.path = `./src/app/state`;
+      console.log(`No Entity path specified, adding files to ${options.path}`);
+    }
+
+    context.logger.debug(`adding NgRX files to ${options.path} dir`);
+
+    const parsedPath = parseName(options.path, options.name);
     options.name = parsedPath.name;
     options.path = parsedPath.path;
 
     const templateSource = apply(url('./__files__'), [
-      tree.exists(`${parsedPath.path}/app.interfaces.ts`) ? filter(path => !path.endsWith('app.interfaces.ts')) : noop(),
-      tree.exists(`${parsedPath.path}/app.reducer.ts`) ? filter(path => !path.endsWith('app.reducer.ts')) : noop(),
-      tree.exists(`${parsedPath.path}/state-utils.ts`) ? filter(path => !path.endsWith('state-utils.ts')) : noop(),
-      tree.exists(`${parsedPath.path}/state.module.ts`) ? filter(path => !path.endsWith('state.module.ts')) : noop(),
+      options.init && !tree.exists(`${parsedPath.path}/app.interfaces.ts`) ? noop() : filter(path => !path.endsWith('app.interfaces.ts')) ,
+      options.init && !tree.exists(`${parsedPath.path}/app.reducer.ts`) ? noop() : filter(path => !path.endsWith('app.reducer.ts')) ,
+      options.init && !tree.exists(`${parsedPath.path}/state-utils.ts`) ? noop() : filter(path => !path.endsWith('state-utils.ts')) ,
+      options.init && !tree.exists(`${parsedPath.path}/state.module.ts`) ? noop() : filter(path => !path.endsWith('state.module.ts')) ,
       template({
         ...strings,
         'if-flat': (s: string) => (options.flat ? '' : s),

src/ngrx-entity/schema.d.ts

@@ -0,0 +1,14 @@
+export interface Schema {
+  /**
+   * The name of the Entity.
+   */
+  name: string;
+  /**
+   * The path to create the entity files.
+   */
+  path?: string;
+  /**
+   * Should setup NgRx.
+   */
+  init?: boolean;
+}

src/ngrx-entity/schema.json

@@ -3,6 +3,27 @@
   "id": "BriebugSchematicsNgRxEntity",
   "title": "NgRx Generator Options Schema",
   "type": "object",
-  "properties": {},
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "The name of the component.",
+      "$default": {
+        "$source": "argv",
+        "index": 0
+      }
+    },
+    "path": {
+      "type": "string",
+      "format": "path",
+      "description": "The path to create the entity files",
+      "visible": false,
+      "alias": "p"
+    },
+    "init": {
+      "type": "boolean",
+      "description": "Flag to setup NgRx.",
+      "default": false
+    }
+  },
   "required": []
 }

src/ngrx-entity/utility/parseName.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @license
+ * Copyright Google Inc. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.io/license
+ * source: https://github.com/angular/angular-cli/blob/master/packages/schematics/angular/utility/parse-name.ts
+ */
+import { Path } from '@angular-devkit/core';
+export interface Location {
+    name: string;
+    path: Path;
+}
+export declare function parseName(path: string, name: string): Location;

src/ngrx-entity/utility/util.d.ts

@@ -0,0 +1,6 @@
+export interface NgRxOptions {
+    name: string;
+    path?: string;
+    init?: boolean;
+    flat?: boolean;
+}

src/ngrx-entity/utility/util.ts

@@ -1,5 +1,6 @@
 export interface NgRxOptions {
-  flat?: boolean;
-  name?: string;
+  name: string;
   path?: string;
+  init?: boolean;
+  flat?: boolean;
 }