Keep track of why files are in the program #40011

sheetalkamat · 2020-08-12T00:22:28Z

Instead of keeping reference file reasons tracking, we also keep track of all reasons file is included in the program.
The configFileSpecs are stored on tsconfigFile so we dont have to pass them around any more.
The reasons are used to write explanations for files when new option --explainFiles is specified and program can use it too (earlier program wasnt aware of these)
They are also used to report errors about the file eg its not in rootDir or doesn't match casing etc
Because it is used to report errors while file processing is going on and program is still under construction, we store the metadata for errors instead of converting them in diagnostic right away. This is so we can reuse this data when program is completely reused and still give error locations at correct position.(Because the related information location can change without change but the diagnostic can be in different file)

Fixes #33515

…eline

…ut related file information is reattached to correct location

…and related information location changes

sheetalkamat · 2020-12-03T00:41:42Z

@typescript-bot pack this

typescript-bot · 2020-12-03T00:41:47Z

Heya @sheetalkamat, I've started to run the tarball bundle task on this PR at 3a4613e. You can monitor the build here.

sheetalkamat · 2020-12-03T19:53:46Z

@typescript-bot pack this

typescript-bot · 2020-12-03T19:53:50Z

Heya @sheetalkamat, I've started to run the tarball bundle task on this PR at 87ca884. You can monitor the build here.

typescript-bot · 2020-12-03T20:12:04Z

Hey @sheetalkamat, I've packed this into an installable tgz. You can install it for testing by referencing it in your package.json like so:

{
    "devDependencies": {
        "typescript": "https://typescript.visualstudio.com/cf7ac146-d525-443c-b23c-0d58337efebc/_apis/build/builds/90322/artifacts?artifactName=tgz&fileId=41E4437F40EC197DEB7906352B4A844350F4EE385720380498BA5240C44E9B9602&fileName=/typescript-4.2.0-insiders.20201203.tgz"
    }
}

and then running npm install.

There is also a playground for this build.

RyanCavanaugh · 2020-12-03T21:23:37Z

Trying on a local build just to see how it feels

D:\github\TypeScript\src\services>tsc --explainFiles
C:/Users/Ryan/AppData/Roaming/npm/node_modules/typescript/lib/lib.es5.d.ts
  Library 'lib.es5.d.ts' specified in compilerOptions
C:/Users/Ryan/AppData/Roaming/npm/node_modules/typescript/lib/lib.es2015.generator.d.ts
  Library 'lib.es2015.generator.d.ts' specified in compilerOptions
C:/Users/Ryan/AppData/Roaming/npm/node_modules/typescript/lib/lib.es2015.iterable.d.ts
  Library 'lib.es2015.iterable.d.ts' specified in compilerOptions
  Library referenced via 'es2015.iterable' from file 'C:/Users/Ryan/AppData/Roaming/npm/node_modules/typescript/lib/lib.es2015.generator.d.ts'
C:/Users/Ryan/AppData/Roaming/npm/node_modules/typescript/lib/lib.es2015.symbol.d.ts
  Library referenced via 'es2015.symbol' from file 'C:/Users/Ryan/AppData/Roaming/npm/node_modules/typescript/lib/lib.es2015.iterable.d.ts'
../../built/local/shims.d.ts
  Output from referenced project '../shims/tsconfig.json' included because '--outFile' specified
../../node_modules/@types/microsoft__typescript-etw/index.d.ts
  Imported via "@microsoft/typescript-etw" from file '../../built/local/compiler.d.ts' with packageId '@types/microsoft__typescript-etw/[email protected]'
../../built/local/compiler.d.ts
  Output from referenced project '../compiler/tsconfig.json' included because '--outFile' specified
../../built/local/jsTyping.d.ts
  Output from referenced project '../jsTyping/tsconfig.json' included because '--outFile' specified
types.ts
  Part of 'files' list in tsconfig.json
utilities.ts
  Part of 'files' list in tsconfig.json
classifier.ts
  Part of 'files' list in tsconfig.json
stringCompletions.ts
  Part of 'files' list in tsconfig.json
completions.ts
  Part of 'files' list in tsconfig.json
documentHighlights.ts
  Part of 'files' list in tsconfig.json
documentRegistry.ts
  Part of 'files' list in tsconfig.json
importTracker.ts
  Part of 'files' list in tsconfig.json
findAllReferences.ts
  Part of 'files' list in tsconfig.json
callHierarchy.ts
  Part of 'files' list in tsconfig.json
getEditsForFileRename.ts
  Part of 'files' list in tsconfig.json
goToDefinition.ts
  Part of 'files' list in tsconfig.json
jsDoc.ts
  Part of 'files' list in tsconfig.json
navigateTo.ts
  Part of 'files' list in tsconfig.json
(many more, truncated)

DanielRosenwasser · 2020-12-04T21:24:17Z

I like the idea, I would prefer different output. Maybe one line per file for easier regex/grepping?

fileName.ts: Explanation goes here.

RyanCavanaugh · 2020-12-04T21:26:52Z

I would prefer different output.

Files can have multiple reasons for being in the program - how do you think that should be handled as a single-line format?

DanielRosenwasser · 2020-12-04T21:28:57Z

Huh, didn't catch that from the example 😅- I would say to repeat the file name on both lines. Would that be reasonable?

sheetalkamat · 2020-12-04T23:21:56Z

Ready for review.
Quick question @DanielRosenwasser: do you want me to rename the flag to explainInputFiles ?

thetutlage · 2021-02-24T11:17:24Z

I see that the configFileSpecs has been removed from the output of getParsedCommandLineOfConfigFile. What's is alternative to get access to it?

sheetalkamat · 2021-02-24T17:50:26Z

The configFileSpecs are stored on tsconfigFile so we dont have to pass them around any more.

thetutlage · 2021-02-24T18:13:59Z

I read that, but looking for the ways to access them. Is there is any new API for the same?

sheetalkamat · 2021-02-24T18:51:40Z

It was always internal (meaning subject to change). We do not plan to expose that through API.

sheetalkamat added 9 commits Aug 10, 2020

--explainFiles currently hardcoded

462d1c2

Move configFileSpecs to configFile so it can be used in program later

69c404e

Explain root file inclusion reason and explain include files in the log

8cc74e1

Baseline explainFiles

ada028d

Fix incorrectly reporting of file list two times in --b mode

b2f8929

Fix unnecessary new lines in output represented incorretly in the bas…

beac081

…eline

More tests

5761f24

More cleaning up

ab73d96

Keep listing files in same order as list files, just add explaination

Loading status checks…

52f9df4

typescript-bot assigned sheetalkamat Aug 12, 2020

typescript-bot added Author: Team For Uncommitted Bug labels Aug 12, 2020

Merge branch 'master' into explainFiles

Loading status checks…

5287168

sheetalkamat mentioned this pull request Sep 24, 2020

Fix unnecessary new lines in output represented incorrectly in the baselines #40751

Merged

sheetalkamat added 15 commits Sep 24, 2020

Merge branch 'master' into explainFiles

Loading status checks…

aaee0c2

Fix double listing of file names when the program has errors

Loading status checks…

afc5293

Make diagnostic chains for file include reason

c25b0ba

Add explaination for the file include to diagnostics for program

0ecf2ea

Harness ls incorrectly adding tsconfig as the root file

f5566d4

Fix incorrect use of path for calculating absolute path

cc40fd8

Merge branch 'master' into explainFiles

Loading status checks…

f90f7b7

Fix the root file in fourslash

7ab1483

Test project service options merge

f78adcf

Add config file name to matched by include explaination

6f0f075

Add test for when the file changes and program is reused completely b…

237809f

…ut related file information is reattached to correct location

Handle file preprocessing diagnostics updates when program is reused …

Loading status checks…

69fd49c

…and related information location changes

Moved types to types.ts

Loading status checks…

d79c94c

Refactoring and cleanup

Loading status checks…

5c5a528

More cleanup

652dbd3

sheetalkamat force-pushed the explainFiles branch from 831475a to 300c727 Sep 30, 2020

Merge branch 'master' into explainFiles

Loading status checks…

3a4613e

Merge branch 'master' into explainFiles

Loading status checks…

87ca884

RyanCavanaugh mentioned this pull request Dec 3, 2020

Error "Cannot write file ... because it would overwrite input file." #27436

Closed

DanielRosenwasser mentioned this pull request Dec 4, 2020

Design Meeting Notes, 12/4/2020 #41824

Open

Merge branch 'master' into explainFiles

Loading status checks…

de22f1e

sheetalkamat requested review from weswigham and andrewbranch Dec 4, 2020

sheetalkamat added 3 commits Dec 4, 2020

Merge branch 'master' into explainFiles

Loading status checks…

975b07d

Baselines after merge

Loading status checks…

0c00d40

Merge branch 'master' into explainFiles

Loading status checks…

91be6e4

RyanCavanaugh approved these changes Dec 8, 2020

View changes

PR Backlog automation moved this from Needs review to Needs merge Dec 8, 2020

PR Backlog automation moved this from Needs merge to Done Dec 9, 2020

sheetalkamat deleted the explainFiles branch Dec 9, 2020

Feb	MAR	Apr
	10
2020	2021	2022

microsoft / TypeScript

Keep track of why files are in the program #40011

Keep track of why files are in the program #40011

sheetalkamat commented Aug 12, 2020 •

edited

sheetalkamat commented Dec 3, 2020

typescript-bot commented Dec 3, 2020 •

edited

sheetalkamat commented Dec 3, 2020

typescript-bot commented Dec 3, 2020 •

edited

typescript-bot commented Dec 3, 2020 •

edited

RyanCavanaugh commented Dec 3, 2020

DanielRosenwasser commented Dec 4, 2020 •

edited

RyanCavanaugh commented Dec 4, 2020

DanielRosenwasser commented Dec 4, 2020 •

edited

sheetalkamat commented Dec 4, 2020

thetutlage commented Feb 24, 2021

sheetalkamat commented Feb 24, 2021

thetutlage commented Feb 24, 2021

sheetalkamat commented Feb 24, 2021

microsoft / TypeScript

Keep track of why files are in the program #40011

Keep track of why files are in the program #40011

Conversation

sheetalkamat commented Aug 12, 2020 • edited

sheetalkamat commented Dec 3, 2020

typescript-bot commented Dec 3, 2020 • edited

sheetalkamat commented Dec 3, 2020

typescript-bot commented Dec 3, 2020 • edited

typescript-bot commented Dec 3, 2020 • edited

RyanCavanaugh commented Dec 3, 2020

DanielRosenwasser commented Dec 4, 2020 • edited

RyanCavanaugh commented Dec 4, 2020

DanielRosenwasser commented Dec 4, 2020 • edited

sheetalkamat commented Dec 4, 2020

thetutlage commented Feb 24, 2021

sheetalkamat commented Feb 24, 2021

thetutlage commented Feb 24, 2021

sheetalkamat commented Feb 24, 2021

sheetalkamat commented Aug 12, 2020 •

edited

typescript-bot commented Dec 3, 2020 •

edited

typescript-bot commented Dec 3, 2020 •

edited

typescript-bot commented Dec 3, 2020 •

edited

DanielRosenwasser commented Dec 4, 2020 •

edited

DanielRosenwasser commented Dec 4, 2020 •

edited