Skip to content

Allow --watchFactory option that uses user specified plugin for watching files and directories #54012

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.

Sign up for GitHub

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

Closed
wants to merge 6 commits into from
Closed

Allow --watchFactory option that uses user specified plugin for watching files and directories #54012

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c65e552
Add test using existing plugin
sheetalkamat Aug 25, 2022
5d692d5
watchFactory and allowPlugins option stub
sheetalkamat Nov 8, 2022
8b31670
WatchFactory implementation
sheetalkamat Apr 21, 2023
4ca063f
Allow watchFactory as a object with name and configuration
sheetalkamat Oct 7, 2022
9897a0d
Merge branch 'main' into watchFactory
sheetalkamat May 5, 2023
1ae673d
Merge branch 'main' into watchFactory
sheetalkamat May 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
117 changes: 91 additions & 26 deletions src/compiler/commandLineParser.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import {
CommandLineOption,
CommandLineOptionOfCustomType,
CommandLineOptionOfListType,
CommandLineOptionOfObjectType,
CompilerOptions,
CompilerOptionsValue,
ConfigFileSpecs,
Expand All @@ -22,6 +23,7 @@ import {
createGetCanonicalFileName,
Debug,
Diagnostic,
DiagnosticAndArguments,
DiagnosticArguments,
DiagnosticMessage,
Diagnostics,
Expand All @@ -45,6 +47,7 @@ import {
flatten,
forEach,
forEachEntry,
forEachPropertyAssignment,
forEachTsConfigPropArray,
getBaseFileName,
getDirectoryPath,
Expand Down Expand Up @@ -93,7 +96,9 @@ import {
ParseConfigHost,
ParsedCommandLine,
parseJsonText,
parsePackageName,
Path,
PluginImport,
PollingWatchKind,
PrefixUnaryExpression,
ProjectReference,
Expand All @@ -111,7 +116,6 @@ import {
toPath,
tracing,
trimString,
TsConfigOnlyOption,
TsConfigSourceFile,
TypeAcquisition,
unescapeLeadingUnderscores,
Expand Down Expand Up @@ -312,8 +316,31 @@ export const optionsForWatch: CommandLineOption[] = [
category: Diagnostics.Watch_and_Build_Modes,
description: Diagnostics.Remove_a_list_of_files_from_the_watch_mode_s_processing,
},
{
name: "watchFactory",
type: "string | object",
category: Diagnostics.Watch_and_Build_Modes,
description: Diagnostics.Specify_which_factory_to_invoke_watchFile_and_watchDirectory_on,
extraValidation: watchFactoryToDiagnostic,
elementOptions: commandLineOptionsToMap([
{
name: "name",
type: "string",
description: Diagnostics.Specify_which_factory_to_invoke_watchFile_and_watchDirectory_on,
},
]),
},
];

function watchFactoryToDiagnostic(watchFactory: CompilerOptionsValue, valueExpression: Expression | undefined) {
const watchFactoryName = isString(watchFactory) ? watchFactory : (watchFactory as PluginImport).name;
if (watchFactoryName && !parsePackageName(watchFactoryName).rest) return undefined;
const diagnostics: DiagnosticAndArguments = [Diagnostics.watchFactory_name_can_only_be_a_package_name];
if (!valueExpression || !isObjectLiteralExpression(valueExpression)) return diagnostics;
const errorNode = forEachPropertyAssignment(valueExpression, "name", prop => prop.initializer);
return errorNode ? { diagnostics, errorNode } : diagnostics;
}

/** @internal */
export const commonOptionsWithBuild: CommandLineOption[] = [
{
Expand Down Expand Up @@ -500,6 +527,14 @@ export const commonOptionsWithBuild: CommandLineOption[] = [
description: Diagnostics.Set_the_language_of_the_messaging_from_TypeScript_This_does_not_affect_emit,
defaultValueDescription: Diagnostics.Platform_specific
},
{
name: "allowPlugins",
type: "boolean",
category: Diagnostics.Command_line_Options,
isCommandLineOnly: true,
description: Diagnostics.Allow_running_plugins,
defaultValueDescription: false,
},
];

/** @internal */
Expand Down Expand Up @@ -1725,12 +1760,32 @@ export function parseListTypeOption(opt: CommandLineOptionOfListType, value = ""
return mapDefined(values, v => validateJsonOptionValue(opt.element, v || "", errors));
case "boolean":
case "object":
case "string | object":
return Debug.fail(`List of ${opt.element.type} is not yet supported.`);
default:
return mapDefined(values, v => parseCustomTypeOption(opt.element as CommandLineOptionOfCustomType, v, errors));
}
}

/** @internal */
export function parseObjectTypeOption(opt: CommandLineOptionOfObjectType, value: string | undefined, errors: Diagnostic[]): { value: CompilerOptionsValue | undefined } | undefined {
if (value === undefined) return undefined;
value = trimString(value);
if (startsWith(value, "-")) return undefined;
if (opt.type === "string | object" && !startsWith(value, "{")) {
return { value: validateJsonOptionValue(opt, value, errors) };
}
try {
const parsedValue = JSON.parse(value);
if (typeof parsedValue === "object") {
return { value: validateJsonOptionValue(opt, parsedValue, errors) };
}
}
catch { } // eslint-disable-line no-empty
errors.push(createCompilerDiagnostic(Diagnostics.Argument_for_0_option_must_be_Colon_1, opt.name, getCompilerOptionValueTypeString(opt)));
return { value: undefined };
}

/** @internal */
export interface OptionsBase {
[option: string]: CompilerOptionsValue | TsConfigSourceFile | undefined;
Expand Down Expand Up @@ -1908,9 +1963,15 @@ function parseOptionValue(
case "listOrElement":
Debug.fail("listOrElement not supported here");
break;
case "object":
case "string | object":
const objectResult = parseObjectTypeOption(opt, args[i], errors);
options[opt.name] = objectResult?.value;
if (objectResult) i++;
break;
// If not a primitive, the possible types are specified in what is effectively a map of options.
default:
options[opt.name] = parseCustomTypeOption(opt as CommandLineOptionOfCustomType, args[i], errors);
options[opt.name] = parseCustomTypeOption(opt, args[i], errors);
i++;
break;
}
Expand Down Expand Up @@ -2153,30 +2214,30 @@ const extendsOptionDeclaration: CommandLineOptionOfListType = {
type: "listOrElement",
element: {
name: "extends",
type: "string"
type: "string",
},
category: Diagnostics.File_Management,
disallowNullOrUndefined: true,
};
const compilerOptionsDeclaration: TsConfigOnlyOption = {
const compilerOptionsDeclaration: CommandLineOptionOfObjectType = {
name: "compilerOptions",
type: "object",
elementOptions: getCommandLineCompilerOptionsMap(),
extraKeyDiagnostics: compilerOptionsDidYouMeanDiagnostics,
};
const watchOptionsDeclaration: TsConfigOnlyOption = {
const watchOptionsDeclaration: CommandLineOptionOfObjectType = {
name: "watchOptions",
type: "object",
elementOptions: getCommandLineWatchOptionsMap(),
extraKeyDiagnostics: watchOptionsDidYouMeanDiagnostics,
};
const typeAcquisitionDeclaration: TsConfigOnlyOption = {
const typeAcquisitionDeclaration: CommandLineOptionOfObjectType = {
name: "typeAcquisition",
type: "object",
elementOptions: getCommandLineTypeAcquisitionMap(),
extraKeyDiagnostics: typeAcquisitionDidYouMeanDiagnostics
};
let _tsconfigRootOptions: TsConfigOnlyOption;
let _tsconfigRootOptions: CommandLineOptionOfObjectType;
function getTsconfigRootOptionsMap() {
if (_tsconfigRootOptions === undefined) {
_tsconfigRootOptions = {
Expand Down Expand Up @@ -2234,12 +2295,12 @@ function getTsconfigRootOptionsMap() {

/** @internal */
export interface JsonConversionNotifier {
rootOptions: TsConfigOnlyOption;
rootOptions: CommandLineOptionOfObjectType;
onPropertySet(
keyText: string,
value: any,
propertyAssignment: PropertyAssignment,
parentOption: TsConfigOnlyOption | undefined,
parentOption: CommandLineOptionOfObjectType | undefined,
option: CommandLineOption | undefined,
): void;
}
Expand Down Expand Up @@ -2300,7 +2361,7 @@ export function convertToJson(

function convertObjectLiteralExpressionToJson(
node: ObjectLiteralExpression,
objectOption: TsConfigOnlyOption | undefined,
objectOption: CommandLineOptionOfObjectType | undefined,
): any {
const result: any = returnValue ? {} : undefined;
for (const element of node.properties) {
Expand Down Expand Up @@ -2380,7 +2441,7 @@ export function convertToJson(
// that satifies it and need it to modify options set in them (for normalizing file paths)
// vs what we set in the json
// If need arises, we can modify this interface and callbacks as needed
return convertObjectLiteralExpressionToJson(objectLiteralExpression, option as TsConfigOnlyOption);
return convertObjectLiteralExpressionToJson(objectLiteralExpression, option as CommandLineOptionOfObjectType);

case SyntaxKind.ArrayLiteralExpression:
return convertArrayLiteralExpressionToJson(
Expand Down Expand Up @@ -2421,6 +2482,9 @@ function isCompilerOptionsValue(option: CommandLineOption | undefined, value: an
if (option.type === "listOrElement") {
return isArray(value) || isCompilerOptionsValue(option.element, value);
}
if (option.type === "string | object") {
return isString(value) || typeof value === "object";
}
const expectedType = isString(option.type) ? option.type : "string";
return typeof value === expectedType;
}
Expand Down Expand Up @@ -2530,6 +2594,7 @@ function getCustomTypeMapOfCommandLineOption(optionDefinition: CommandLineOption
case "number":
case "boolean":
case "object":
case "string | object":
// this is of a type CommandLineOptionOfPrimitiveType
return undefined;
case "list":
Expand Down Expand Up @@ -3246,7 +3311,7 @@ function parseOwnConfigOfJsonSourceFile(
keyText: string,
value: any,
propertyAssignment: PropertyAssignment,
parentOption: TsConfigOnlyOption | undefined,
parentOption: CommandLineOptionOfObjectType | undefined,
option: CommandLineOption | undefined,
) {
// Ensure value is verified except for extends which is handled in its own way for error reporting
Expand All @@ -3257,7 +3322,8 @@ function parseOwnConfigOfJsonSourceFile(
if (parentOption === compilerOptionsDeclaration) currentOption = options;
else if (parentOption === watchOptionsDeclaration) currentOption = watchOptions ??= {};
else if (parentOption === typeAcquisitionDeclaration) currentOption = typeAcquisition ??= getDefaultTypeAcquisition(configFileName);
else Debug.fail("Unknown option");
// Ignore anything other option that comes through as parent is not from root
else return;
currentOption[option.name] = value;
}
else if (keyText && parentOption?.extraKeyDiagnostics) {
Expand Down Expand Up @@ -3469,11 +3535,10 @@ export function convertJsonOption(
return undefined;
}
if (isCompilerOptionsValue(opt, value)) {
const optType = opt.type;
if ((optType === "list") && isArray(value)) {
if ((opt.type === "list") && isArray(value)) {
return convertJsonOptionOfListType(opt, value, basePath, errors, propertyAssignment, valueExpression as ArrayLiteralExpression | undefined, sourceFile);
}
else if (optType === "listOrElement") {
else if (opt.type === "listOrElement") {
return isArray(value) ?
convertJsonOptionOfListType(opt, value, basePath, errors, propertyAssignment, valueExpression as ArrayLiteralExpression | undefined, sourceFile) :
convertJsonOption(opt.element, value, basePath, errors, propertyAssignment, valueExpression, sourceFile);
Expand Down Expand Up @@ -3507,9 +3572,11 @@ function validateJsonOptionValue<T extends CompilerOptionsValue>(
sourceFile?: TsConfigSourceFile,
): T | undefined {
if (isNullOrUndefined(value)) return undefined;
const d = opt.extraValidation?.(value);
const d = opt.extraValidation?.(value, valueExpression);
if (!d) return value;
errors.push(createDiagnosticForNodeInSourceFileOrCompilerDiagnostic(sourceFile, valueExpression, ...d));
const diagnostics = isArray(d) ? d : d.diagnostics;
const errorNode = isArray(d) ? valueExpression : d.errorNode;
errors.push(createDiagnosticForNodeInSourceFileOrCompilerDiagnostic(sourceFile, errorNode, ...diagnostics));
return undefined;
}

Expand Down Expand Up @@ -3740,20 +3807,16 @@ function matchesExcludeWorker(
function validateSpecs(specs: readonly string[], errors: Diagnostic[], disallowTrailingRecursion: boolean, jsonSourceFile: TsConfigSourceFile | undefined, specKey: string): readonly string[] {
return specs.filter(spec => {
if (!isString(spec)) return false;
const diag = specToDiagnostic(spec, disallowTrailingRecursion);
const diag = specToDiagnostic(spec, /*valueExpresion*/ undefined, disallowTrailingRecursion);
if (diag !== undefined) {
errors.push(createDiagnostic(...diag));
const element = getTsConfigPropArrayElementValue(jsonSourceFile, specKey, spec);
errors.push(createDiagnosticForNodeInSourceFileOrCompilerDiagnostic(jsonSourceFile, element, ...diag));
}
return diag === undefined;
});

function createDiagnostic(message: DiagnosticMessage, spec: string): Diagnostic {
const element = getTsConfigPropArrayElementValue(jsonSourceFile, specKey, spec);
return createDiagnosticForNodeInSourceFileOrCompilerDiagnostic(jsonSourceFile, element, message, spec);
}
}

function specToDiagnostic(spec: CompilerOptionsValue, disallowTrailingRecursion?: boolean): [DiagnosticMessage, string] | undefined {
function specToDiagnostic(spec: CompilerOptionsValue, _valueExpresion?: Expression, disallowTrailingRecursion?: boolean): DiagnosticAndArguments | undefined {
Debug.assert(typeof spec === "string");
if (disallowTrailingRecursion && invalidTrailingRecursionPattern.test(spec)) {
return [Diagnostics.File_specification_cannot_end_in_a_recursive_directory_wildcard_Asterisk_Asterisk_Colon_0, spec];
Expand Down Expand Up @@ -3918,6 +3981,7 @@ function getOptionValueWithEmptyStrings(value: any, option: CommandLineOption):
if (value === undefined) return value;
switch (option.type) {
case "object": // "paths". Can't get any useful information from the value since we blank out strings, so just return "".
case "string | object":
return "";
case "string": // Could be any arbitrary string -- use empty string instead.
return "";
Expand Down Expand Up @@ -3948,6 +4012,7 @@ function getDefaultValueForOption(option: CommandLineOption): {} {
case "boolean":
return true;
case "string":
case "string | object":
const defaultValue = option.defaultValueDescription;
return option.isFilePath ? `./${defaultValue && typeof defaultValue === "string" ? defaultValue : ""}` : "";
case "list":
Expand Down
12 changes: 12 additions & 0 deletions src/compiler/diagnosticMessages.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4337,6 +4337,10 @@
"category": "Error",
"code": 5108
},
"'watchFactory' name can only be a package name.": {
"category": "Error",
"code": 5109
},

"Generates a sourcemap for each corresponding '.d.ts' file.": {
"category": "Message",
Expand Down Expand Up @@ -6095,6 +6099,10 @@
"category": "Message",
"code": 6718
},
"Specify which factory to invoke 'watchFile' and 'watchDirectory' on.": {
"category": "Message",
"code": 6719
},
"Default catch clause variables as 'unknown' instead of 'any'.": {
"category": "Message",
"code": 6803
Expand All @@ -6103,6 +6111,10 @@
"category": "Message",
"code": 6804
},
"Allow running plugins.": {
"category": "Message",
"code": 6805
},

"one of:": {
"category": "Message",
Expand Down
Loading