Show warning on deprecated option usage

etc/api/angular_devkit/core/src/_golden-api.d.ts

@@ -226,6 +226,7 @@ export declare class CoreSchemaRegistry implements SchemaRegistry {
     flatten(schema: JsonObject): Observable<JsonObject>;
     registerUriHandler(handler: UriHandler): void;
     usePromptProvider(provider: PromptProvider): void;
+    useXDeprecatedProvider(onUsage: (message: string) => void): void;
 }
 
 export declare function createWorkspaceHost(host: virtualFs.Host): WorkspaceHost;
@@ -904,6 +905,7 @@ export interface SchemaRegistry {
     compile(schema: Object): Observable<SchemaValidator>;
     flatten(schema: JsonObject | string): Observable<JsonObject>;
     usePromptProvider(provider: PromptProvider): void;
+    useXDeprecatedProvider(onUsage: (message: string) => void): void;
 }
 
 export declare class SchemaValidationException extends BaseException {

packages/angular/cli/models/architect-command.ts

@@ -42,6 +42,7 @@ export abstract class ArchitectCommand<
 
     this._registry = new json.schema.CoreSchemaRegistry();
     this._registry.addPostTransform(json.schema.transforms.addUndefinedDefaults);
+    this._registry.useXDeprecatedProvider(msg => this.logger.warn(msg));
 
     const { workspace } = await workspaces.readWorkspace(
       this.workspace.root,

packages/angular/cli/models/interface.ts

@@ -147,12 +147,6 @@ export interface Option {
    */
   positional?: number;
 
-  /**
-   * Deprecation. If this flag is not false a warning will be shown on the console. Either `true`
-   * or a string to show the user as a notice.
-   */
-  deprecated?: boolean | string;
-
   /**
    * Smart default object.
    */

packages/angular/cli/models/parser.ts

@@ -199,11 +199,6 @@ function _assignOption(
         }
 
         parsedOptions[option.name] = v;
-
-        if (option.deprecated !== undefined && option.deprecated !== false) {
-          warnings.push(`Option ${JSON.stringify(option.name)} is deprecated${
-            typeof option.deprecated == 'string' ? ': ' + option.deprecated : '.'}`);
-        }
       }
     } else {
       let error = `Argument ${key} could not be parsed using value ${JSON.stringify(value)}.`;

packages/angular/cli/models/parser_spec.ts

@@ -171,43 +171,6 @@ describe('parseArguments', () => {
     });
   });
 
-  it('handles deprecation', () => {
-    const options = [
-      { name: 'bool', aliases: [], type: OptionType.Boolean, description: '' },
-      { name: 'depr', aliases: [], type: OptionType.Boolean, description: '', deprecated: true },
-      { name: 'deprM', aliases: [], type: OptionType.Boolean, description: '', deprecated: 'ABCD' },
-    ];
-
-    const logger = new logging.Logger('');
-    const messages: string[] = [];
-
-    logger.subscribe(entry => messages.push(entry.message));
-
-    let result = parseArguments(['--bool'], options, logger);
-    expect(result).toEqual({ bool: true });
-    expect(messages).toEqual([]);
-
-    result = parseArguments(['--depr'], options, logger);
-    expect(result).toEqual({ depr: true });
-    expect(messages.length).toEqual(1);
-    expect(messages[0]).toMatch(/\bdepr\b/);
-    messages.shift();
-
-    result = parseArguments(['--depr', '--bool'], options, logger);
-    expect(result).toEqual({ depr: true, bool: true });
-    expect(messages.length).toEqual(1);
-    expect(messages[0]).toMatch(/\bdepr\b/);
-    messages.shift();
-
-    result = parseArguments(['--depr', '--bool', '--deprM'], options, logger);
-    expect(result).toEqual({ depr: true, deprM: true, bool: true });
-    expect(messages.length).toEqual(2);
-    expect(messages[0]).toMatch(/\bdepr\b/);
-    expect(messages[1]).toMatch(/\bdeprM\b/);
-    expect(messages[1]).toMatch(/\bABCD\b/);
-    messages.shift();
-  });
-
   it('handles a flag being added multiple times', () => {
     const options = [
       { name: 'bool', aliases: [], type: OptionType.Boolean, description: '' },

packages/angular/cli/models/schematic-command.ts

@@ -317,6 +317,7 @@ export abstract class SchematicCommand<
     workflow.engineHost.registerOptionsTransform(validateOptionsWithSchema(workflow.registry));
 
     workflow.registry.addSmartDefaultProvider('projectName', getProjectName);
+    workflow.registry.useXDeprecatedProvider(msg => this.logger.warn(msg));
 
     if (options.interactive !== false && isTTY()) {
       workflow.registry.usePromptProvider((definitions: Array<schema.PromptDefinition>) => {

packages/angular/cli/utilities/json-schema.ts

@@ -248,11 +248,6 @@ export async function parseJsonSchemaToOptions(
     const visible = current.visible === undefined || current.visible === true;
     const hidden = !!current.hidden || !visible;
 
-    // Deprecated is set only if it's true or a string.
-    const xDeprecated = current['x-deprecated'];
-    const deprecated = (xDeprecated === true || typeof xDeprecated == 'string')
-      ? xDeprecated : undefined;
-
     const xUserAnalytics = current['x-user-analytics'];
     const userAnalytics = typeof xUserAnalytics == 'number' ? xUserAnalytics : undefined;
 
@@ -267,7 +262,6 @@ export async function parseJsonSchemaToOptions(
       ...format !== undefined ? { format } : {},
       hidden,
       ...userAnalytics ? { userAnalytics } : {},
-      ...deprecated !== undefined ? { deprecated } : {},
       ...positional !== undefined ? { positional } : {},
     };
 

packages/angular_devkit/architect_cli/bin/architect.ts

@@ -202,6 +202,9 @@ async function main(args: string[]): Promise<number> {
   const registry = new schema.CoreSchemaRegistry();
   registry.addPostTransform(schema.transforms.addUndefinedDefaults);
 
+  // Show usage of deprecated options
+  registry.useXDeprecatedProvider(msg => logger.warn(msg));
+
   const { workspace } = await workspaces.readWorkspace(
     configFilePath,
     workspaces.createWorkspaceHost(new NodeJsSyncHost()),

packages/angular_devkit/core/src/json/schema/interface.ts

@@ -117,6 +117,7 @@ export interface SchemaRegistry {
   addFormat(format: SchemaFormat): void;
   addSmartDefaultProvider<T>(source: string, provider: SmartDefaultProvider<T>): void;
   usePromptProvider(provider: PromptProvider): void;
+  useXDeprecatedProvider(onUsage: (message: string) => void): void;
 
   /**
    * Add a transformation step before the validation of any Json.

packages/angular_devkit/core/src/json/schema/registry.ts

@@ -461,9 +461,7 @@ export class CoreSchemaRegistry implements SchemaRegistry {
     this._ajv.addFormat(format.name, {
       async: format.formatter.async,
       validate,
-    // AJV typings list `compare` as required, but it is optional.
-    // tslint:disable-next-line:no-any
-    } as any);
+    });
   }
 
   addSmartDefaultProvider<T>(source: string, provider: SmartDefaultProvider<T>) {
@@ -755,4 +753,17 @@ export class CoreSchemaRegistry implements SchemaRegistry {
       }),
     );
   }
+
+  useXDeprecatedProvider(onUsage: (message: string) => void): void {
+    this._ajv.addKeyword('x-deprecated', {
+      validate: (schema, _data, _parentSchema, _dataPath, _parentDataObject, propertyName) => {
+        if (schema) {
+          onUsage(`Option "${propertyName}" is deprecated${typeof schema == 'string' ? ': ' + schema : '.'}`);
+        }
+
+        return true;
+      },
+      errors: false,
+    });
+  }
 }

packages/angular_devkit/core/src/json/schema/registry_spec.ts

@@ -481,4 +481,35 @@ describe('CoreSchemaRegistry', () => {
       .toPromise().then(done, done.fail);
   });
 
+  it('adds deprecated options usage', done => {
+    const registry = new CoreSchemaRegistry();
+    const deprecatedMessages: string[] = [];
+    registry.useXDeprecatedProvider(m => deprecatedMessages.push(m));
+
+    const data = {
+      foo: true,
+      bar: true,
+      bat: true,
+    };
+
+    registry
+      .compile({
+        properties: {
+          foo: { type: 'boolean', 'x-deprecated': 'Use bar instead.' },
+          bar: { type: 'boolean', 'x-deprecated': true },
+          buz: { type: 'boolean', 'x-deprecated': true },
+          bat: { type: 'boolean', 'x-deprecated': false },
+        },
+      })
+      .pipe(
+        mergeMap(validator => validator(data)),
+        map(result => {
+          expect(deprecatedMessages.length).toBe(2);
+          expect(deprecatedMessages[0]).toBe('Option "foo" is deprecated: Use bar instead.');
+          expect(deprecatedMessages[1]).toBe('Option "bar" is deprecated.');
+          expect(result.success).toBe(true, result.errors);
+        }),
+      )
+      .toPromise().then(done, done.fail);
+  });
 });

packages/angular_devkit/schematics_cli/bin/schematics.ts

@@ -259,6 +259,9 @@ export async function main({
     parsedArgs[key] = argv2[key];
   }
 
+  // Show usage of deprecated options
+  workflow.registry.useXDeprecatedProvider(msg => logger.warn(msg));
+
   // Pass the rest of the arguments as the smart default "argv". Then delete it.
   workflow.registry.addSmartDefaultProvider('argv', (schema: JsonObject) => {
     if ('index' in schema) {