X Tutup

The Wayback Machine - https://web.archive.org/web/20220305043048/https://github.com/angular/angular/pull/42984

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Extended template checks #42984

Closed

danieltre23 wants to merge 8 commits into angular:master from danieltre23:template-checks

Contributor

danieltre23 commented Jul 28, 2021 •

edited

PR Checklist

Please check if your PR fulfills the following requirements:

The commit message follows our guidelines: https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit
Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

Bugfix
Feature
Code style update (formatting, local variables)
Refactoring (no functional changes, no api changes)
Build related changes
CI related changes
Documentation content changes
angular.io application / infrastructure changes
Other... Please describe:

What is the current behavior?

The compiler currently doesn't really generates warning.

Issue Number: #42966

What is the new behavior?

This PR introduces the extended package which should be able to generate diagnostics after type checking (integration with the compiler should come in a future PR). The API provides an interface for TemplateChecks to be authored, the package also has a function to generate the extended template diagnostics. The banana in a box check, that validates the two-way binding syntax is implemented with it's unit test.

The extended package is private, the only modification to the public API is the new BANANA_IN_BOX ErrorCode.

Does this PR introduce a breaking change?

Yes
No

Other information

danieltre23 added the target: patch label

danieltre23 requested review from atscott, alxhub and dgp1130

google-cla bot added the cla: yes label

danieltre23 force-pushed the template-checks branch 2 times, most recently from 1db63b9 to 915515b

atscott requested changes

View changes

packages/compiler-cli/src/ngtsc/extended_template_diagnostics/api/api.ts Outdated Show resolved Hide resolved

packages/compiler-cli/src/ngtsc/extended_template_diagnostics/api/api.ts Outdated Show resolved Hide resolved

packages/compiler-cli/src/ngtsc/extended_template_diagnostics/src/template_checker.ts Outdated Show resolved Hide resolved

packages/compiler-cli/src/ngtsc/extended_template_diagnostics/src/template_checker.ts Outdated Show resolved Hide resolved

packages/compiler-cli/src/ngtsc/typecheck/test/BUILD.bazel Show resolved Hide resolved

...piler-cli/src/ngtsc/extended_template_diagnostics/src/template_checks/banana_in_box_check.ts Outdated Show resolved Hide resolved

...piler-cli/src/ngtsc/extended_template_diagnostics/src/template_checks/banana_in_box_check.ts Outdated Show resolved Hide resolved

...piler-cli/src/ngtsc/extended_template_diagnostics/src/template_checks/banana_in_box_check.ts Outdated Show resolved Hide resolved

...piler-cli/src/ngtsc/extended_template_diagnostics/src/template_checks/banana_in_box_check.ts Outdated Show resolved Hide resolved

packages/compiler-cli/src/ngtsc/extended_template_diagnostics/test/template_checks_spec.ts Outdated Show resolved Hide resolved

dylhunn added the comp: compiler label

ngbot bot added this to the Backlog milestone

danieltre23 force-pushed the template-checks branch from 915515b to fd11c3d

dgp1130 requested changes

View changes

Contributor

dgp1130 left a comment

Great work on an initial proposal here, looking really good!

Mostly just a bunch of nitpicks, a few stylistic comments, and a couple questions about edge cases. Nothing too concerning with this PR, hope we can land it soon!

packages/compiler-cli/src/ngtsc/extended_template_diagnostics/BUILD.bazel Outdated Show resolved Hide resolved

packages/compiler-cli/src/ngtsc/extended_template_diagnostics/src/template_checker.ts Outdated Show resolved Hide resolved

packages/compiler-cli/src/ngtsc/extended_template_diagnostics/src/template_checker.ts Outdated Show resolved Hide resolved

packages/compiler-cli/src/ngtsc/extended_template_diagnostics/src/template_checker.ts Outdated Show resolved Hide resolved

packages/compiler-cli/src/ngtsc/extended_template_diagnostics/src/template_checker.ts Outdated Show resolved Hide resolved

...piler-cli/src/ngtsc/extended_template_diagnostics/src/template_checks/banana_in_box_check.ts Outdated Show resolved Hide resolved

...piler-cli/src/ngtsc/extended_template_diagnostics/src/template_checks/banana_in_box_check.ts Outdated Show resolved Hide resolved

...piler-cli/src/ngtsc/extended_template_diagnostics/src/template_checks/banana_in_box_check.ts Outdated Show resolved Hide resolved

packages/compiler-cli/src/ngtsc/extended_template_diagnostics/test/template_checks_spec.ts Outdated Show resolved Hide resolved

packages/compiler-cli/src/ngtsc/extended_template_diagnostics/test/template_checks_spec.ts Outdated Show resolved Hide resolved

dgp1130 reviewed

View changes

packages/compiler-cli/src/ngtsc/extended_template_diagnostics/api/api.ts Outdated Show resolved Hide resolved

danieltre23 force-pushed the template-checks branch 2 times, most recently from 737eb07 to 9da58bc

alxhub previously requested changes

View changes

packages/compiler-cli/src/ngtsc/extended_template_diagnostics/BUILD.bazel Outdated Show resolved Hide resolved

packages/compiler-cli/src/ngtsc/extended_template_diagnostics/src/template_checker.ts Outdated Show resolved Hide resolved

packages/compiler-cli/src/ngtsc/extended_template_diagnostics/api/api.ts Outdated Show resolved Hide resolved

packages/compiler-cli/src/ngtsc/extended_template_diagnostics/src/template_checker.ts Outdated Show resolved Hide resolved

packages/compiler-cli/src/ngtsc/typecheck/test/diagnostics_spec.ts Outdated Show resolved Hide resolved

dgp1130 reviewed

View changes

...piler-cli/src/ngtsc/extended_template_diagnostics/src/template_checks/banana_in_box_check.ts Outdated Show resolved Hide resolved

dgp1130 reviewed

View changes

...piler-cli/src/ngtsc/extended_template_diagnostics/src/template_checks/banana_in_box_check.ts Outdated Show resolved Hide resolved

danieltre23 force-pushed the template-checks branch 2 times, most recently from df24977 to e12f69e

danieltre23 requested review from atscott, dgp1130 and alxhub

danieltre23 force-pushed the template-checks branch from e12f69e to 151c5f9

atscott approved these changes

View changes

danieltre23 force-pushed the template-checks branch from 151c5f9 to c5a6f9c

dgp1130 reviewed

View changes

packages/compiler-cli/src/ngtsc/typecheck/extended/src/template_checker.ts Outdated Show resolved Hide resolved

packages/compiler-cli/src/ngtsc/typecheck/extended/src/template_checker.ts Outdated Show resolved Hide resolved

packages/compiler-cli/src/ngtsc/typecheck/testing/index.ts Outdated Show resolved Hide resolved

packages/compiler-cli/src/ngtsc/testing/src/utils.ts Outdated Show resolved Hide resolved

packages/compiler/src/render3/r3_ast.ts

  
          @@ -203,11 +203,15 @@ export class NullVisitor implements Visitor<void> {
        
            export class RecursiveVisitor implements Visitor<void> {

              visitElement(element: Element): void {

                visitAll(this, element.attributes);

                visitAll(this, element.inputs);

                visitAll(this, element.outputs);

Contributor

dgp1130 Aug 4, 2021

Thanks for making this fix and for keeping it in a separate commit, much easier to understand the context this way!

danieltre23 force-pushed the template-checks branch from c5a6f9c to 2d27ea3

dgp1130 approved these changes

View changes

packages/compiler-cli/src/ngtsc/typecheck/extended/src/template_checks/banana_in_box/spec.ts Outdated Show resolved Hide resolved

danieltre23 force-pushed the template-checks branch from 2d27ea3 to 9da79f4

AndrewKushnir added a commit that referenced this issue


          refactor(compiler-cli): add test for BananaInBoxCheck (#42984)

e25d35f

Create the test package for extended_template_diagnostics and add a unit
test for the `BananaInBoxCheck`.

Refs #42966

PR Close #42984

AndrewKushnir added a commit that referenced this issue


          refactor(compiler-cli): introduce extended package to typecheck with …

21e2b93

…it's API (#42984)

This commit introduces //packages/compiler-cli/src/ngtsc/typecheck/extended
as a container for a new phase of diagnostics generation. The API provides an
interface for new template checks to implement and generate template diagnostics.

Refs #42966

PR Close #42984

AndrewKushnir added a commit that referenced this issue


          refactor(compiler-cli): make makeTemplateDiagnostic wrapper error (#…

a53d268

…42984)

specific

This commit makes the wrapper function `makeTemplateDiagnostic` take an
ErrorCode as a type for the `ts.Diagnostic`s to be generated.

Refs #42966

PR Close #42984

AndrewKushnir added a commit that referenced this issue


          refactor(compiler-cli): introduce `getExtendedTemplateDiagnosticsForC…

029060f

…omponent` function (#42984)

Add function to get extended template diagnostics generated by all the template checks.

Refs #42966

PR Close #42984

AndrewKushnir added a commit that referenced this issue


          refactor(compiler-cli): move typecheck test utils into its own package (

387dcc6

#42984)

This commit moves the test utils used in the typechecking tests into its
own package. This makes them available to be used in the tests of a
different package.

Refs #42966

PR Close #42984

AndrewKushnir added a commit that referenced this issue


          refactor(compiler-cli): move getSourceCodeForDiagnostic to utils (#…

a3bc29b

…42984)

Export `getSourceCodeForDiagnostic` from `ngtsc/testing` to make it
available for other packages. This will help confirm that the source
code is correct in other tests.

Refs #42966

PR Close #42984

AndrewKushnir added a commit that referenced this issue


          refactor(compiler-cli): visit inputs and outputs for elements and tem…

c42b50c

…plates (#42984)

This commit adds to the exisiting `RecursiveVisitor` and visits inputs
and outputs for elements and templates.

Refs #42966

PR Close #42984

AndrewKushnir added a commit that referenced this issue


          refactor(compiler-cli): add BananaInBoxCheck to the template checks (…

0f8ae8b

…#42984)

Add the implementation of a Template Check that ensures the correct
use of two-way binding syntax. Generates a warning when
'([foo])="bar"' is found instead of '[(foo)]="bar"'.

Refs #42966

PR Close #42984

AndrewKushnir added a commit that referenced this issue


          refactor(compiler-cli): add test for BananaInBoxCheck (#42984)

4a1d9a7

Create the test package for extended_template_diagnostics and add a unit
test for the `BananaInBoxCheck`.

Refs #42966

PR Close #42984

alxhub reviewed

View changes

packages/compiler-cli/src/ngtsc/typecheck/testing/index.ts Show resolved Hide resolved

...compiler-cli/src/ngtsc/typecheck/extended/src/template_checks/invalid_banana_in_box/index.ts Show resolved Hide resolved

...compiler-cli/src/ngtsc/typecheck/extended/src/template_checks/invalid_banana_in_box/index.ts Show resolved Hide resolved

...compiler-cli/src/ngtsc/typecheck/extended/src/template_checks/invalid_banana_in_box/index.ts Show resolved Hide resolved

packages/compiler-cli/src/ngtsc/typecheck/extended/api/api.ts Show resolved Hide resolved

packages/compiler-cli/src/ngtsc/typecheck/extended/api/api.ts Show resolved Hide resolved

...compiler-cli/src/ngtsc/typecheck/extended/src/template_checks/invalid_banana_in_box/index.ts Show resolved Hide resolved

danieltre23 mentioned this pull request

Extended language service #43134

Closed

14 tasks

rafaelss95 mentioned this pull request

banana-in-box can be deprecated once new Angular compiler checks are exposed publicly angular-eslint/angular-eslint#660

Open

TeriGlover added a commit to TeriGlover/angular that referenced this issue


          refactor(compiler-cli): introduce extended package to typecheck with …

d27a641

…it's API (angular#42984)

This commit introduces //packages/compiler-cli/src/ngtsc/typecheck/extended
as a container for a new phase of diagnostics generation. The API provides an
interface for new template checks to implement and generate template diagnostics.

Refs angular#42966

PR Close angular#42984

TeriGlover added a commit to TeriGlover/angular that referenced this issue


          refactor(compiler-cli): make makeTemplateDiagnostic wrapper error (a…

e11aa3e

…ngular#42984)

specific

This commit makes the wrapper function `makeTemplateDiagnostic` take an
ErrorCode as a type for the `ts.Diagnostic`s to be generated.

Refs angular#42966

PR Close angular#42984

TeriGlover added a commit to TeriGlover/angular that referenced this issue


          refactor(compiler-cli): introduce `getExtendedTemplateDiagnosticsForC…

147f96b

…omponent` function (angular#42984)

Add function to get extended template diagnostics generated by all the template checks.

Refs angular#42966

PR Close angular#42984

TeriGlover added a commit to TeriGlover/angular that referenced this issue


          refactor(compiler-cli): move typecheck test utils into its own package (

2f0653b

angular#42984)

This commit moves the test utils used in the typechecking tests into its
own package. This makes them available to be used in the tests of a
different package.

Refs angular#42966

PR Close angular#42984

TeriGlover added a commit to TeriGlover/angular that referenced this issue


          refactor(compiler-cli): move getSourceCodeForDiagnostic to utils (a…

7d3b521

…ngular#42984)

Export `getSourceCodeForDiagnostic` from `ngtsc/testing` to make it
available for other packages. This will help confirm that the source
code is correct in other tests.

Refs angular#42966

PR Close angular#42984

TeriGlover added a commit to TeriGlover/angular that referenced this issue


          refactor(compiler-cli): visit inputs and outputs for elements and tem…

987321b

…plates (angular#42984)

This commit adds to the exisiting `RecursiveVisitor` and visits inputs
and outputs for elements and templates.

Refs angular#42966

PR Close angular#42984

TeriGlover added a commit to TeriGlover/angular that referenced this issue


          refactor(compiler-cli): add BananaInBoxCheck to the template checks (…

1d2173f

…angular#42984)

Add the implementation of a Template Check that ensures the correct
use of two-way binding syntax. Generates a warning when
'([foo])="bar"' is found instead of '[(foo)]="bar"'.

Refs angular#42966

PR Close angular#42984

TeriGlover added a commit to TeriGlover/angular that referenced this issue


          refactor(compiler-cli): add test for BananaInBoxCheck (angular#42984)

3b88960

Create the test package for extended_template_diagnostics and add a unit
test for the `BananaInBoxCheck`.

Refs angular#42966

PR Close angular#42984

TeriGlover added a commit to TeriGlover/angular that referenced this issue


          refactor(compiler-cli): introduce extended package to typecheck with …

14e047f

…it's API (angular#42984)

This commit introduces //packages/compiler-cli/src/ngtsc/typecheck/extended
as a container for a new phase of diagnostics generation. The API provides an
interface for new template checks to implement and generate template diagnostics.

Refs angular#42966

PR Close angular#42984

TeriGlover added a commit to TeriGlover/angular that referenced this issue


          refactor(compiler-cli): make makeTemplateDiagnostic wrapper error (a…

fc6f33b

…ngular#42984)

specific

This commit makes the wrapper function `makeTemplateDiagnostic` take an
ErrorCode as a type for the `ts.Diagnostic`s to be generated.

Refs angular#42966

PR Close angular#42984

TeriGlover added a commit to TeriGlover/angular that referenced this issue


          refactor(compiler-cli): introduce `getExtendedTemplateDiagnosticsForC…

4f3e119

…omponent` function (angular#42984)

Add function to get extended template diagnostics generated by all the template checks.

Refs angular#42966

PR Close angular#42984

TeriGlover added a commit to TeriGlover/angular that referenced this issue


          refactor(compiler-cli): move typecheck test utils into its own package (

e53648f

angular#42984)

This commit moves the test utils used in the typechecking tests into its
own package. This makes them available to be used in the tests of a
different package.

Refs angular#42966

PR Close angular#42984

TeriGlover added a commit to TeriGlover/angular that referenced this issue


          refactor(compiler-cli): move getSourceCodeForDiagnostic to utils (a…

803b882

…ngular#42984)

Export `getSourceCodeForDiagnostic` from `ngtsc/testing` to make it
available for other packages. This will help confirm that the source
code is correct in other tests.

Refs angular#42966

PR Close angular#42984

TeriGlover added a commit to TeriGlover/angular that referenced this issue


          refactor(compiler-cli): visit inputs and outputs for elements and tem…

0398edc

…plates (angular#42984)

This commit adds to the exisiting `RecursiveVisitor` and visits inputs
and outputs for elements and templates.

Refs angular#42966

PR Close angular#42984

TeriGlover added a commit to TeriGlover/angular that referenced this issue


          refactor(compiler-cli): add BananaInBoxCheck to the template checks (…

…angular#42984)

Add the implementation of a Template Check that ensures the correct
use of two-way binding syntax. Generates a warning when
'([foo])="bar"' is found instead of '[(foo)]="bar"'.

Refs angular#42966

PR Close angular#42984

TeriGlover added a commit to TeriGlover/angular that referenced this issue


          refactor(compiler-cli): add test for BananaInBoxCheck (angular#42984)

a22ab54

Create the test package for extended_template_diagnostics and add a unit
test for the `BananaInBoxCheck`.

Refs angular#42966

PR Close angular#42984

angular-automatic-lock-bot bot commented Sep 26, 2021

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

_{This action has been performed automatically by a bot.}

angular-automatic-lock-bot bot locked and limited conversation to collaborators

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

X Tutup