feat(Schematics): Introduce @ngrx/schematics (#631)

Closes #53

.prettierignore

@@ -0,0 +1,2 @@
+/dist
+/modules/schematics/src/*/files/*

build/builder.ts

@@ -12,6 +12,7 @@ export default createBuilder([
   ['Cleaning JavaScript files', tasks.cleanJavaScriptFiles],
   ['Removing remaining sourcemap files', tasks.removeRemainingSourceMapFiles],
   ['Copying type definition files', tasks.copyTypeDefinitionFiles],
+  ['Copying schematic files', tasks.copySchematicFiles],
   ['Minifying UMD bundles', tasks.minifyUmdBundles],
   ['Copying documents', tasks.copyDocs],
   ['Copying package.json files', tasks.copyPackageJsonFiles],

build/config.ts

@@ -1,6 +1,7 @@
 export interface PackageDescription {
   name: string;
   hasTestingModule: boolean;
+  bundle: boolean;
 }
 
 export interface Config {
@@ -12,25 +13,36 @@ export const packages: PackageDescription[] = [
   {
     name: 'store',
     hasTestingModule: false,
+    bundle: true,
   },
   {
     name: 'effects',
     hasTestingModule: true,
+    bundle: true,
   },
   {
     name: 'router-store',
     hasTestingModule: false,
+    bundle: true,
   },
   {
     name: 'store-devtools',
     hasTestingModule: false,
+    bundle: true,
   },
   {
     name: 'entity',
     hasTestingModule: false,
+    bundle: true,
   },
   {
     name: 'codegen',
     hasTestingModule: false,
+    bundle: true,
+  },
+  {
+    name: 'schematics',
+    hasTestingModule: false,
+    bundle: false,
   },
 ];

build/tasks.ts

@@ -41,7 +41,9 @@ async function _compilePackagesWithNgc(pkg: string) {
     : [pkg, 'index'];
 
   const entryTypeDefinition = `export * from './${exportPath}/${moduleName}';`;
-  const entryMetadata = `{"__symbolic":"module","version":3,"metadata":{},"exports":[{"from":"./${pkg}/index"}]}`;
+  const entryMetadata = `{"__symbolic":"module","version":3,"metadata":{},"exports":[{"from":"./${
+    pkg
+  }/index"}]}`;
 
   await Promise.all([
     util.writeFile(`./dist/packages/${pkg}.d.ts`, entryTypeDefinition),
@@ -57,6 +59,9 @@ export async function bundleFesms(config: Config) {
   const pkgs = util.getAllPackages(config);
 
   await mapAsync(pkgs, async pkg => {
+    if (!util.shouldBundle(config, pkg)) {
+      return;
+    }
     const topLevelName = util.getTopLevelName(pkg);
 
     await util.exec('rollup', [
@@ -79,6 +84,9 @@ export async function downLevelFesmsToES5(config: Config) {
   const tscArgs = ['--target es5', '--module es2015', '--noLib', '--sourceMap'];
 
   await mapAsync(packages, async pkg => {
+    if (!util.shouldBundle(config, pkg)) {
+      return;
+    }
     const topLevelName = util.getTopLevelName(pkg);
 
     const file = `./dist/${topLevelName}/${config.scope}/${pkg}.js`;
@@ -98,6 +106,9 @@ export async function downLevelFesmsToES5(config: Config) {
  */
 export async function createUmdBundles(config: Config) {
   await mapAsync(util.getAllPackages(config), async pkg => {
+    if (!util.shouldBundle(config, pkg)) {
+      return;
+    }
     const topLevelName = util.getTopLevelName(pkg);
     const destinationName = util.getDestinationName(pkg);
 
@@ -127,14 +138,21 @@ export async function cleanTypeScriptFiles(config: Config) {
  * leaving the bundles and FESM in place
  */
 export async function cleanJavaScriptFiles(config: Config) {
+  const packages = util
+    .getTopLevelPackages(config)
+    .filter(pkg => !util.shouldBundle(config, pkg));
   const jsFilesGlob = './dist/packages/**/*.js';
   const jsExcludeFilesFlob = './dist/packages/(bundles|@ngrx)/**/*.js';
   const filesToRemove = await util.getListOfFiles(
     jsFilesGlob,
     jsExcludeFilesFlob
   );
 
-  await mapAsync(filesToRemove, util.remove);
+  const filteredFilesToRemove = filesToRemove.filter((file: string) =>
+    packages.some(pkg => file.indexOf(pkg) === -1)
+  );
+
+  await mapAsync(filteredFilesToRemove, util.remove);
 }
 
 /**
@@ -143,6 +161,9 @@ export async function cleanJavaScriptFiles(config: Config) {
  */
 export async function renamePackageEntryFiles(config: Config) {
   await mapAsync(util.getAllPackages(config), async pkg => {
+    if (!util.shouldBundle(config, pkg)) {
+      return;
+    }
     const bottomLevelName = util.getBottomLevelName(pkg);
 
     const files = await util.getListOfFiles(`./dist/packages/${pkg}/index.**`);
@@ -192,6 +213,9 @@ export async function minifyUmdBundles(config: Config) {
   const uglifyArgs = ['-c', '-m', '--comments'];
 
   await mapAsync(util.getAllPackages(config), async pkg => {
+    if (!util.shouldBundle(config, pkg)) {
+      return;
+    }
     const topLevelName = util.getTopLevelName(pkg);
     const destinationName = util.getDestinationName(pkg);
     const file = `./dist/${topLevelName}/bundles/${destinationName}.umd.js`;
@@ -201,7 +225,9 @@ export async function minifyUmdBundles(config: Config) {
       file,
       ...uglifyArgs,
       `-o ${out}`,
-      `--source-map "filename='${out}.map' includeSources='${file}', content='${file}.map'"`,
+      `--source-map "filename='${out}.map' includeSources='${file}', content='${
+        file
+      }.map'"`,
     ]);
   });
 }
@@ -288,3 +314,28 @@ export function mapAsync<T>(
 ) {
   return Promise.all(list.map(mapFn));
 }
+
+/**
+ * Copy schematics files
+ */
+export async function copySchematicFiles(config: Config) {
+  const packages = util
+    .getTopLevelPackages(config)
+    .filter(pkg => !util.shouldBundle(config, pkg));
+
+  const collectionFiles = await util.getListOfFiles(
+    `./modules/?(${packages.join('|')})/collection.json`
+  );
+  const schemaFiles = await util.getListOfFiles(
+    `./modules/?(${packages.join('|')})/src/*/schema.*`
+  );
+  const templateFiles = await util.getListOfFiles(
+    `./modules/?(${packages.join('|')})/src/*/files/*`
+  );
+  const files = [...collectionFiles, ...schemaFiles, ...templateFiles];
+
+  await mapAsync(files, async file => {
+    const target = file.replace('modules/', 'dist/');
+    await util.copy(file, target);
+  });
+}

build/util.ts

@@ -134,9 +134,12 @@ export function createBuilder(tasks: TaskDef[]) {
 }
 
 export function flatMap<K, J>(list: K[], mapFn: (item: K) => J[]): J[] {
-  return list.reduce(function(newList, nextItem) {
-    return [...newList, ...mapFn(nextItem)];
-  }, [] as J[]);
+  return list.reduce(
+    function(newList, nextItem) {
+      return [...newList, ...mapFn(nextItem)];
+    },
+    [] as J[]
+  );
 }
 
 export function getTopLevelPackages(config: Config) {
@@ -178,3 +181,9 @@ export function getBottomLevelName(packageName: string) {
 export function baseDir(...dirs: string[]): string {
   return `"${path.resolve(__dirname, '../', ...dirs)}"`;
 }
+
+export function shouldBundle(config: Config, packageName: string) {
+  const pkg = config.packages.find(pkg => pkg.name === packageName);
+
+  return pkg ? pkg.bundle : false;
+}

circle.yml

@@ -2,7 +2,7 @@ machine:
   environment:
     PATH: "${PATH}:${HOME}/${CIRCLE_PROJECT_REPONAME}/node_modules/.bin"
   node:
-    version: 8.6.0
+    version: 8.9.1
 
 dependencies:
   pre:

example-app/app/auth/components/login-form.component.spec.ts

@@ -33,7 +33,7 @@ describe('Login Page', () => {
      * HTML.
      *
      * We can also use this as a validation tool against changes
-     * to the component's template against the currently stored 
+     * to the component's template against the currently stored
      * snapshot.
      */
     expect(fixture).toMatchSnapshot();

example-app/app/books/effects/book.ts

@@ -61,10 +61,10 @@ export class BookEffects {
     @Inject(SEARCH_DEBOUNCE)
     private debounce: number,
     /**
-       * You inject an optional Scheduler that will be undefined
-       * in normal application usage, but its injected here so that you can mock out
-       * during testing using the RxJS TestScheduler for simulating passages of time.
-       */
+     * You inject an optional Scheduler that will be undefined
+     * in normal application usage, but its injected here so that you can mock out
+     * during testing using the RxJS TestScheduler for simulating passages of time.
+     */
     @Optional()
     @Inject(SEARCH_SCHEDULER)
     private scheduler: Scheduler

example-app/app/books/reducers/index.ts

@@ -11,7 +11,7 @@ export interface BooksState {
 }
 
 export interface State extends fromRoot.State {
-  'books': BooksState;
+  books: BooksState;
 }
 
 export const reducers = {
@@ -39,7 +39,7 @@ export const reducers = {
 /**
  * The createFeatureSelector function selects a piece of state from the root of the state object.
  * This is used for selecting feature states that are loaded eagerly or lazily.
-*/
+ */
 export const getBooksState = createFeatureSelector<BooksState>('books');
 
 /**

modules/codegen/src/metadata/get-type.ts

@@ -13,7 +13,7 @@ export function getType(
   }
 
   return ts.isLiteralTypeNode(typeProperty.type as any)
-    ? typeProperty.type as any
+    ? (typeProperty.type as any)
     : undefined;
 
   // return !!typeProperty && ts.isLiteralTypeNode(typeProperty.type) ? typeProperty.type : undefined;

modules/codegen/src/metadata/is-action-descendent.ts

@@ -9,9 +9,9 @@ export function isActionDescendent(
     return heritageClauses.some(clause => {
       /**
        * TODO: This breaks if the interface looks like this:
-       * 
+       *
        *   interface MyAction extends ngrx.Action { }
-       * 
+       *
        */
       return clause.types.some(type => type.expression.getText() === 'Action');
     });

modules/effects/spec/actions.spec.ts

@@ -63,11 +63,15 @@ describe('Actions', function() {
     const actions = [ADD, ADD, SUBTRACT, ADD, SUBTRACT];
     const expected = actions.filter(type => type === ADD);
 
-    actions$.ofType(ADD).map(update => update.type).toArray().subscribe({
-      next(actual) {
-        expect(actual).toEqual(expected);
-      },
-    });
+    actions$
+      .ofType(ADD)
+      .map(update => update.type)
+      .toArray()
+      .subscribe({
+        next(actual) {
+          expect(actual).toEqual(expected);
+        },
+      });
 
     actions.forEach(action => dispatcher.next({ type: action }));
     dispatcher.complete();

modules/effects/src/effects_resolver.ts

@@ -14,31 +14,31 @@ export function mergeEffects(
 ): Observable<EffectNotification> {
   const sourceName = getSourceForInstance(sourceInstance).constructor.name;
 
-  const observables: Observable<any>[] = getSourceMetadata(
-    sourceInstance
-  ).map(({ propertyName, dispatch }): Observable<EffectNotification> => {
-    const observable: Observable<any> =
-      typeof sourceInstance[propertyName] === 'function'
-        ? sourceInstance[propertyName]()
-        : sourceInstance[propertyName];
-
-    if (dispatch === false) {
-      return ignoreElements.call(observable);
+  const observables: Observable<any>[] = getSourceMetadata(sourceInstance).map(
+    ({ propertyName, dispatch }): Observable<EffectNotification> => {
+      const observable: Observable<any> =
+        typeof sourceInstance[propertyName] === 'function'
+          ? sourceInstance[propertyName]()
+          : sourceInstance[propertyName];
+
+      if (dispatch === false) {
+        return ignoreElements.call(observable);
+      }
+
+      const materialized$ = materialize.call(observable);
+
+      return map.call(
+        materialized$,
+        (notification: Notification<Action>): EffectNotification => ({
+          effect: sourceInstance[propertyName],
+          notification,
+          propertyName,
+          sourceName,
+          sourceInstance,
+        })
+      );
     }
-
-    const materialized$ = materialize.call(observable);
-
-    return map.call(
-      materialized$,
-      (notification: Notification<Action>): EffectNotification => ({
-        effect: sourceInstance[propertyName],
-        notification,
-        propertyName,
-        sourceName,
-        sourceInstance,
-      })
-    );
-  });
+  );
 
   return merge(...observables);
 }

modules/schematics/README.md

@@ -0,0 +1,6 @@
+@ngrx/schematics
+=======
+
+The sources for this package are in the main [ngrx/platform](https://github.com/ngrx/platform) repo. Please file issues and pull requests against that repo.
+
+License: MIT