feat(core): add undecorated classes with decorated fields schematic (#32130)

Adds a schematic that adds a `Directive` decorator to undecorated classes that have fields that use Angular decorators.

PR Close #32130

packages/core/schematics/test/BUILD.bazel

@@ -14,6 +14,7 @@ ts_library(
         "//packages/core/schematics/migrations/renderer-to-renderer2",
         "//packages/core/schematics/migrations/static-queries",
         "//packages/core/schematics/migrations/template-var-assignment",
+        "//packages/core/schematics/migrations/undecorated-classes-with-decorated-fields",
         "//packages/core/schematics/migrations/undecorated-classes-with-di",
         "//packages/core/schematics/utils",
         "@npm//@angular-devkit/core",

packages/core/schematics/test/google3/undecorated_classes_with_decorated_fields_spec.ts

@@ -0,0 +1,233 @@
+/**
+ * @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 {readFileSync, writeFileSync} from 'fs';
+import {dirname, join} from 'path';
+import * as shx from 'shelljs';
+import {Configuration, Linter} from 'tslint';
+
+describe('Google3 undecorated classes with decorated fields TSLint rule', () => {
+  const rulesDirectory = dirname(
+      require.resolve('../../migrations/google3/undecoratedClassesWithDecoratedFieldsRule'));
+
+  let tmpDir: string;
+
+  beforeEach(() => {
+    tmpDir = join(process.env['TEST_TMPDIR'] !, 'google3-test');
+    shx.mkdir('-p', tmpDir);
+    writeFile('tsconfig.json', JSON.stringify({compilerOptions: {module: 'es2015'}}));
+  });
+
+  afterEach(() => shx.rm('-r', tmpDir));
+
+  function runTSLint(fix: boolean) {
+    const program = Linter.createProgram(join(tmpDir, 'tsconfig.json'));
+    const linter = new Linter({fix, rulesDirectory: [rulesDirectory]}, program);
+    const config = Configuration.parseConfigFile({
+      rules: {'undecorated-classes-with-decorated-fields': true},
+      linterOptions: {typeCheck: true}
+    });
+
+    program.getRootFileNames().forEach(fileName => {
+      linter.lint(fileName, program.getSourceFile(fileName) !.getFullText(), config);
+    });
+
+    return linter;
+  }
+
+  function writeFile(fileName: string, content: string) {
+    writeFileSync(join(tmpDir, fileName), content);
+  }
+
+  function getFile(fileName: string) { return readFileSync(join(tmpDir, fileName), 'utf8'); }
+
+  it('should flag undecorated classes with decorated fields', () => {
+    writeFile('/index.ts', `
+      import { Input, Directive } from '@angular/core';
+
+      @Directive()
+      export class ValidClass {
+        @Input() isActive: boolean;
+      }
+
+      export class InvalidClass {
+        @Input() isActive: boolean;
+      }
+    `);
+
+    const linter = runTSLint(false);
+    const failures = linter.getResult().failures.map(failure => failure.getFailure());
+
+    expect(failures.length).toBe(1);
+    expect(failures[0])
+        .toBe('Classes with decorated fields must have an Angular decorator as well.');
+  });
+
+  it(`should add an import for Directive if there isn't one already`, () => {
+    writeFile('/index.ts', `
+      import { Input } from '@angular/core';
+
+      export class Base {
+        @Input() isActive: boolean;
+      }
+    `);
+
+    runTSLint(true);
+    expect(getFile('/index.ts')).toContain(`import { Input, Directive } from '@angular/core';`);
+  });
+
+  it('should not change the imports if there is an import for Directive already', () => {
+    writeFile('/index.ts', `
+      import { Directive, Input } from '@angular/core';
+
+      export class Base {
+        @Input() isActive: boolean;
+      }
+
+      @Directive()
+      export class Child extends Base {
+      }
+    `);
+
+    runTSLint(true);
+    expect(getFile('/index.ts')).toContain(`import { Directive, Input } from '@angular/core';`);
+  });
+
+  it('should add @Directive to undecorated classes that have @Input', () => {
+    writeFile('/index.ts', `
+      import { Input } from '@angular/core';
+
+      export class Base {
+        @Input() isActive: boolean;
+      }
+    `);
+
+    runTSLint(true);
+    expect(getFile('/index.ts')).toContain(`@Directive()\nexport class Base {`);
+  });
+
+  it('should not change decorated classes', () => {
+    writeFile('/index.ts', `
+      import { Input, Component, Output, EventEmitter } from '@angular/core';
+
+      @Component({})
+      export class Base {
+        @Input() isActive: boolean;
+      }
+
+      export class Child extends Base {
+        @Output() clicked = new EventEmitter<void>();
+      }
+    `);
+
+    runTSLint(true);
+    const content = getFile('/index.ts');
+    expect(content).toContain(
+        `import { Input, Component, Output, EventEmitter, Directive } from '@angular/core';`);
+    expect(content).toContain(`@Component({})\n      export class Base {`);
+    expect(content).toContain(`@Directive()\nexport class Child extends Base {`);
+  });
+
+  it('should add @Directive to undecorated classes that have @Output', () => {
+    writeFile('/index.ts', `
+      import { Output, EventEmitter } from '@angular/core';
+
+      export class Base {
+        @Output() clicked = new EventEmitter<void>();
+      }
+    `);
+
+    runTSLint(true);
+    expect(getFile('/index.ts')).toContain(`@Directive()\nexport class Base {`);
+  });
+
+  it('should add @Directive to undecorated classes that have a host binding', () => {
+    writeFile('/index.ts', `
+      import { HostBinding } from '@angular/core';
+
+      export class Base {
+        @HostBinding('attr.id')
+        get id() {
+          return 'id-' + Date.now();
+        }
+      }
+    `);
+
+    runTSLint(true);
+    expect(getFile('/index.ts')).toContain(`@Directive()\nexport class Base {`);
+  });
+
+  it('should add @Directive to undecorated classes that have a host listener', () => {
+    writeFile('/index.ts', `
+      import { HostListener } from '@angular/core';
+
+      export class Base {
+        @HostListener('keydown')
+        handleKeydown() {
+          console.log('Key has been pressed');
+        }
+      }
+    `);
+
+    runTSLint(true);
+    expect(getFile('/index.ts')).toContain(`@Directive()\nexport class Base {`);
+  });
+
+  it('should add @Directive to undecorated classes that have a ViewChild query', () => {
+    writeFile('/index.ts', `
+      import { ViewChild, ElementRef } from '@angular/core';
+
+      export class Base {
+        @ViewChild('button', { static: false }) button: ElementRef<HTMLElement>;
+      }
+    `);
+
+    runTSLint(true);
+    expect(getFile('/index.ts')).toContain(`@Directive()\nexport class Base {`);
+  });
+
+  it('should add @Directive to undecorated classes that have a ViewChildren query', () => {
+    writeFile('/index.ts', `
+      import { ViewChildren, ElementRef } from '@angular/core';
+
+      export class Base {
+        @ViewChildren('button') button: ElementRef<HTMLElement>;
+      }
+    `);
+
+    runTSLint(true);
+    expect(getFile('/index.ts')).toContain(`@Directive()\nexport class Base {`);
+  });
+
+  it('should add @Directive to undecorated classes that have a ContentChild query', () => {
+    writeFile('/index.ts', `
+      import { ContentChild, ElementRef } from '@angular/core';
+
+      export class Base {
+        @ContentChild('button', { static: false }) button: ElementRef<HTMLElement>;
+      }
+    `);
+
+    runTSLint(true);
+    expect(getFile('/index.ts')).toContain(`@Directive()\nexport class Base {`);
+  });
+
+  it('should add @Directive to undecorated classes that have a ContentChildren query', () => {
+    writeFile('/index.ts', `
+      import { ContentChildren, ElementRef } from '@angular/core';
+
+      export class Base {
+        @ContentChildren('button') button: ElementRef<HTMLElement>;
+      }
+    `);
+
+    runTSLint(true);
+    expect(getFile('/index.ts')).toContain(`@Directive()\nexport class Base {`);
+  });
+
+});

packages/core/schematics/test/undecorated_classes_with_decorated_fields_migration_spec.ts

@@ -0,0 +1,218 @@
+/**
+ * @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 {getSystemPath, normalize, virtualFs} from '@angular-devkit/core';
+import {TempScopedNodeJsSyncHost} from '@angular-devkit/core/node/testing';
+import {HostTree} from '@angular-devkit/schematics';
+import {SchematicTestRunner, UnitTestTree} from '@angular-devkit/schematics/testing';
+import * as shx from 'shelljs';
+
+describe('Undecorated classes with decorated fields migration', () => {
+  let runner: SchematicTestRunner;
+  let host: TempScopedNodeJsSyncHost;
+  let tree: UnitTestTree;
+  let tmpDirPath: string;
+  let previousWorkingDir: string;
+
+  beforeEach(() => {
+    runner = new SchematicTestRunner('test', require.resolve('../migrations.json'));
+    host = new TempScopedNodeJsSyncHost();
+    tree = new UnitTestTree(new HostTree(host));
+
+    writeFile('/tsconfig.json', JSON.stringify({compilerOptions: {lib: ['es2015']}}));
+    writeFile('/angular.json', JSON.stringify({
+      projects: {t: {architect: {build: {options: {tsConfig: './tsconfig.json'}}}}}
+    }));
+
+    previousWorkingDir = shx.pwd();
+    tmpDirPath = getSystemPath(host.root);
+
+    // Switch into the temporary directory path. This allows us to run
+    // the schematic against our custom unit test tree.
+    shx.cd(tmpDirPath);
+  });
+
+  afterEach(() => {
+    shx.cd(previousWorkingDir);
+    shx.rm('-r', tmpDirPath);
+  });
+
+  it(`should add an import for Directive if there isn't one already`, async() => {
+    writeFile('/index.ts', `
+      import { Input } from '@angular/core';
+
+      export class Base {
+        @Input() isActive: boolean;
+      }
+    `);
+
+    await runMigration();
+    expect(tree.readContent('/index.ts'))
+        .toContain(`import { Input, Directive } from '@angular/core';`);
+  });
+
+  it('should not change the imports if there is an import for Directive already', async() => {
+    writeFile('/index.ts', `
+      import { Directive, Input } from '@angular/core';
+
+      export class Base {
+        @Input() isActive: boolean;
+      }
+
+      @Directive()
+      export class Child extends Base {
+      }
+    `);
+
+    await runMigration();
+    expect(tree.readContent('/index.ts'))
+        .toContain(`import { Directive, Input } from '@angular/core';`);
+  });
+
+  it('should add @Directive to undecorated classes that have @Input', async() => {
+    writeFile('/index.ts', `
+      import { Input } from '@angular/core';
+
+      export class Base {
+        @Input() isActive: boolean;
+      }
+    `);
+
+    await runMigration();
+    expect(tree.readContent('/index.ts')).toContain(`@Directive()\nexport class Base {`);
+  });
+
+  it('should not change decorated classes', async() => {
+    writeFile('/index.ts', `
+      import { Input, Component, Output, EventEmitter } from '@angular/core';
+
+      @Component({})
+      export class Base {
+        @Input() isActive: boolean;
+      }
+
+      export class Child extends Base {
+        @Output() clicked = new EventEmitter<void>();
+      }
+    `);
+
+    await runMigration();
+    const content = tree.readContent('/index.ts');
+    expect(content).toContain(
+        `import { Input, Component, Output, EventEmitter, Directive } from '@angular/core';`);
+    expect(content).toContain(`@Component({})\n      export class Base {`);
+    expect(content).toContain(`@Directive()\nexport class Child extends Base {`);
+  });
+
+  it('should add @Directive to undecorated classes that have @Output', async() => {
+    writeFile('/index.ts', `
+      import { Output, EventEmitter } from '@angular/core';
+
+      export class Base {
+        @Output() clicked = new EventEmitter<void>();
+      }
+    `);
+
+    await runMigration();
+    expect(tree.readContent('/index.ts')).toContain(`@Directive()\nexport class Base {`);
+  });
+
+  it('should add @Directive to undecorated classes that have a host binding', async() => {
+    writeFile('/index.ts', `
+      import { HostBinding } from '@angular/core';
+
+      export class Base {
+        @HostBinding('attr.id')
+        get id() {
+          return 'id-' + Date.now();
+        }
+      }
+    `);
+
+    await runMigration();
+    expect(tree.readContent('/index.ts')).toContain(`@Directive()\nexport class Base {`);
+  });
+
+  it('should add @Directive to undecorated classes that have a host listener', async() => {
+    writeFile('/index.ts', `
+      import { HostListener } from '@angular/core';
+
+      export class Base {
+        @HostListener('keydown')
+        handleKeydown() {
+          console.log('Key has been pressed');
+        }
+      }
+    `);
+
+    await runMigration();
+    expect(tree.readContent('/index.ts')).toContain(`@Directive()\nexport class Base {`);
+  });
+
+  it('should add @Directive to undecorated classes that have a ViewChild query', async() => {
+    writeFile('/index.ts', `
+      import { ViewChild, ElementRef } from '@angular/core';
+
+      export class Base {
+        @ViewChild('button', { static: false }) button: ElementRef<HTMLElement>;
+      }
+    `);
+
+    await runMigration();
+    expect(tree.readContent('/index.ts')).toContain(`@Directive()\nexport class Base {`);
+  });
+
+  it('should add @Directive to undecorated classes that have a ViewChildren query', async() => {
+    writeFile('/index.ts', `
+      import { ViewChildren, ElementRef } from '@angular/core';
+
+      export class Base {
+        @ViewChildren('button') button: ElementRef<HTMLElement>;
+      }
+    `);
+
+    await runMigration();
+    expect(tree.readContent('/index.ts')).toContain(`@Directive()\nexport class Base {`);
+  });
+
+  it('should add @Directive to undecorated classes that have a ContentChild query', async() => {
+    writeFile('/index.ts', `
+      import { ContentChild, ElementRef } from '@angular/core';
+
+      export class Base {
+        @ContentChild('button', { static: false }) button: ElementRef<HTMLElement>;
+      }
+    `);
+
+    await runMigration();
+    expect(tree.readContent('/index.ts')).toContain(`@Directive()\nexport class Base {`);
+  });
+
+  it('should add @Directive to undecorated classes that have a ContentChildren query', async() => {
+    writeFile('/index.ts', `
+      import { ContentChildren, ElementRef } from '@angular/core';
+
+      export class Base {
+        @ContentChildren('button') button: ElementRef<HTMLElement>;
+      }
+    `);
+
+    await runMigration();
+    expect(tree.readContent('/index.ts')).toContain(`@Directive()\nexport class Base {`);
+  });
+
+  function writeFile(filePath: string, contents: string) {
+    host.sync.write(normalize(filePath), virtualFs.stringToFileBuffer(contents));
+  }
+
+  function runMigration() {
+    return runner
+        .runSchematicAsync('migration-v9-undecorated-classes-with-decorated-fields', {}, tree)
+        .toPromise();
+  }
+});