feat(schematics): Add ng-add support with prompt for making our schem… #1552

itayod · 2019-02-15T09:58:44Z

PR Checklist

Please check if your PR fulfills the following requirements:

The commit message follows our guidelines: https://github.com/ngrx/platform/blob/master/CONTRIBUTING.md#commit
Tests for the changes have been added (for bug fixes / features)
Documentation has been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[x] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Documentation content changes
[ ] Other... Please describe:

Closes #1538

What is the new behavior?

Running ng-add will prompt the user to set @ngrx/schematics as the default collection.

Does this PR introduce a breaking change?

[ ] Yes
[x] No

ngrxbot · 2019-02-15T10:04:18Z

Preview docs changes for 6929ff4 at https://previews.ngrx.io/pr1552-6929ff4/

itayod · 2019-02-15T10:07:53Z

@brandonroberts I hope that's what you had in mind :)

brandonroberts · 2019-02-15T13:51:20Z

@itayod thanks for working on this! What I had in mind is that this would be adding an ng-add to the @ngrx/schematics package similar to what the other packages have with a schematics/ng-add folder and a collection.

itayod · 2019-02-15T16:03:45Z

With pleasure! So just to make things clear, you want me to add ng-add to modules/schematics?
Also, does the current functionality of setting @ngrx/schematics as default looks ok?

brandonroberts · 2019-02-15T16:21:59Z

Yes and yes

ngrxbot · 2019-02-15T17:08:02Z

Preview docs changes for 20576a5 at https://previews.ngrx.io/pr1552-20576a5/

ngrxbot · 2019-02-15T17:44:01Z

Preview docs changes for 0f98d7e at https://previews.ngrx.io/pr1552-0f98d7e/

coveralls · 2019-02-16T17:57:23Z

Coverage increased (+0.09%) to 89.515% when pulling e2d1f20 on itayod:feature/support-default-schematics-prompt into 8532fb1 on ngrx:master.

ngrxbot · 2019-02-16T18:02:48Z

Preview docs changes for 0c52347 at https://previews.ngrx.io/pr1552-0c52347/

timdeschryver

Thanks for another PR 🎉

To make this package available we also have to add a BUILD file, you could use the effect package for an example.

After this we have to append the package to our existing schematics BUILD:

packages = [
        "//modules/schematics/migrations:npm_package",
        "//modules/schematics/schematics:npm_package", // this line is added
        "//modules/schematics/schematics-core:npm_package",
    ],

timdeschryver · 2019-02-16T20:36:27Z

modules/schematics/collection.json

+      "aliases": ["init"],
+      "factory": "./src/ng-add",
+      "schema": "./src/ng-add/schema.json",
+      "description": "Adds initial setup for Ngrx"


What about using the following description here?

"Installs the NgRx schematics package"

timdeschryver · 2019-02-16T20:38:07Z

modules/schematics-core/utility/config.ts

+  host.overwrite(path, JSON.stringify(workSpace, null, 2));
+}
+
+export function updateWorkspace(


This is only used within the @ngrx/schematics package.
Wouldn't it be better to define these functions within the package itself?

timdeschryver · 2019-02-16T20:42:08Z

modules/schematics/src/ng-add/schema.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "id": "SchematicsNgRxRoot",


Might be a bit weird, but the other packages are using the following convention:

Suggested change

"id": "SchematicsNgRxRoot",

"id": "SchematicsNgRxSchematics",

timdeschryver · 2019-02-16T20:42:50Z

modules/schematics/src/ng-add/schema.json

+{
+  "$schema": "http://json-schema.org/schema",
+  "id": "SchematicsNgRxRoot",
+  "title": "NgRx Root Schema",


Suggested change

"title": "NgRx Root Schema",

"title": "Scaffolding library for Angular applications using NgRx libraries",

timdeschryver · 2019-02-16T20:44:00Z

modules/schematics/src/ng-add/schema.json

+    "setSchematicsDefault": {
+      "type": "boolean",
+      "default": true,
+      "description": "Make @ngrx/schematics as the default schematics",


Suggested change

"description": "Make @ngrx/schematics as the default schematics",

"description": "Use @ngrx/schematics as the default collection",

timdeschryver · 2019-02-16T20:46:01Z

modules/schematics/src/ng-add/schema.json

+  "title": "NgRx Root Schema",
+  "type": "object",
+  "properties": {
+    "setSchematicsDefault": {


What about using just default or defaultCollection here?

timdeschryver · 2019-02-16T20:46:12Z

modules/schematics/src/ng-add/schema.ts

@@ -0,0 +1,3 @@
+export interface Schema {
+  setSchematicsDefault?: boolean;


timdeschryver · 2019-02-16T20:47:29Z

modules/schematics/src/ng-add/schema.json

+      "default": true,
+      "description": "Make @ngrx/schematics as the default schematics",
+      "x-prompt":
+        "Would you like to make @ngrx/schematics as the project's default?"


Suggested change

"Would you like to make @ngrx/schematics as the project's default?"

"Would you want to use @ngrx/schematics as the default collection?"

modules/schematics/src/ng-add/index.spec.ts

timdeschryver · 2019-02-16T20:50:09Z

modules/schematics/src/ng-add/schema.json

+  "title": "NgRx Root Schema",
+  "type": "object",
+  "properties": {
+    "setSchematicsDefault": {


What about adding an alias?

"aliases": ["d"]

timdeschryver · 2019-02-17T09:15:28Z

In order to not forget about it, we should also install the @ngrx/schematics package.

itayod · 2019-02-17T16:40:29Z

In order to not forget about it, we should also install the @ngrx/schematics package.

That's what I thought 😄

brandonroberts · 2019-02-18T16:01:04Z

We don't need to explicitly install the @ngrx/schematics package into the package.json anymore. You can do ng add @ngrx/schematics today and it will still add it to the project, but will fail when trying to run an ng-add schematic for it.

itayod · 2019-02-18T19:46:01Z

We don't need to explicitly install the @ngrx/schematics package into the package.json anymore. You can do ng add @ngrx/schematics today and it will still add it to the project, but will fail when trying to run an ng-add schematic for it.

Gtn 😄 , I also was thinking about update the schematics settings in the angular.json.
Since most of the case would probably be replacing @schemtics/angular with @ngrx/schematics and since @ngrx/schematics extends @schematics/angular maybe we should also add something like:

  workspaceString.replace(/@scehmatics\/angular/g, '@ngrx/schematics');

So all of the user's configuration for @schematics/angular will apply to @ngrx/schematics,
Thoughts?

brandonroberts · 2019-02-18T19:54:16Z

You don't need to replace those. It will use NgRx schematics by default if the collection is set. We may do something with the defaults later, but that varies on the developer's project.

brandonroberts · 2019-02-19T15:14:44Z

modules/schematics/src/ng-add/index.ts

+  noop,
+} from '@angular-devkit/schematics';
+import { updateWorkspace } from '../../schematics-core/utility/config';
+import { Schema as RootStoreOptions } from './schema';


Suggested change

import { Schema as RootStoreOptions } from './schema';

import { Schema as SchematicOptions } from './schema';

brandonroberts · 2019-02-19T15:16:52Z

modules/schematics/src/ng-add/index.spec.ts

+} from '@angular-devkit/schematics/testing';
+import * as path from 'path';
+import { createWorkspace } from '../../../schematics-core/testing';
+import { Schema as RootStoreOptions } from './schema';


Suggested change

import { Schema as RootStoreOptions } from './schema';

import { Schema as SchematicOptions } from './schema';

…atics as default

ngrxbot · 2019-02-20T02:19:04Z

Preview docs changes for 4cc081b at https://previews.ngrx.io/pr1552-4cc081b/

ngrxbot · 2019-02-20T03:03:28Z

Preview docs changes for e2d1f20 at https://previews.ngrx.io/pr1552-e2d1f20/

brandonroberts · 2019-02-20T03:06:05Z

Thanks again @itayod 👏

itayod force-pushed the feature/support-default-schematics-prompt branch from 6929ff4 to 20576a5 Compare February 15, 2019 17:00

itayod force-pushed the feature/support-default-schematics-prompt branch from 20576a5 to 0f98d7e Compare February 15, 2019 17:38

itayod force-pushed the feature/support-default-schematics-prompt branch from 0f98d7e to 0c52347 Compare February 16, 2019 17:54

timdeschryver requested changes Feb 16, 2019

View reviewed changes

brandonroberts requested changes Feb 19, 2019

View reviewed changes

feat(schematics): Add ng-add support with prompt for making our schem…

4cc081b

…atics as default

itayod force-pushed the feature/support-default-schematics-prompt branch from 0c52347 to 4cc081b Compare February 19, 2019 20:17

chore: update text in question prompt for default schematics

e2d1f20

brandonroberts approved these changes Feb 20, 2019

View reviewed changes

brandonroberts merged commit 01ff157 into ngrx:master Feb 20, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(schematics): Add ng-add support with prompt for making our schem… #1552

feat(schematics): Add ng-add support with prompt for making our schem… #1552

itayod commented Feb 15, 2019 •

edited

Loading

ngrxbot commented Feb 15, 2019

itayod commented Feb 15, 2019

brandonroberts commented Feb 15, 2019

itayod commented Feb 15, 2019

brandonroberts commented Feb 15, 2019

ngrxbot commented Feb 15, 2019

ngrxbot commented Feb 15, 2019

coveralls commented Feb 16, 2019 •

edited

Loading

ngrxbot commented Feb 16, 2019

timdeschryver left a comment •

edited

Loading

timdeschryver Feb 16, 2019

timdeschryver Feb 16, 2019

timdeschryver Feb 16, 2019

timdeschryver Feb 16, 2019

timdeschryver Feb 16, 2019

timdeschryver Feb 16, 2019

timdeschryver Feb 16, 2019

timdeschryver Feb 16, 2019

timdeschryver Feb 16, 2019

timdeschryver commented Feb 17, 2019 •

edited

Loading

itayod commented Feb 17, 2019

brandonroberts commented Feb 18, 2019

itayod commented Feb 18, 2019

brandonroberts commented Feb 18, 2019

brandonroberts Feb 19, 2019

brandonroberts Feb 19, 2019

ngrxbot commented Feb 20, 2019

ngrxbot commented Feb 20, 2019

brandonroberts commented Feb 20, 2019

	"id": "SchematicsNgRxRoot",
	"id": "SchematicsNgRxSchematics",

	"title": "NgRx Root Schema",
	"title": "Scaffolding library for Angular applications using NgRx libraries",

	"description": "Make @ngrx/schematics as the default schematics",
	"description": "Use @ngrx/schematics as the default collection",

		@@ -0,0 +1,3 @@
		export interface Schema {
		setSchematicsDefault?: boolean;

	"Would you like to make @ngrx/schematics as the project's default?"
	"Would you want to use @ngrx/schematics as the default collection?"

	import { Schema as RootStoreOptions } from './schema';
	import { Schema as SchematicOptions } from './schema';

feat(schematics): Add ng-add support with prompt for making our schem… #1552

feat(schematics): Add ng-add support with prompt for making our schem… #1552

Conversation

itayod commented Feb 15, 2019 • edited Loading

PR Checklist

PR Type

What is the new behavior?

Does this PR introduce a breaking change?

ngrxbot commented Feb 15, 2019

itayod commented Feb 15, 2019

brandonroberts commented Feb 15, 2019

itayod commented Feb 15, 2019

brandonroberts commented Feb 15, 2019

ngrxbot commented Feb 15, 2019

ngrxbot commented Feb 15, 2019

coveralls commented Feb 16, 2019 • edited Loading

ngrxbot commented Feb 16, 2019

timdeschryver left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

timdeschryver commented Feb 17, 2019 • edited Loading

itayod commented Feb 17, 2019

brandonroberts commented Feb 18, 2019

itayod commented Feb 18, 2019

brandonroberts commented Feb 18, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ngrxbot commented Feb 20, 2019

ngrxbot commented Feb 20, 2019

brandonroberts commented Feb 20, 2019

itayod commented Feb 15, 2019 •

edited

Loading

coveralls commented Feb 16, 2019 •

edited

Loading

timdeschryver left a comment •

edited

Loading

timdeschryver commented Feb 17, 2019 •

edited

Loading