Skip to content

Commit a37585e

Browse files
sheetalkamatsheetalkamat
committed
Ignore excluded directories from wild card watching
1 parent 1020ea2 commit a37585e

20 files changed

Lines changed: 2099 additions & 84 deletions

‎src/compiler/commandLineParser.ts‎

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2943,7 +2943,13 @@ namespace ts {
29432943
* @param extraFileExtensions optionaly file extra file extension information from host
29442944
*/
29452945
/* @internal */
2946-
export function getFileNamesFromConfigSpecs(spec: ConfigFileSpecs, basePath: string, options: CompilerOptions, host: ParseConfigHost, extraFileExtensions: readonly FileExtensionInfo[] = []): ExpandResult {
2946+
export function getFileNamesFromConfigSpecs(
2947+
spec: ConfigFileSpecs,
2948+
basePath: string,
2949+
options: CompilerOptions,
2950+
host: ParseConfigHost,
2951+
extraFileExtensions: readonly FileExtensionInfo[] = emptyArray
2952+
): ExpandResult {
29472953
basePath = normalizePath(basePath);
29482954

29492955
const keyMapper = createGetCanonicalFileName(host.useCaseSensitiveFileNames);
@@ -3030,6 +3036,33 @@ namespace ts {
30303036
};
30313037
}
30323038

3039+
/* @internal */
3040+
export function isExcludedFile(
3041+
pathToCheck: string,
3042+
spec: ConfigFileSpecs,
3043+
basePath: string,
3044+
useCaseSensitiveFileNames: boolean,
3045+
currentDirectory: string
3046+
): boolean {
3047+
const { filesSpecs, validatedIncludeSpecs, validatedExcludeSpecs } = spec;
3048+
if (!length(validatedIncludeSpecs) || !length(validatedExcludeSpecs)) return false;
3049+
3050+
basePath = normalizePath(basePath);
3051+
3052+
const keyMapper = createGetCanonicalFileName(useCaseSensitiveFileNames);
3053+
if (filesSpecs) {
3054+
for (const fileName of filesSpecs) {
3055+
if (keyMapper(getNormalizedAbsolutePath(fileName, basePath)) === pathToCheck) return false;
3056+
}
3057+
}
3058+
3059+
const excludePattern = getRegularExpressionForWildcard(validatedExcludeSpecs, combinePaths(normalizePath(currentDirectory), basePath), "exclude");
3060+
const excludeRegex = excludePattern && getRegexFromPattern(excludePattern, useCaseSensitiveFileNames);
3061+
if (!excludeRegex) return false;
3062+
if (excludeRegex.test(pathToCheck)) return true;
3063+
return !hasExtension(pathToCheck) && excludeRegex.test(ensureTrailingDirectorySeparator(pathToCheck));
3064+
}
3065+
30333066
function validateSpecs(specs: readonly string[], errors: Push<Diagnostic>, allowTrailingRecursion: boolean, jsonSourceFile: TsConfigSourceFile | undefined, specKey: string): readonly string[] {
30343067
return specs.filter(spec => {
30353068
const diag = specToDiagnostic(spec, allowTrailingRecursion);

‎src/compiler/tsbuildPublic.ts‎

Lines changed: 19 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -853,6 +853,9 @@ namespace ts {
853853
getConfigFileParsingDiagnostics(config),
854854
config.projectReferences
855855
);
856+
if (state.watch) {
857+
state.builderPrograms.set(projectPath, program);
858+
}
856859
step++;
857860
}
858861

@@ -982,7 +985,7 @@ namespace ts {
982985
if (emitResult.emittedFiles && state.writeFileName) {
983986
emitResult.emittedFiles.forEach(name => listEmittedFile(state, config, name));
984987
}
985-
afterProgramDone(state, projectPath, program, config);
988+
afterProgramDone(state, program, config);
986989
step = BuildStep.QueueReferencingProjects;
987990
return emitResult;
988991
}
@@ -1023,7 +1026,7 @@ namespace ts {
10231026
newestDeclarationFileContentChangedTime,
10241027
oldestOutputFileName
10251028
});
1026-
afterProgramDone(state, projectPath, program, config);
1029+
afterProgramDone(state, program, config);
10271030
step = BuildStep.QueueReferencingProjects;
10281031
buildResult = resultFlags;
10291032
return emitDiagnostics;
@@ -1269,7 +1272,6 @@ namespace ts {
12691272

12701273
function afterProgramDone<T extends BuilderProgram>(
12711274
state: SolutionBuilderState<T>,
1272-
proj: ResolvedConfigFilePath,
12731275
program: T | undefined,
12741276
config: ParsedCommandLine
12751277
) {
@@ -1278,10 +1280,7 @@ namespace ts {
12781280
if (state.host.afterProgramEmitAndDiagnostics) {
12791281
state.host.afterProgramEmitAndDiagnostics(program);
12801282
}
1281-
if (state.watch) {
1282-
program.releaseProgram();
1283-
state.builderPrograms.set(proj, program);
1284-
}
1283+
program.releaseProgram();
12851284
}
12861285
else if (state.host.afterEmitBundle) {
12871286
state.host.afterEmitBundle(config);
@@ -1304,7 +1303,7 @@ namespace ts {
13041303
// List files if any other build error using program (emit errors already report files)
13051304
state.projectStatus.set(resolvedPath, { type: UpToDateStatusType.Unbuildable, reason: `${errorType} errors` });
13061305
if (canEmitBuildInfo) return { buildResult, step: BuildStep.EmitBuildInfo };
1307-
afterProgramDone(state, resolvedPath, program, config);
1306+
afterProgramDone(state, program, config);
13081307
return { buildResult, step: BuildStep.QueueReferencingProjects };
13091308
}
13101309

@@ -1809,38 +1808,6 @@ namespace ts {
18091808
));
18101809
}
18111810

1812-
function isSameFile(state: SolutionBuilderState, file1: string, file2: string) {
1813-
return comparePaths(file1, file2, state.currentDirectory, !state.host.useCaseSensitiveFileNames()) === Comparison.EqualTo;
1814-
}
1815-
1816-
function isOutputFile(state: SolutionBuilderState, fileName: string, configFile: ParsedCommandLine) {
1817-
if (configFile.options.noEmit) return false;
1818-
1819-
// ts or tsx files are not output
1820-
if (!fileExtensionIs(fileName, Extension.Dts) &&
1821-
(fileExtensionIs(fileName, Extension.Ts) || fileExtensionIs(fileName, Extension.Tsx))) {
1822-
return false;
1823-
}
1824-
1825-
// If options have --outFile or --out, check if its that
1826-
const out = outFile(configFile.options);
1827-
if (out && (isSameFile(state, fileName, out) || isSameFile(state, fileName, removeFileExtension(out) + Extension.Dts))) {
1828-
return true;
1829-
}
1830-
1831-
// If declarationDir is specified, return if its a file in that directory
1832-
if (configFile.options.declarationDir && containsPath(configFile.options.declarationDir, fileName, state.currentDirectory, !state.host.useCaseSensitiveFileNames())) {
1833-
return true;
1834-
}
1835-
1836-
// If --outDir, check if file is in that directory
1837-
if (configFile.options.outDir && containsPath(configFile.options.outDir, fileName, state.currentDirectory, !state.host.useCaseSensitiveFileNames())) {
1838-
return true;
1839-
}
1840-
1841-
return !forEach(configFile.fileNames, inputFile => isSameFile(state, fileName, inputFile));
1842-
}
1843-
18441811
function watchWildCardDirectories(state: SolutionBuilderState, resolved: ResolvedConfigFileName, resolvedPath: ResolvedConfigFilePath, parsed: ParsedCommandLine) {
18451812
if (!state.watch) return;
18461813
updateWatchingWildcardDirectories(
@@ -1850,16 +1817,18 @@ namespace ts {
18501817
state.hostWithWatch,
18511818
dir,
18521819
fileOrDirectory => {
1853-
const fileOrDirectoryPath = toPath(state, fileOrDirectory);
1854-
if (fileOrDirectoryPath !== toPath(state, dir) && hasExtension(fileOrDirectoryPath) && !isSupportedSourceFileName(fileOrDirectory, parsed.options)) {
1855-
state.writeLog(`Project: ${resolved} Detected file add/remove of non supported extension: ${fileOrDirectory}`);
1856-
return;
1857-
}
1858-
1859-
if (isOutputFile(state, fileOrDirectory, parsed)) {
1860-
state.writeLog(`${fileOrDirectory} is output file`);
1861-
return;
1862-
}
1820+
if (isIgnoredFileFromWildCardWatching({
1821+
watchedDirPath: toPath(state, dir),
1822+
fileOrDirectory,
1823+
fileOrDirectoryPath: toPath(state, fileOrDirectory),
1824+
configFileName: resolved,
1825+
configFileSpecs: parsed.configFileSpecs!,
1826+
currentDirectory: state.currentDirectory,
1827+
options: parsed.options,
1828+
program: state.builderPrograms.get(resolvedPath),
1829+
useCaseSensitiveFileNames: state.parseConfigFileHost.useCaseSensitiveFileNames,
1830+
writeLog: s => state.writeLog(s)
1831+
})) return;
18631832

18641833
invalidateProjectAndScheduleBuilds(state, resolvedPath, ConfigFileProgramReloadLevel.Partial);
18651834
},

‎src/compiler/watchPublic.ts‎

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -734,23 +734,26 @@ namespace ts {
734734
fileOrDirectory => {
735735
Debug.assert(!!configFileName);
736736

737-
let fileOrDirectoryPath: Path | undefined = toPath(fileOrDirectory);
737+
const fileOrDirectoryPath = toPath(fileOrDirectory);
738738

739739
// Since the file existence changed, update the sourceFiles cache
740740
if (cachedDirectoryStructureHost) {
741741
cachedDirectoryStructureHost.addOrDeleteFileOrDirectory(fileOrDirectory, fileOrDirectoryPath);
742742
}
743743
nextSourceFileVersion(fileOrDirectoryPath);
744744

745-
fileOrDirectoryPath = removeIgnoredPath(fileOrDirectoryPath);
746-
if (!fileOrDirectoryPath) return;
747-
748-
// If the the added or created file or directory is not supported file name, ignore the file
749-
// But when watched directory is added/removed, we need to reload the file list
750-
if (fileOrDirectoryPath !== directory && hasExtension(fileOrDirectoryPath) && !isSupportedSourceFileName(fileOrDirectory, compilerOptions)) {
751-
writeLog(`Project: ${configFileName} Detected file add/remove of non supported extension: ${fileOrDirectory}`);
752-
return;
753-
}
745+
if (isIgnoredFileFromWildCardWatching({
746+
watchedDirPath: toPath(directory),
747+
fileOrDirectory,
748+
fileOrDirectoryPath,
749+
configFileName,
750+
configFileSpecs,
751+
options: compilerOptions,
752+
program: getCurrentBuilderProgram(),
753+
currentDirectory,
754+
useCaseSensitiveFileNames,
755+
writeLog
756+
})) return;
754757

755758
// Reload is pending, do the reload
756759
if (reloadLevel !== ConfigFileProgramReloadLevel.Full) {

‎src/compiler/watchUtilities.ts‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -329,6 +329,83 @@ namespace ts {
329329
}
330330
}
331331

332+
export interface IsIgnoredFileFromWildCardWatchingInput {
333+
watchedDirPath: Path;
334+
fileOrDirectory: string;
335+
fileOrDirectoryPath: Path;
336+
configFileName: string;
337+
options: CompilerOptions;
338+
configFileSpecs: ConfigFileSpecs;
339+
program: BuilderProgram | Program | undefined;
340+
extraFileExtensions?: readonly FileExtensionInfo[];
341+
currentDirectory: string;
342+
useCaseSensitiveFileNames: boolean;
343+
writeLog: (s: string) => void;
344+
}
345+
/* @internal */
346+
export function isIgnoredFileFromWildCardWatching({
347+
watchedDirPath, fileOrDirectory, fileOrDirectoryPath,
348+
configFileName, options, configFileSpecs, program, extraFileExtensions,
349+
currentDirectory, useCaseSensitiveFileNames,
350+
writeLog,
351+
}: IsIgnoredFileFromWildCardWatchingInput): boolean {
352+
const newPath = removeIgnoredPath(fileOrDirectoryPath);
353+
if (!newPath) {
354+
writeLog(`Project: ${configFileName} Detected ignored path: ${fileOrDirectory}`);
355+
return true;
356+
}
357+
358+
fileOrDirectoryPath = newPath;
359+
if (fileOrDirectoryPath === watchedDirPath) return false;
360+
361+
// If the the added or created file or directory is not supported file name, ignore the file
362+
// But when watched directory is added/removed, we need to reload the file list
363+
if (hasExtension(fileOrDirectoryPath) && !isSupportedSourceFileName(fileOrDirectory, options, extraFileExtensions)) {
364+
writeLog(`Project: ${configFileName} Detected file add/remove of non supported extension: ${fileOrDirectory}`);
365+
return true;
366+
}
367+
368+
if (isExcludedFile(fileOrDirectory, configFileSpecs, getNormalizedAbsolutePath(getDirectoryPath(configFileName), currentDirectory), useCaseSensitiveFileNames, currentDirectory)) {
369+
writeLog(`Project: ${configFileName} Detected excluded file: ${fileOrDirectory}`);
370+
return true;
371+
}
372+
373+
if (!program) return false;
374+
375+
// We want to ignore emit file check if file is not going to be emitted next to source file
376+
// In that case we follow config file inclusion rules
377+
if (options.outFile || options.outDir) return false;
378+
379+
// File if emitted next to input needs to be ignored
380+
if (fileExtensionIs(fileOrDirectoryPath, Extension.Dts)) {
381+
// If its declaration directory: its not ignored if not excluded by config
382+
if (options.declarationDir) return false;
383+
}
384+
else if (!fileExtensionIsOneOf(fileOrDirectoryPath, supportedJSExtensions)) {
385+
return false;
386+
}
387+
388+
// just check if sourceFile with the name exists
389+
const filePathWithoutExtension = removeFileExtension(fileOrDirectoryPath);
390+
const realProgram = isBuilderProgram(program) ? program.getProgramOrUndefined() : program;
391+
if (hasSourceFile((filePathWithoutExtension + Extension.Ts) as Path) ||
392+
hasSourceFile((filePathWithoutExtension + Extension.Tsx) as Path)) {
393+
writeLog(`Project: ${configFileName} Detected output file: ${fileOrDirectory}`);
394+
return true;
395+
}
396+
return false;
397+
398+
function hasSourceFile(file: Path) {
399+
return realProgram ?
400+
!!realProgram.getSourceFileByPath(file) :
401+
(program as BuilderProgram).getState().fileInfos.has(file);
402+
}
403+
}
404+
405+
function isBuilderProgram<T extends BuilderProgram>(program: Program | T): program is T {
406+
return !!(program as T).getState;
407+
}
408+
332409
export function isEmittedFileOfProgram(program: Program | undefined, file: string) {
333410
if (!program) {
334411
return false;

‎src/server/editorServices.ts‎

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1160,8 +1160,29 @@ namespace ts.server {
11601160
this.host,
11611161
directory,
11621162
fileOrDirectory => {
1163-
let fileOrDirectoryPath: Path | undefined = this.toPath(fileOrDirectory);
1163+
const fileOrDirectoryPath = this.toPath(fileOrDirectory);
11641164
const fsResult = project.getCachedDirectoryStructureHost().addOrDeleteFileOrDirectory(fileOrDirectory, fileOrDirectoryPath);
1165+
const configFileName = project.getConfigFilePath();
1166+
if (getBaseFileName(fileOrDirectoryPath) === "package.json" && !isInsideNodeModules(fileOrDirectoryPath) &&
1167+
(fsResult && fsResult.fileExists || !fsResult && this.host.fileExists(fileOrDirectoryPath))
1168+
) {
1169+
this.logger.info(`Project: ${configFileName} Detected new package.json: ${fileOrDirectory}`);
1170+
project.onAddPackageJson(fileOrDirectoryPath);
1171+
}
1172+
1173+
if (isIgnoredFileFromWildCardWatching({
1174+
watchedDirPath: directory,
1175+
fileOrDirectory,
1176+
fileOrDirectoryPath,
1177+
configFileName,
1178+
configFileSpecs: project.configFileSpecs!,
1179+
extraFileExtensions: this.hostConfiguration.extraFileExtensions,
1180+
currentDirectory: this.currentDirectory,
1181+
options: project.getCompilationSettings(),
1182+
program: project.getCurrentProgram(),
1183+
useCaseSensitiveFileNames: this.host.useCaseSensitiveFileNames,
1184+
writeLog: s => this.logger.info(s)
1185+
})) return;
11651186

11661187
// don't trigger callback on open, existing files
11671188
if (project.fileIsOpen(fileOrDirectoryPath)) {
@@ -1178,24 +1199,6 @@ namespace ts.server {
11781199
return;
11791200
}
11801201

1181-
fileOrDirectoryPath = removeIgnoredPath(fileOrDirectoryPath);
1182-
if (!fileOrDirectoryPath) return;
1183-
const configFilename = project.getConfigFilePath();
1184-
1185-
if (getBaseFileName(fileOrDirectoryPath) === "package.json" && !isInsideNodeModules(fileOrDirectoryPath) &&
1186-
(fsResult && fsResult.fileExists || !fsResult && this.host.fileExists(fileOrDirectoryPath))
1187-
) {
1188-
this.logger.info(`Project: ${configFilename} Detected new package.json: ${fileOrDirectory}`);
1189-
project.onAddPackageJson(fileOrDirectoryPath);
1190-
}
1191-
1192-
// If the the added or created file or directory is not supported file name, ignore the file
1193-
// But when watched directory is added/removed, we need to reload the file list
1194-
if (fileOrDirectoryPath !== directory && hasExtension(fileOrDirectoryPath) && !isSupportedSourceFileName(fileOrDirectory, project.getCompilationSettings(), this.hostConfiguration.extraFileExtensions)) {
1195-
this.logger.info(`Project: ${configFilename} Detected file add/remove of non supported extension: ${fileOrDirectory}`);
1196-
return;
1197-
}
1198-
11991202
// Reload is pending, do the reload
12001203
if (project.pendingReload !== ConfigFileProgramReloadLevel.Full) {
12011204
project.pendingReload = ConfigFileProgramReloadLevel.Partial;

‎src/testRunner/unittests/tsbuild/watchMode.ts‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1183,6 +1183,42 @@ export function someFn() { }`),
11831183
},
11841184
]
11851185
});
1186+
1187+
verifyTscWatch({
1188+
scenario,
1189+
subScenario: "should not trigger recompilation because of program emit",
1190+
commandLineArgs: ["-b", "-w", `${project}/${SubProject.core}`, "-verbose"],
1191+
sys: () => createWatchedSystem([libFile, ...core], { currentDirectory: projectsLocation }),
1192+
changes: [
1193+
noopChange,
1194+
{
1195+
caption: "Add new file",
1196+
change: sys => sys.writeFile(`${project}/${SubProject.core}/file3.ts`, `export const y = 10;`),
1197+
timeouts: checkSingleTimeoutQueueLengthAndRun
1198+
},
1199+
noopChange,
1200+
]
1201+
});
1202+
1203+
verifyTscWatch({
1204+
scenario,
1205+
subScenario: "should not trigger recompilation because of program emit with outDir specified",
1206+
commandLineArgs: ["-b", "-w", `${project}/${SubProject.core}`, "-verbose"],
1207+
sys: () => {
1208+
const [coreConfig, ...rest] = core;
1209+
const newCoreConfig: File = { path: coreConfig.path, content: JSON.stringify({ compilerOptions: { composite: true, outDir: "outDir" } }) };
1210+
return createWatchedSystem([libFile, newCoreConfig, ...rest], { currentDirectory: projectsLocation });
1211+
},
1212+
changes: [
1213+
noopChange,
1214+
{
1215+
caption: "Add new file",
1216+
change: sys => sys.writeFile(`${project}/${SubProject.core}/file3.ts`, `export const y = 10;`),
1217+
timeouts: checkSingleTimeoutQueueLengthAndRun
1218+
},
1219+
noopChange
1220+
]
1221+
});
11861222
});
11871223

11881224
describe("unittests:: tsbuild:: watchMode:: with demo project", () => {

0 commit comments

Comments
 (0)