@angular-devkit/core 8.0.0-rc.1 → 8.0.0

package/README.md

@@ -56,4 +56,110 @@ export class CoreSchemaRegistry implements SchemaRegistry {
 
 # Utils
 
-# Virtual FS
+# Virtual FS
+
+# Workspaces
+
+The `workspaces` namespace provides an API for interacting with the workspace file formats.
+It provides an abstraction of the underlying storage format of the workspace and provides
+support for both reading and writing.  Currently, the only supported format is the JSON-based
+format used by the Angular CLI.  For this format, the API provides internal change tracking of values which
+enables fine-grained updates to the underlying storage of the workspace.  This allows for the
+retention of existing formatting and comments.
+
+A workspace is defined via the following object model.  Definition collection objects are specialized
+Javascript `Map` objects with an additional `add` method to simplify addition and provide more localized
+error checking of the newly added values.
+
+```ts
+export interface WorkspaceDefinition {
+    readonly extensions: Record<string, JsonValue | undefined>;
+    readonly projects: ProjectDefinitionCollection;
+}
+
+export interface ProjectDefinition {
+    readonly extensions: Record<string, JsonValue | undefined>;
+    readonly targets: TargetDefinitionCollection;
+    root: string;
+    prefix?: string;
+    sourceRoot?: string;
+}
+
+export interface TargetDefinition {
+    options?: Record<string, JsonValue | undefined>;
+    configurations?: Record<string, Record<string, JsonValue | undefined> | undefined>;
+    builder: string;
+}
+```
+
+The API is asynchronous and has two main functions to facilitate reading, creation, and modifying
+a workspace: `readWorkspace` and `writeWorkspace`.
+
+```ts
+export enum WorkspaceFormat {
+  JSON,
+}
+```
+
+```ts
+export function readWorkspace(
+  path: string,
+  host: WorkspaceHost,
+  format?: WorkspaceFormat,
+): Promise<{ workspace: WorkspaceDefinition; }>;
+```
+
+```ts
+export function writeWorkspace(
+  workspace: WorkspaceDefinition,
+  host: WorkspaceHost,
+  path?: string,
+  format?: WorkspaceFormat,
+): Promise<void>;
+```
+
+A `WorkspaceHost` abstracts the underlying data access methods from the functions.  It provides
+methods to read, write, and analyze paths.  A utility function is provided to create
+an instance of a `WorkspaceHost` from the Angular DevKit's virtual filesystem host abstraction.
+
+```ts
+export interface WorkspaceHost {
+    readFile(path: string): Promise<string>;
+    writeFile(path: string, data: string): Promise<void>;
+    isDirectory(path: string): Promise<boolean>;
+    isFile(path: string): Promise<boolean>;
+}
+
+export function createWorkspaceHost(host: virtualFs.Host): WorkspaceHost;
+```
+
+## Usage Example
+
+To demonstrate the usage of the API, the following code will show how to add a option property
+to a build target for an application.
+
+```ts
+import { NodeJsSyncHost } from '@angular-devkit/core/node';
+import { workspaces } from '@angular-devkit/core';
+
+async function demonstrate() {
+    const host = workspaces.createWorkspaceHost(new NodeJsSyncHost());
+    const workspace = await workspaces.readWorkspace('path/to/workspace/directory/', host);
+
+    const project = workspace.projects.get('my-app');
+    if (!project) {
+      throw new Error('my-app does not exist');
+    }
+
+    const buildTarget = project.targets.get('build');
+    if (!buildTarget) {
+      throw new Error('build target does not exist');
+    }
+
+    buildTarget.options.optimization = true;
+
+    await workspaces.writeWorkspace(workspace, host);
+}
+
+demonstrate();
+```

package/node/host.js

@@ -114,7 +114,7 @@ class NodeJsAsyncHost {
         return _callFs(fs.stat, src_1.getSystemPath(path)).pipe(operators_1.map(stat => stat.isDirectory()));
     }
     isFile(path) {
-        return _callFs(fs.stat, src_1.getSystemPath(path)).pipe(operators_1.map(stat => stat.isDirectory()));
+        return _callFs(fs.stat, src_1.getSystemPath(path)).pipe(operators_1.map(stat => stat.isFile()));
     }
     // Some hosts may not support stat.
     stat(path) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@angular-devkit/core",
-  "version": "8.0.0-rc.1",
+  "version": "8.0.0",
   "description": "Angular DevKit - Core Utility Library",
   "main": "src/index.js",
   "typings": "src/index.d.ts",

package/src/json/schema/interface.d.ts

@@ -79,7 +79,6 @@ export interface PromptDefinition {
     type: string;
     message: string;
     default?: string | string[] | number | boolean | null;
-    priority: number;
     validator?: (value: string) => boolean | string | Promise<boolean | string>;
     items?: Array<string | {
         value: JsonValue;

package/src/json/schema/registry.js

@@ -428,7 +428,6 @@ class CoreSchemaRegistry {
                     id: path,
                     type,
                     message,
-                    priority: 0,
                     raw: schema,
                     items,
                     multiselect: type === 'list' ? schema.multiselect : false,
@@ -480,7 +479,6 @@ class CoreSchemaRegistry {
         if (!provider) {
             return rxjs_1.of(data);
         }
-        prompts.sort((a, b) => b.priority - a.priority);
         return rxjs_1.from(provider(prompts)).pipe(operators_1.map(answers => {
             for (const path in answers) {
                 const pathFragments = path.split('/').map(pf => {
@@ -552,7 +550,7 @@ class CoreSchemaRegistry {
                 const fragments = JSON.parse(pointer);
                 const source = this._sourceMap.get(schema.$source);
                 let value = source ? source(schema) : rxjs_1.of(undefined);
-                if (!utils_1.isObservable(value)) {
+                if (!rxjs_1.isObservable(value)) {
                     value = rxjs_1.of(value);
                 }
                 return value.pipe(

package/src/json/schema/visitor.js

@@ -9,7 +9,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
  */
 const rxjs_1 = require("rxjs");
 const operators_1 = require("rxjs/operators");
-const utils_1 = require("../../utils");
 const pointer_1 = require("./pointer");
 function _getObjectSubSchema(schema, key) {
     if (typeof schema !== 'object' || schema === null) {
@@ -46,9 +45,7 @@ root) {
         }
     }
     const value = visitor(json, ptr, schema, root);
-    return (utils_1.isObservable(value)
-        ? value
-        : rxjs_1.of(value)).pipe(operators_1.concatMap((value) => {
+    return (rxjs_1.isObservable(value) ? value : rxjs_1.of(value)).pipe(operators_1.concatMap(value => {
         if (Array.isArray(value)) {
             return rxjs_1.concat(rxjs_1.from(value).pipe(operators_1.mergeMap((item, i) => {
                 return _visitJsonRecursive(item, visitor, pointer_1.joinJsonPointer(ptr, '' + i), _getObjectSubSchema(schema, '' + i), refResolver, context, root || value).pipe(operators_1.tap(x => value[i] = x));

package/src/utils/lang.d.ts

@@ -12,5 +12,6 @@ import { Observable } from 'rxjs';
 export declare function isPromise(obj: any): obj is Promise<any>;
 /**
  * Determine if the argument is an Observable
+ * @deprecated as of 8.0; use rxjs' built-in version
  */
 export declare function isObservable(obj: any | Observable<any>): obj is Observable<any>;

package/src/utils/lang.js

@@ -12,6 +12,7 @@ function isPromise(obj) {
 exports.isPromise = isPromise;
 /**
  * Determine if the argument is an Observable
+ * @deprecated as of 8.0; use rxjs' built-in version
  */
 // tslint:disable-next-line:no-any
 function isObservable(obj) {

package/src/workspace/core.d.ts

@@ -1,11 +1,54 @@
 import { WorkspaceDefinition } from './definitions';
 import { WorkspaceHost } from './host';
+/**
+ * Supported workspace formats
+ */
 export declare enum WorkspaceFormat {
     JSON = 0
 }
+/**
+ * @private
+ */
 export declare function _test_addWorkspaceFile(name: string, format: WorkspaceFormat): void;
+/**
+ * @private
+ */
 export declare function _test_removeWorkspaceFile(name: string): void;
+/**
+ * Reads and constructs a `WorkspaceDefinition`.  If the function is provided with a path to a
+ * directory instead of a file, a search of the directory's files will commence to attempt to
+ * locate a known workspace file.  Currently the following are considered known workspace files:
+ * - `angular.json`
+ * - `.angular.json`
+ *
+ * @param path The path to either a workspace file or a directory containing a workspace file.
+ * @param host The `WorkspaceHost` to use to access the file and directory data.
+ * @param format An optional `WorkspaceFormat` value. Used if the path specifies a non-standard
+ * file name that would prevent automatically discovering the format.
+ *
+ *
+ * @return An `Promise` of the read result object with the `WorkspaceDefinition` contained within
+ * the `workspace` property.
+ */
 export declare function readWorkspace(path: string, host: WorkspaceHost, format?: WorkspaceFormat): Promise<{
     workspace: WorkspaceDefinition;
 }>;
+/**
+ * Writes a `WorkspaceDefinition` to the underlying storage via the provided `WorkspaceHost`.
+ * If the `WorkspaceDefinition` was created via the `readWorkspace` function, metadata will be
+ * used to determine the path and format of the Workspace.  In all other cases, the `path` and
+ * `format` options must be specified as they would be otherwise unknown.
+ *
+ * @param workspace The `WorkspaceDefinition` that will be written.
+ * @param host The `WorkspaceHost` to use to access/write the file and directory data.
+ * @param path The path to a file location for the output. Required if `readWorkspace` was not
+ * used to create the `WorkspaceDefinition`.  Optional otherwise; will override the
+ * `WorkspaceDefinition` metadata if provided.
+ * @param format The `WorkspaceFormat` to use for output. Required if `readWorkspace` was not
+ * used to create the `WorkspaceDefinition`.  Optional otherwise; will override the
+ * `WorkspaceDefinition` metadata if provided.
+ *
+ *
+ * @return An `Promise` of type `void`.
+ */
 export declare function writeWorkspace(workspace: WorkspaceDefinition, host: WorkspaceHost, path?: string, format?: WorkspaceFormat): Promise<void>;

package/src/workspace/core.js

@@ -11,14 +11,23 @@ const virtual_fs_1 = require("../virtual-fs");
 const reader_1 = require("./json/reader");
 const writer_1 = require("./json/writer");
 const formatLookup = new WeakMap();
+/**
+ * Supported workspace formats
+ */
 var WorkspaceFormat;
 (function (WorkspaceFormat) {
     WorkspaceFormat[WorkspaceFormat["JSON"] = 0] = "JSON";
 })(WorkspaceFormat = exports.WorkspaceFormat || (exports.WorkspaceFormat = {}));
+/**
+ * @private
+ */
 function _test_addWorkspaceFile(name, format) {
     workspaceFiles[name] = format;
 }
 exports._test_addWorkspaceFile = _test_addWorkspaceFile;
+/**
+ * @private
+ */
 function _test_removeWorkspaceFile(name) {
     delete workspaceFiles[name];
 }
@@ -28,6 +37,22 @@ const workspaceFiles = {
     'angular.json': WorkspaceFormat.JSON,
     '.angular.json': WorkspaceFormat.JSON,
 };
+/**
+ * Reads and constructs a `WorkspaceDefinition`.  If the function is provided with a path to a
+ * directory instead of a file, a search of the directory's files will commence to attempt to
+ * locate a known workspace file.  Currently the following are considered known workspace files:
+ * - `angular.json`
+ * - `.angular.json`
+ *
+ * @param path The path to either a workspace file or a directory containing a workspace file.
+ * @param host The `WorkspaceHost` to use to access the file and directory data.
+ * @param format An optional `WorkspaceFormat` value. Used if the path specifies a non-standard
+ * file name that would prevent automatically discovering the format.
+ *
+ *
+ * @return An `Promise` of the read result object with the `WorkspaceDefinition` contained within
+ * the `workspace` property.
+ */
 async function readWorkspace(path, host, format) {
     if (await host.isDirectory(path)) {
         // TODO: Warn if multiple found (requires diagnostics support)
@@ -70,6 +95,24 @@ async function readWorkspace(path, host, format) {
     return { workspace };
 }
 exports.readWorkspace = readWorkspace;
+/**
+ * Writes a `WorkspaceDefinition` to the underlying storage via the provided `WorkspaceHost`.
+ * If the `WorkspaceDefinition` was created via the `readWorkspace` function, metadata will be
+ * used to determine the path and format of the Workspace.  In all other cases, the `path` and
+ * `format` options must be specified as they would be otherwise unknown.
+ *
+ * @param workspace The `WorkspaceDefinition` that will be written.
+ * @param host The `WorkspaceHost` to use to access/write the file and directory data.
+ * @param path The path to a file location for the output. Required if `readWorkspace` was not
+ * used to create the `WorkspaceDefinition`.  Optional otherwise; will override the
+ * `WorkspaceDefinition` metadata if provided.
+ * @param format The `WorkspaceFormat` to use for output. Required if `readWorkspace` was not
+ * used to create the `WorkspaceDefinition`.  Optional otherwise; will override the
+ * `WorkspaceDefinition` metadata if provided.
+ *
+ *
+ * @return An `Promise` of type `void`.
+ */
 async function writeWorkspace(workspace, host, path, format) {
     if (format === undefined) {
         format = formatLookup.get(workspace);

package/src/workspace/host.js

@@ -19,7 +19,7 @@ function createWorkspaceHost(host) {
         },
         async isDirectory(path) {
             try {
-                return host.isDirectory(virtual_fs_1.normalize(path)).toPromise();
+                return await host.isDirectory(virtual_fs_1.normalize(path)).toPromise();
             }
             catch (_a) {
                 // some hosts throw if path does not exist
@@ -28,7 +28,7 @@ function createWorkspaceHost(host) {
         },
         async isFile(path) {
             try {
-                return host.isFile(virtual_fs_1.normalize(path)).toPromise();
+                return await host.isFile(virtual_fs_1.normalize(path)).toPromise();
             }
             catch (_a) {
                 // some hosts throw if path does not exist

package/src/workspace/json/metadata.js

@@ -23,6 +23,9 @@ class JsonWorkspaceMetadata {
             for (let i = this.changes.length - 1; i >= 0; --i) {
                 const currentPath = this.changes[i].path;
                 if (currentPath === path || currentPath.startsWith(path + '/')) {
+                    if (op === 'replace' && currentPath === path && this.changes[i].op === 'add') {
+                        op = 'add';
+                    }
                     this.changes.splice(i, 1);
                 }
             }

package/src/workspace/json/writer.js

@@ -37,7 +37,7 @@ function convertJsonWorkspace(workspace, schema) {
         $schema: schema || './node_modules/@angular/cli/lib/config/schema.json',
         version: 1,
         ...workspace.extensions,
-        projects: convertJsonProjectCollection(workspace.projects),
+        projects: workspace.projects ? convertJsonProjectCollection(workspace.projects) : {},
     };
     return obj;
 }