samreid
commented
2 years ago This script takes about 24 seconds on my machine to find all direct usages (non-transitive) of Panel.ts exports:
```ts
const { Project } = require( 'ts-morph' );
const getRepoList = require( '../common/getRepoList' );
const project = new Project( {
tsConfigFilePath: 'chipper/tsconfig/all/tsconfig.json'
} );
const sourceFile = project.addSourceFileAtPath( 'sun/js/Panel.ts' );
const repos = getRepoList( 'active-repos' );
repos.forEach( repo => {
try {
project.addSourceFilesFromTsConfig( repo + '/tsconfig.json' );
}
catch( e ) {
console.log( 'skipping: ' + repo );
}
} );
// project.addSourceFileAtPath( 'area-builder/js/explore/view/BoardDisplayModePanel.js' );
for ( const [ name, declarations ] of sourceFile.getExportedDeclarations() ) {
console.log( `${name}: ${declarations.map( d => d.getText() ).join( '', '' )}` );
declarations.forEach( declaration => {
const referencedSymbols = declaration.findReferences();
for ( const referencedSymbol of referencedSymbols ) {
for ( const reference of referencedSymbol.getReferences() ) {
console.log( '---------' );
console.log( 'REFERENCE' );
console.log( '---------' );
console.log( 'File path: ' + reference.getSourceFile().getFilePath() );
console.log( 'Start: ' + reference.getTextSpan().getStart() );
console.log( 'Length: ' + reference.getTextSpan().getLength() );
console.log( 'Parent kind: ' + reference.getNode().getParentOrThrow().getKindName() );
console.log();
console.log();
}
}
} );
}
```
The question is whether that can be optimized and combined with a typescript command that only type checks a subset of files. I'm not sure whether that is compatible with project references. Also, do we need to trace transitive usages?
Also, this is pretty much what the tsc -b --watch is supposed to do. But we have reported false positives and false negatives using --watch recently.
zepumph
pixelzoom
jonathanolson
From https://github.com/phetsims/chipper/issues/1174
For instance, if you make a change to SUN/Panel, then the precommit hooks just check
tsc -binsun/, then the type won't check any sim usages of SUN/Panel. If an API was broken, the type checker wouldn't catch it.This may be the reason some type errors have passed the precommit type checks and got pushed to master.
There are a few levels for how we could address this:
tsc -bon the current repo, but this is unsafe since it doesn't type check usages.tsc -bon all for every precommit hook. However, that means that a change in sim 1 could prevent pushing to unrelated sim 2 which is undesirable. (Unless we are OK checking the type errors and seeing they are not related to sim 1 and turning off git hooks to push anyways).tsc -bon the downstream repos. This would be more complex since we would need to implement and maintain our own dependency graph.tsc -bonall. Changes to sim repos could just runtsc -bon the sim repo. We would need to make sure that sim common code repos like "circuit-construction-kit-common" are counted as common code repos. But we wouldn't want type checking circuit-construction-kit-common to check for errors in geometric optics, say.Based on these remarks, I'm thinking we should aim for (1) or (2).
@pixelzoom @jonathanolson or @zepumph what do you recommend?