fix(ngcc): report a warning if ngcc tries to use a solution-style tsconfig #38003

petebacondarwin · 2020-07-10T15:45:08Z

In CLI v10 there was a move to use the new solution-style tsconfig
which became available in TS 3.9. The result of this is that the standard
tsconfig.json, which ngcc (and ngc and tsc) infer if not given a explicit
tsconfig file path no longer contains important information such as
"paths" mappings, which ngcc might need to correctly compute
dependencies.

This commit logs a warning in this case to inform the developer
that they might not have meant to load this tsconfig and offer
alternative options.

Fixes #36386

JoostK

Type in commit message: "a explicit" -> "an explicit"

packages/compiler-cli/ngcc/src/ngcc_options.ts

petebacondarwin · 2020-07-10T16:51:48Z

packages/compiler-cli/src/perform_compile.ts

@@ -112,6 +112,7 @@ export interface ParsedConfiguration {
  project: string;
  options: api.CompilerOptions;
  rootNames: string[];
+  projectReferences?: readonly ts.ProjectReference[]|undefined;


I couldn't come up with a cleaner way for ngcc to work out whether this tsconfig was solution-style. I didn't want to do the computation here and have a flag (like isSolutionStyleConfig).

But if ngc wanted to do something similar there might be value with moving the test from ngcc to here...

…onfig In CLI v10 there was a move to use the new solution-style tsconfig which became available in TS 3.9. The result of this is that the standard tsconfig.json no longer contains important information such as "paths" mappings, which ngcc might need to correctly compute dependencies. ngcc (and ngc and tsc) infer the path to tsconfig.json if not given an explicit tsconfig file-path. But now that means it infers the solution tsconfig rather than one that contains the useful information it used to get. This commit logs a warning in this case to inform the developer that they might not have meant to load this tsconfig and offer alternative options. Fixes angular#36386

…yle tsconfig

alxhub · 2020-07-10T18:57:39Z

Presubmit

alan-agius4

LGTM

…onfig (#38003) In CLI v10 there was a move to use the new solution-style tsconfig which became available in TS 3.9. The result of this is that the standard tsconfig.json no longer contains important information such as "paths" mappings, which ngcc might need to correctly compute dependencies. ngcc (and ngc and tsc) infer the path to tsconfig.json if not given an explicit tsconfig file-path. But now that means it infers the solution tsconfig rather than one that contains the useful information it used to get. This commit logs a warning in this case to inform the developer that they might not have meant to load this tsconfig and offer alternative options. Fixes #36386 PR Close #38003

rhysowen9 · 2020-07-20T09:33:11Z

I think it would be beneficial to update the Angular Ivy guide to explain which tsconfig file to specify.
The current docs explain that ngcc is beneficial, but as soon as I add it, I start getting this ⬆️ new warning.

petebacondarwin · 2020-07-20T11:38:43Z

@rhysowen9 - how are you running ngcc? What is the content of the warning that you get? It should be listing the paths to the possible tsconfigs that you can choose. It would be normal to run ngcc against the "app" config (possibly tsconfig.app.json) but exactly which file would depend upon your set up. If you are using Angular CLI then you should not need to run ngcc yourself, since it takes care of that (including passing the appropriate tsconfig path).

rhysowen9 · 2020-07-20T12:16:55Z

@petebacondarwin ,

I believe that ngcc was added to our package.json file when upgrading from Angular 8 to Angular 9 back in February (would have been done using ng update).

It is a postinstall script which specifies --properties es2015 browser module main --first-only --create-ivy-entry-points.

Now that we have upgraded to Angular 10, and updated to the latest patch, we are getting the warning introduced by this PR.

We've stripped --create-ivy-entry-points and set --tsconfig ./src/tsconfig.app.json which seems to be working fine, but I can't say I fully understand this side of Angular, so this is nothing more than a best guess as the docs don't seem to offer much clarity.

petebacondarwin · 2020-07-20T12:24:35Z

Please feel free to remove this postinstall hook, as long as you are using CLI for building your app.

maxisam · 2020-07-22T22:51:07Z

Please feel free to remove this postinstall hook, as long as you are using CLI for building your app.

Could you explain why we can remove that postinstall hook? It is still in the document

https://update.angular.io/#9.0:10.0l3

If you depend on many Angular libraries you may consider speeding up your build by invoking the ngcc (Angular Compatibility Compiler) in an npm postinstall script via small change to your package.json.

bhanna1693 · 2020-07-23T12:42:43Z

Please feel free to remove this postinstall hook, as long as you are using CLI for building your app.

I agree with @maxisam. The postinstall script is "recommended" in both the angular documentation and the angular update guides. Can we get clarification?

petebacondarwin · 2020-07-23T13:45:17Z

Currently our docs do not recommend running ngcc as a postinstall hook, except for a particular scenario related to Angular Universal: https://angular.io/guide/ivy#ivy-and-universalapp-shell.
I agree that we should fix the update site. I have already created an issue there for it: angular/angular-update-guide#76

bhanna1693 · 2020-07-23T15:36:06Z

@petebacondarwin ah you're right, I misread that page i guess. Thank you for the help!

petebacondarwin · 2020-07-23T15:39:57Z

No problem. Sorry for the confusion

angular-automatic-lock-bot · 2020-08-23T16:17:14Z

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.}

…onfig (angular#38003) In CLI v10 there was a move to use the new solution-style tsconfig which became available in TS 3.9. The result of this is that the standard tsconfig.json no longer contains important information such as "paths" mappings, which ngcc might need to correctly compute dependencies. ngcc (and ngc and tsc) infer the path to tsconfig.json if not given an explicit tsconfig file-path. But now that means it infers the solution tsconfig rather than one that contains the useful information it used to get. This commit logs a warning in this case to inform the developer that they might not have meant to load this tsconfig and offer alternative options. Fixes angular#36386 PR Close angular#38003

petebacondarwin added type: bug/fix action: review The PR is still awaiting reviews from at least one requested reviewer severity1: confusing target: patch This PR is targeted for the next patch release labels Jul 10, 2020

ngbot bot modified the milestone: needsTriage Jul 10, 2020

googlebot added the cla: yes label Jul 10, 2020

pullapprove bot requested a review from JoostK July 10, 2020 15:45

petebacondarwin force-pushed the ngcc-solution-style-tsconfig-handling branch from 0cd55d6 to bcbb39f Compare July 10, 2020 15:51

JoostK approved these changes Jul 10, 2020

View reviewed changes

packages/compiler-cli/ngcc/src/ngcc_options.ts Outdated Show resolved Hide resolved

packages/compiler-cli/ngcc/src/ngcc_options.ts Outdated Show resolved Hide resolved

packages/compiler-cli/ngcc/src/ngcc_options.ts Outdated Show resolved Hide resolved

JoostK added action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews and removed action: review The PR is still awaiting reviews from at least one requested reviewer labels Jul 10, 2020

petebacondarwin commented Jul 10, 2020

View reviewed changes

petebacondarwin added 2 commits July 10, 2020 18:43

fixup! fix(ngcc): report a warning if ngcc tries to use a solution-st…

98d03ff

…yle tsconfig

petebacondarwin force-pushed the ngcc-solution-style-tsconfig-handling branch from bcbb39f to 98d03ff Compare July 10, 2020 17:46

fixup! fix(ngcc): report a warning if ngcc tries to use a solution-st…

6670b17

…yle tsconfig

petebacondarwin force-pushed the ngcc-solution-style-tsconfig-handling branch from 9ba3331 to 6670b17 Compare July 10, 2020 17:51

petebacondarwin added action: merge The PR is ready for merge by the caretaker action: presubmit The PR is in need of a google3 presubmit and removed action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews labels Jul 10, 2020

alan-agius4 approved these changes Jul 10, 2020

View reviewed changes

atscott removed action: presubmit The PR is in need of a google3 presubmit cla: yes labels Jul 14, 2020

googlebot added the cla: yes label Jul 14, 2020

atscott closed this in b358495 Jul 14, 2020

petebacondarwin deleted the ngcc-solution-style-tsconfig-handling branch July 15, 2020 15:39

ahnpnl mentioned this pull request Jul 21, 2020

Tests fail when using TypeScript project references kulshekhar/ts-jest#1648

Open

angular-automatic-lock-bot bot locked and limited conversation to collaborators Aug 23, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(ngcc): report a warning if ngcc tries to use a solution-style tsconfig #38003

fix(ngcc): report a warning if ngcc tries to use a solution-style tsconfig #38003

petebacondarwin commented Jul 10, 2020

JoostK left a comment

petebacondarwin Jul 10, 2020

alxhub commented Jul 10, 2020

alan-agius4 left a comment

rhysowen9 commented Jul 20, 2020

petebacondarwin commented Jul 20, 2020

rhysowen9 commented Jul 20, 2020 •

edited

petebacondarwin commented Jul 20, 2020

maxisam commented Jul 22, 2020

bhanna1693 commented Jul 23, 2020

petebacondarwin commented Jul 23, 2020

bhanna1693 commented Jul 23, 2020

petebacondarwin commented Jul 23, 2020

angular-automatic-lock-bot bot commented Aug 23, 2020

fix(ngcc): report a warning if ngcc tries to use a solution-style tsconfig #38003

fix(ngcc): report a warning if ngcc tries to use a solution-style tsconfig #38003

Conversation

petebacondarwin commented Jul 10, 2020

JoostK left a comment

Choose a reason for hiding this comment

petebacondarwin Jul 10, 2020

Choose a reason for hiding this comment

alxhub commented Jul 10, 2020

alan-agius4 left a comment

Choose a reason for hiding this comment

rhysowen9 commented Jul 20, 2020

petebacondarwin commented Jul 20, 2020

rhysowen9 commented Jul 20, 2020 • edited

petebacondarwin commented Jul 20, 2020

maxisam commented Jul 22, 2020

bhanna1693 commented Jul 23, 2020

petebacondarwin commented Jul 23, 2020

bhanna1693 commented Jul 23, 2020

petebacondarwin commented Jul 23, 2020

angular-automatic-lock-bot bot commented Aug 23, 2020

rhysowen9 commented Jul 20, 2020 •

edited