feat: implement ng add for store and effects packages #1067

vitaliy-bobrov · 2018-05-14T21:11:15Z

Implementation of #920 WIP.

This is the implementation of @ngrx/store ng-add module to get feedback, cause other ng-adds will be done in a similar way.

Done:

created schematics "submodule" inside @ngrx/store with needed build configuration
implemented optional addition @ngrx/store as dependency to package.json (idea from https://github.com/angular/material2/tree/master/src/lib/schematics)
store ng-add doesn't import and initialize StoreDevtoolsModule (imho should be done ny store-devtools ng-add)

Additional code share optimizations could be performed later, after initial implementation.

Will work on other modules after gathering a feedback.

coveralls · 2018-05-14T21:13:49Z

Coverage increased (+0.7%) to 87.607% when pulling 26a065f on vitaliy-bobrov:ng-add into 440b6cf on ngrx:master.

# Conflicts: # modules/effects/schematics-core/index.ts # modules/effects/schematics-core/templates/store/__path__/__statePath__/index.ts # modules/entity/schematics-core/index.ts # modules/router-store/schematics-core/index.tsa # modules/schematics-core/index.ts # modules/schematics/schematics-core/index.ts # modules/schematics/src/store/files/__path__/__statePath__/index.ts # modules/schematics/src/store/files/__statePath__/index.ts # modules/store-devtools/schematics-core/index.ts # modules/store/schematics-core/index.ts

brandonroberts · 2018-05-15T12:37:28Z

modules/store/schematics/tsconfig-build.json

@@ -0,0 +1,18 @@
+{


Remove this file. The npm_package already has a default tsconfig.json` to use

brandonroberts · 2018-05-15T12:41:50Z

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

+  addPackageToPackageJson,
+  platformVersion,
+  parseName,
+} from '../../schematics-core';


Use the @ngrx/schematics/schematics-core import here

brandonroberts · 2018-05-15T12:42:29Z

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

+    appTree = createWorkspace(schematicRunner, appTree);
+  });
+
+  it('should update package.json', () => {


Add a test for the skipPackageJson option

brandonroberts · 2018-05-15T12:44:29Z

modules/store/package.json

@@ -19,8 +22,11 @@
  "homepage": "https://github.com/ngrx/platform#readme",
  "peerDependencies": {
    "@angular/core": "NG_VERSION",
+    "@angular-devkit/core": "NG_DEVKIT_VERSION",


Remove these from the package.json as we are treating them as implicit dependencies instead of adding additional dependencies to @ngrx/store

brandonroberts · 2018-05-15T12:46:32Z

.prettierignore

@@ -1,5 +1,7 @@
 /dist
 /modules/schematics/src/*/files/*
+/modules/schematics-core/templates/*


Change templates to files so its consistent with schematics. If we want to change files to templates across the board, we'll do that in a separate PR.

brandonroberts · 2018-05-15T12:49:08Z

modules/store/schematics/BUILD

@@ -0,0 +1,34 @@
+package(default_visibility = ["//visibility:public"])


This should be added to the packages section in the modules/store/BUILD file in the npm_package. That way its output gets copied into the distribution.

brandonroberts · 2018-05-15T12:56:15Z

I left some feedback. I'd rather have 2 copies of the store schematics template files, then put them into the schematics-core and have 6 copies in places where they will never be used.

vitaliy-bobrov · 2018-05-15T13:02:47Z

Thanks for the review, will work on changes. Regarding templates, I also not sure about keeping them in core, just thought that it could be good to have the only source.

brandonroberts · 2018-05-15T13:07:39Z

Since its only one file, I think it will be ok to have 2 copies.

brandonroberts · 2018-05-19T03:52:17Z

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

+    const relativePath = buildRelativePath(modulePath, statePath);
+    const environmentsPath = buildRelativePath(
+      statePath,
+      `/${options.path}/environments/environment`


Update this to match https://github.com/ngrx/platform/blob/master/modules/schematics/src/store/index.ts#L57

brandonroberts · 2018-05-19T03:58:28Z

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

+  addPackageToPackageJson,
+  platformVersion,
+  parseName,
+} from '@ngrx/schematics/schematics-core';


This should be @ngrx/store/schematics-core

brandonroberts · 2018-05-19T04:01:09Z

modules/store/package.json

@@ -21,6 +24,7 @@
    "@angular/core": "NG_VERSION",
    "rxjs": "RXJS_VERSION"
  },
+  "schematics": "./schematics/collection.json",


Add this replacement to /tools/default.bzl

brandonroberts · 2018-05-19T04:02:50Z

Added a couple more changes, otherwise I think this is ready to implement in the other packages.

feat(Store): implement ng add

83e4753

brandonroberts requested changes May 15, 2018

View reviewed changes

vitaliy-bobrov added 4 commits May 15, 2018 19:37

Implemented suggested changes.

50538c0

Restore BUILD files

0c9f0fe

Restore BUILD file

25d3a3d

Restore BUILD files

cbd08ed

brandonroberts requested changes May 19, 2018

View reviewed changes

vitaliy-bobrov and others added 10 commits May 22, 2018 09:48

Implemented additional requested changes.

3f0a143

Update source path to reflect changes

1970999

Update source path to reflect changes

51f5a64

Fix store schematics dependency

f9c40c2

feat(Effects): implement ng add

44c4d89

Merge branch 'upstream' into ng-add

1f91998

Effects ng-add implementation.

803d000

Fix effects schematics-core path

0ad27f8

Restore move code

2d51f22

Revert move code change

26a065f

brandonroberts approved these changes May 23, 2018

View reviewed changes

brandonroberts changed the title ~~Implement ng add (WIP)~~ feat: Implement ng add for store and effects packages May 23, 2018

brandonroberts changed the title ~~feat: Implement ng add for store and effects packages~~ feat: implement ng add for store and effects packages May 23, 2018

brandonroberts merged commit db94db7 into ngrx:master May 23, 2018

vitaliy-bobrov deleted the ng-add branch May 24, 2018 09:21

ngfelixl mentioned this pull request Dec 27, 2018

feat(schematics): implement router store ng-add #1487

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: implement ng add for store and effects packages #1067

feat: implement ng add for store and effects packages #1067

vitaliy-bobrov commented May 14, 2018 •

edited

Loading

coveralls commented May 14, 2018 •

edited

Loading

brandonroberts May 15, 2018

brandonroberts May 15, 2018

brandonroberts May 15, 2018

brandonroberts May 15, 2018

brandonroberts May 15, 2018

brandonroberts May 15, 2018

brandonroberts commented May 15, 2018 •

edited

Loading

vitaliy-bobrov commented May 15, 2018

brandonroberts commented May 15, 2018

brandonroberts May 19, 2018

brandonroberts May 19, 2018

brandonroberts May 19, 2018

brandonroberts commented May 19, 2018

		@@ -0,0 +1,34 @@
		package(default_visibility = ["//visibility:public"])

feat: implement ng add for store and effects packages #1067

feat: implement ng add for store and effects packages #1067

Conversation

vitaliy-bobrov commented May 14, 2018 • edited Loading

coveralls commented May 14, 2018 • 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

brandonroberts commented May 15, 2018 • edited Loading

vitaliy-bobrov commented May 15, 2018

brandonroberts commented May 15, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

brandonroberts commented May 19, 2018

vitaliy-bobrov commented May 14, 2018 •

edited

Loading

coveralls commented May 14, 2018 •

edited

Loading

brandonroberts commented May 15, 2018 •

edited

Loading