feat(@angular-devkit/build-ng-packagr): implement stable architect API

clydin · alexeagle · commit fc48101a90b4 · 2019-03-19T09:05:01.000-07:00
diff --git a/packages/angular_devkit/build_ng_packagr/builders.json b/packages/angular_devkit/build_ng_packagr/builders.json
@@ -3,6 +3,7 @@
   "builders": {
     "build": {
       "class": "./src/build",
+      "implementation": "./src/build/index2",
       "schema": "./src/build/schema.json",
       "description": "Build a library with ng-packagr."
     }
diff --git a/packages/angular_devkit/build_ng_packagr/package.json b/packages/angular_devkit/build_ng_packagr/package.json
@@ -13,12 +13,12 @@
     "semver": "5.6.0"
   },
   "peerDependencies": {
-    "ng-packagr": "^2.2.0 || ^3.0.0 || ^4.0.0"
+    "ng-packagr": "^4.0.0"
   },
   "devDependencies": {
     "@angular/compiler": "^8.0.0-beta.0",
     "@angular/compiler-cli": "^8.0.0-beta.0",
-    "ng-packagr": "^4.2.0",
+    "ng-packagr": "^4.0.0",
     "tsickle": ">=0.34.0",
     "tslib": "^1.9.0"
   }
diff --git a/packages/angular_devkit/build_ng_packagr/src/build/index2.ts b/packages/angular_devkit/build_ng_packagr/src/build/index2.ts
@@ -0,0 +1,44 @@
+/**
+ * @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
+ */
+import { BuilderContext, BuilderOutput, createBuilder } from '@angular-devkit/architect/src/index2';
+import { resolve } from 'path';
+import { Observable, from } from 'rxjs';
+import { catchError, mapTo, switchMap } from 'rxjs/operators';
+import { Schema as NgPackagrBuilderOptions } from './schema';
+
+async function initialize(
+  options: NgPackagrBuilderOptions,
+  root: string,
+): Promise<import ('ng-packagr').NgPackagr> {
+  const packager = (await import('ng-packagr')).ngPackagr();
+
+  packager.forProject(resolve(root, options.project));
+
+  if (options.tsConfig) {
+    packager.withTsConfig(resolve(root, options.tsConfig));
+  }
+
+  return packager;
+}
+
+export function buildLibrary(
+  options: NgPackagrBuilderOptions,
+  context: BuilderContext,
+): Observable<BuilderOutput> {
+  return from(initialize(options, context.workspaceRoot)).pipe(
+    switchMap(packager => options.watch ? packager.watch() : packager.build()),
+    mapTo({ success: true }),
+    catchError(error => {
+      context.reportStatus('Error: ' + error);
+
+      return [{ success: false }];
+    }),
+  );
+}
+
+export default createBuilder<Record<string, string> & NgPackagrBuilderOptions>(buildLibrary);
diff --git a/packages/angular_devkit/build_ng_packagr/src/build/index_spec_large.ts b/packages/angular_devkit/build_ng_packagr/src/build/index_spec_large.ts
@@ -5,47 +5,55 @@
  * 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
  */
-
-import { TargetSpecifier } from '@angular-devkit/architect';
-import { TestProjectHost, runTargetSpec } from '@angular-devkit/architect/testing';
-import { join, normalize, virtualFs } from '@angular-devkit/core';
-import { debounceTime, map, take, tap } from 'rxjs/operators';
-
-const devkitRoot = normalize((global as any)._DevKitRoot); // tslint:disable-line:no-any
-const workspaceRoot = join(devkitRoot, 'tests/angular_devkit/build_ng_packagr/ng-packaged/');
-export const host = new TestProjectHost(workspaceRoot);
+import { WorkspaceNodeModulesArchitectHost } from '@angular-devkit/architect/node';
+import { Architect } from '@angular-devkit/architect/src/index2';
+import { TestProjectHost } from '@angular-devkit/architect/testing';
+import { TestingArchitectHost } from '@angular-devkit/architect/testing/testing-architect-host';
+import { experimental, join, normalize, schema, virtualFs } from '@angular-devkit/core';
+import { map, take, tap } from 'rxjs/operators';
+
+const devkitRoot = (global as unknown as { _DevKitRoot: string})._DevKitRoot;
+const workspaceRoot = join(
+  normalize(devkitRoot),
+  'tests/angular_devkit/build_ng_packagr/ng-packaged/',
+);
 
 describe('NgPackagr Builder', () => {
-  beforeEach(done => host.initialize().toPromise().then(done, done.fail));
-  afterEach(done => host.restore().toPromise().then(done, done.fail));
-
-  it('works', (done) => {
-    const targetSpec: TargetSpecifier = { project: 'lib', target: 'build' };
-
-    runTargetSpec(host, targetSpec).pipe(
-      tap((buildEvent) => expect(buildEvent.success).toBe(true)),
-    ).toPromise().then(done, done.fail);
+  const host = new TestProjectHost(workspaceRoot);
+  let architect: Architect;
+
+  beforeEach(async () => {
+    await host.initialize().toPromise();
+
+    const registry = new schema.CoreSchemaRegistry();
+    registry.addPostTransform(schema.transforms.addUndefinedDefaults);
+
+    const workspace = await experimental.workspace.Workspace.fromPath(host, host.root(), registry);
+    const architectHost = new TestingArchitectHost(
+      host.root(),
+      host.root(),
+      new WorkspaceNodeModulesArchitectHost(workspace, host.root()),
+    );
+    architect = new Architect(architectHost, registry);
   });
 
-  it('tests works', (done) => {
-    const targetSpec: TargetSpecifier = { project: 'lib', target: 'test' };
+  afterEach(() => host.restore().toPromise());
 
-    runTargetSpec(host, targetSpec).pipe(
-      tap((buildEvent) => expect(buildEvent.success).toBe(true)),
-    ).toPromise().then(done, done.fail);
-  });
+  it('builds and packages a library', async () => {
+    const run = await architect.scheduleTarget({ project: 'lib', target: 'build' });
 
-  it('lint works', (done) => {
-    const targetSpec: TargetSpecifier = { project: 'lib', target: 'lint' };
+    await expectAsync(run.result).toBeResolvedTo(jasmine.objectContaining({ success: true }));
 
-    runTargetSpec(host, targetSpec).pipe(
-      tap((buildEvent) => expect(buildEvent.success).toBe(true)),
-    ).toPromise().then(done, done.fail);
-  });
+    await run.stop();
 
-  it('rebuilds on TS file changes', (done) => {
-    const targetSpec: TargetSpecifier = { project: 'lib', target: 'build' };
+    expect(host.scopedSync().exists(normalize('./dist/lib/fesm5/lib.js'))).toBe(true);
+    const content = virtualFs.fileBufferToString(
+      host.scopedSync().read(normalize('./dist/lib/fesm5/lib.js')),
+    );
+    expect(content).toContain('lib works');
+  });
 
+  it('rebuilds on TS file changes', async () => {
     const goldenValueFiles: { [path: string]: string } = {
       'projects/lib/src/lib/lib.component.ts': `
       import { Component } from '@angular/core';
@@ -58,16 +66,14 @@ describe('NgPackagr Builder', () => {
       `,
     };
 
-    const overrides = { watch: true };
+    const run = await architect.scheduleTarget(
+      { project: 'lib', target: 'build' },
+      { watch: true },
+    );
 
     let buildNumber = 0;
 
-    runTargetSpec(host, targetSpec, overrides)
-    .pipe(
-      // We must debounce on watch mode because file watchers are not very accurate.
-      // Changes from just before a process runs can be picked up and cause rebuilds.
-      // In this case, cleanup from the test right before this one causes a few rebuilds.
-      debounceTime(1000),
+    await run.output.pipe(
       tap((buildEvent) => expect(buildEvent.success).toBe(true)),
       map(() => {
         const fileName = './dist/lib/fesm5/lib.js';
@@ -93,8 +99,8 @@ describe('NgPackagr Builder', () => {
         }
       }),
       take(2),
-    )
-    .toPromise()
-    .then(done, done.fail);
+    ).toPromise();
+
+    await run.stop();
   });
 });
diff --git a/packages/angular_devkit/build_ng_packagr/src/build/schema.json b/packages/angular_devkit/build_ng_packagr/src/build/schema.json
@@ -1,11 +1,12 @@
 {
+  "$schema": "http://json-schema.org/draft-07/schema",
   "title": "ng-packagr Target",
   "description": "ng-packagr target options for Build Architect.",
   "type": "object",
   "properties": {
     "project": {
       "type": "string",
-      "description": "The file path of the package.json for distribution via npm."
+      "description": "The file path for the ng-packagr configuration file, relative to the current workspace."
     },
     "tsConfig": {
       "type": "string",
diff --git a/yarn.lock b/yarn.lock
@@ -1642,10 +1642,10 @@ builtin-modules@^1.0.0, builtin-modules@^1.1.1:
   resolved "https://registry.yarnpkg.com/builtin-modules/-/builtin-modules-1.1.1.tgz#270f076c5a72c02f5b65a47df94c5fe3a278892f"
   integrity sha1-Jw8HbFpywC9bZaR9+Uxf46J4iS8=
 
-builtin-modules@^2.0.0:
-  version "2.0.0"
-  resolved "https://registry.yarnpkg.com/builtin-modules/-/builtin-modules-2.0.0.tgz#60b7ef5ae6546bd7deefa74b08b62a43a232648e"
-  integrity sha512-3U5kUA5VPsRUA3nofm/BXX7GVHKfxz0hOBAPxXrIvHzlDRkQVqEn6yi8QJegxl4LzOHLdvb7XF5dVawa/VVYBg==
+builtin-modules@^3.0.0:
+  version "3.0.0"
+  resolved "https://registry.yarnpkg.com/builtin-modules/-/builtin-modules-3.0.0.tgz#1e587d44b006620d90286cc7a9238bbc6129cab1"
+  integrity sha512-hMIeU4K2ilbXV6Uv93ZZ0Avg/M91RaKXucQ+4me2Do1txxBDyDZWCBa5bJSLqoNTRpXTLwEzIk1KmloenDDjhg==
 
 builtin-status-codes@^3.0.0:
   version "3.0.0"
@@ -6229,10 +6229,10 @@ neo-async@^2.5.0:
   resolved "https://registry.yarnpkg.com/neo-async/-/neo-async-2.6.0.tgz#b9d15e4d71c6762908654b5183ed38b753340835"
   integrity sha512-MFh0d/Wa7vkKO3Y3LlacqAEeHK0mckVqzDieUKTT+KGxi+zIpeVsFxymkIiRpbpDziHc290Xr9A1O4Om7otoRA==
 
-ng-packagr@^4.2.0:
-  version "4.4.0"
-  resolved "https://registry.yarnpkg.com/ng-packagr/-/ng-packagr-4.4.0.tgz#b868a829b5743870c6392491de3faf4e4cec6f4d"
-  integrity sha512-dLpC/kmQsdbkL96ZclGjNRhq/J4MwpPKwPYNom74lvXqFC2jbbT/fnwmxX9WKXjvE8MEGsg2D2x8MsRURiNscg==
+ng-packagr@^4.0.0:
+  version "4.7.1"
+  resolved "https://registry.yarnpkg.com/ng-packagr/-/ng-packagr-4.7.1.tgz#a3e8fd2a7b70573a3a7759c4c57408a3b0e8ce11"
+  integrity sha512-MIPKxyrnV22fS3wSfst2XjwWOonFKujVVEnIehYJhiu8GOg37bCdbbr9plsE1jRDmDAUz6M1MvdKibUrJyRp6Q==
   dependencies:
     "@ngtools/json-schema" "^1.1.0"
     autoprefixer "^9.0.0"
@@ -6248,14 +6248,15 @@ ng-packagr@^4.2.0:
     less-plugin-npm-import "^2.1.0"
     node-sass "^4.9.3"
     node-sass-tilde-importer "^1.0.0"
+    opencollective-postinstall "^2.0.1"
     postcss "^7.0.0"
     postcss-url "^8.0.0"
     read-pkg-up "^4.0.0"
     rimraf "^2.6.1"
-    rollup "^0.66.0"
+    rollup "^0.67.0"
     rollup-plugin-commonjs "^9.1.3"
     rollup-plugin-json "^3.1.0"
-    rollup-plugin-node-resolve "^3.0.0"
+    rollup-plugin-node-resolve "^4.0.0"
     rollup-plugin-sourcemaps "^0.4.2"
     rxjs "^6.0.0"
     stylus "^0.54.5"
@@ -6672,6 +6673,11 @@ onetime@^2.0.0:
   dependencies:
     mimic-fn "^1.0.0"
 
+opencollective-postinstall@^2.0.1:
+  version "2.0.2"
+  resolved "https://registry.yarnpkg.com/opencollective-postinstall/-/opencollective-postinstall-2.0.2.tgz#5657f1bede69b6e33a45939b061eb53d3c6c3a89"
+  integrity sha512-pVOEP16TrAO2/fjej1IdOyupJY8KDUM1CvsaScRbw6oddvpQoOfGk4ywha0HKKVAD6RkW4x6Q+tNBwhf3Bgpuw==
+
 opn@5.4.0, opn@^5.1.0:
   version "5.4.0"
   resolved "https://registry.yarnpkg.com/opn/-/opn-5.4.0.tgz#cb545e7aab78562beb11aa3bfabc7042e1761035"
@@ -7051,7 +7057,7 @@ path-key@^2.0.0, path-key@^2.0.1:
   resolved "https://registry.yarnpkg.com/path-key/-/path-key-2.0.1.tgz#411cadb574c5a140d3a4b1910d40d80cc9f40b40"
   integrity sha1-QRyttXTFoUDTpLGRDUDYDMn0C0A=
 
-path-parse@^1.0.5:
+path-parse@^1.0.5, path-parse@^1.0.6:
   version "1.0.6"
   resolved "https://registry.yarnpkg.com/path-parse/-/path-parse-1.0.6.tgz#d62dbb5679405d72c4737ec58600e9ddcf06d24c"
   integrity sha512-GSmOT2EbHrINBf9SR7CDELwlJ8AENk3Qn7OikK4nFYAu3Ote2+JYNVvkpAEQm3/TLNEJFD/xZJjzyxg3KBWOzw==
@@ -7910,6 +7916,13 @@ resolve@^1.1.5, resolve@^1.1.6, resolve@^1.1.7, resolve@^1.3.2, resolve@^1.8.1:
   dependencies:
     path-parse "^1.0.5"
 
+resolve@^1.10.0:
+  version "1.10.0"
+  resolved "https://registry.yarnpkg.com/resolve/-/resolve-1.10.0.tgz#3bdaaeaf45cc07f375656dfd2e54ed0810b101ba"
+  integrity sha512-3sUr9aq5OfSg2S9pNtPA9hL1FVEAjvfOC4leW0SNf/mpnaakz2a9femSd6LqAww2RaFctwyf1lCqnTHuF1rxDg==
+  dependencies:
+    path-parse "^1.0.6"
+
 responselike@^1.0.2:
   version "1.0.2"
   resolved "https://registry.yarnpkg.com/responselike/-/responselike-1.0.2.tgz#918720ef3b631c5642be068f15ade5a46f4ba1e7"
@@ -7972,14 +7985,14 @@ rollup-plugin-json@^3.1.0:
   dependencies:
     rollup-pluginutils "^2.3.1"
 
-rollup-plugin-node-resolve@^3.0.0:
-  version "3.4.0"
-  resolved "https://registry.yarnpkg.com/rollup-plugin-node-resolve/-/rollup-plugin-node-resolve-3.4.0.tgz#908585eda12e393caac7498715a01e08606abc89"
-  integrity sha512-PJcd85dxfSBWih84ozRtBkB731OjXk0KnzN0oGp7WOWcarAFkVa71cV5hTJg2qpVsV2U8EUwrzHP3tvy9vS3qg==
+rollup-plugin-node-resolve@^4.0.0:
+  version "4.0.1"
+  resolved "https://registry.yarnpkg.com/rollup-plugin-node-resolve/-/rollup-plugin-node-resolve-4.0.1.tgz#f95765d174e5daeef9ea6268566141f53aa9d422"
+  integrity sha512-fSS7YDuCe0gYqKsr5OvxMloeZYUSgN43Ypi1WeRZzQcWtHgFayV5tUSPYpxuaioIIWaBXl6NrVk0T2/sKwueLg==
   dependencies:
-    builtin-modules "^2.0.0"
+    builtin-modules "^3.0.0"
     is-module "^1.0.0"
-    resolve "^1.1.6"
+    resolve "^1.10.0"
 
 rollup-plugin-sourcemaps@^0.4.2:
   version "0.4.2"
@@ -7997,10 +8010,10 @@ rollup-pluginutils@^2.0.1, rollup-pluginutils@^2.3.1, rollup-pluginutils@^2.3.3:
     estree-walker "^0.5.2"
     micromatch "^2.3.11"
 
-rollup@^0.66.0:
-  version "0.66.6"
-  resolved "https://registry.yarnpkg.com/rollup/-/rollup-0.66.6.tgz#ce7d6185beb7acea644ce220c25e71ae03275482"
-  integrity sha512-J7/SWanrcb83vfIHqa8+aVVGzy457GcjA6GVZEnD0x2u4OnOd0Q1pCrEoNe8yLwM6z6LZP02zBT2uW0yh5TqOw==
+rollup@^0.67.0:
+  version "0.67.4"
+  resolved "https://registry.yarnpkg.com/rollup/-/rollup-0.67.4.tgz#8ed6b0993337f84ec8a0387f824fa6c197e833ec"
+  integrity sha512-AVuP73mkb4BBMUmksQ3Jw0jTrBTU1i7rLiUYjFxLZGb3xiFmtVEg40oByphkZAsiL0bJC3hRAJUQos/e5EBd+w==
   dependencies:
     "@types/estree" "0.0.39"
     "@types/node" "*"

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`"builders": {`
`4`	`4`	`"build": {`
`5`	`5`	`"class": "./src/build",`
	`6`	`+ "implementation": "./src/build/index2",`
`6`	`7`	`"schema": "./src/build/schema.json",`
`7`	`8`	`"description": "Build a library with ng-packagr."`
`8`	`9`	`}`