Remove unnecessary wrapper classes in ts.formatting.Rule (#19744)

* Remove unnecessary wrapper classes in ts.formatting.Rule

* RulesProvider -> immutable FormatContext

* Remove Rules class, just use a list of rules

* Remove Shared namespace, replace Shared.TokenRange with TokenRange

* Simplify TokenRange

* Separate Rule and RuleSpec

* Move FormattingRequestKind to formattingContext.ts

* Simplify references

* Fix lint

* Revert removal of trailing newlines

Author: Andy

src/harness/tsconfig.json

@@ -60,20 +60,11 @@
         "../services/jsTyping.ts",
         "../services/formatting/formatting.ts",
         "../services/formatting/formattingContext.ts",
-        "../services/formatting/formattingRequestKind.ts",
         "../services/formatting/formattingScanner.ts",
-        "../services/formatting/references.ts",
         "../services/formatting/rule.ts",
-        "../services/formatting/ruleAction.ts",
-        "../services/formatting/ruleDescriptor.ts",
-        "../services/formatting/ruleFlag.ts",
-        "../services/formatting/ruleOperation.ts",
-        "../services/formatting/ruleOperationContext.ts",
         "../services/formatting/rules.ts",
         "../services/formatting/rulesMap.ts",
-        "../services/formatting/rulesProvider.ts",
         "../services/formatting/smartIndenter.ts",
-        "../services/formatting/tokenRange.ts",
         "../services/codeFixProvider.ts",
         "../services/codefixes/fixes.ts",
         "../services/codefixes/helpers.ts",

src/harness/unittests/extractTestHelpers.ts

@@ -67,33 +67,27 @@ namespace ts {
     }
 
     export const newLineCharacter = "\n";
-    export const getRuleProvider = memoize(getRuleProviderInternal);
-    function getRuleProviderInternal() {
-        const options = {
-            indentSize: 4,
-            tabSize: 4,
-            newLineCharacter,
-            convertTabsToSpaces: true,
-            indentStyle: ts.IndentStyle.Smart,
-            insertSpaceAfterConstructor: false,
-            insertSpaceAfterCommaDelimiter: true,
-            insertSpaceAfterSemicolonInForStatements: true,
-            insertSpaceBeforeAndAfterBinaryOperators: true,
-            insertSpaceAfterKeywordsInControlFlowStatements: true,
-            insertSpaceAfterFunctionKeywordForAnonymousFunctions: false,
-            insertSpaceAfterOpeningAndBeforeClosingNonemptyParenthesis: false,
-            insertSpaceAfterOpeningAndBeforeClosingNonemptyBrackets: false,
-            insertSpaceAfterOpeningAndBeforeClosingNonemptyBraces: true,
-            insertSpaceAfterOpeningAndBeforeClosingTemplateStringBraces: false,
-            insertSpaceAfterOpeningAndBeforeClosingJsxExpressionBraces: false,
-            insertSpaceBeforeFunctionParenthesis: false,
-            placeOpenBraceOnNewLineForFunctions: false,
-            placeOpenBraceOnNewLineForControlBlocks: false,
-        };
-        const rulesProvider = new formatting.RulesProvider();
-        rulesProvider.ensureUpToDate(options);
-        return rulesProvider;
-    }
+    export const testFormatOptions: ts.FormatCodeSettings = {
+        indentSize: 4,
+        tabSize: 4,
+        newLineCharacter,
+        convertTabsToSpaces: true,
+        indentStyle: ts.IndentStyle.Smart,
+        insertSpaceAfterConstructor: false,
+        insertSpaceAfterCommaDelimiter: true,
+        insertSpaceAfterSemicolonInForStatements: true,
+        insertSpaceBeforeAndAfterBinaryOperators: true,
+        insertSpaceAfterKeywordsInControlFlowStatements: true,
+        insertSpaceAfterFunctionKeywordForAnonymousFunctions: false,
+        insertSpaceAfterOpeningAndBeforeClosingNonemptyParenthesis: false,
+        insertSpaceAfterOpeningAndBeforeClosingNonemptyBrackets: false,
+        insertSpaceAfterOpeningAndBeforeClosingNonemptyBraces: true,
+        insertSpaceAfterOpeningAndBeforeClosingTemplateStringBraces: false,
+        insertSpaceAfterOpeningAndBeforeClosingJsxExpressionBraces: false,
+        insertSpaceBeforeFunctionParenthesis: false,
+        placeOpenBraceOnNewLineForFunctions: false,
+        placeOpenBraceOnNewLineForControlBlocks: false,
+    };
 
     const notImplementedHost: LanguageServiceHost = {
         getCompilationSettings: notImplemented,
@@ -133,7 +127,7 @@ namespace ts {
                 startPosition: selectionRange.start,
                 endPosition: selectionRange.end,
                 host: notImplementedHost,
-                rulesProvider: getRuleProvider()
+                formatContext: formatting.getFormatContext(testFormatOptions),
             };
             const rangeToExtract = refactor.extractSymbol.getRangeToExtract(sourceFile, createTextSpanFromBounds(selectionRange.start, selectionRange.end));
             assert.equal(rangeToExtract.errors, undefined, rangeToExtract.errors && "Range error: " + rangeToExtract.errors[0].messageText);
@@ -197,7 +191,7 @@ namespace ts {
                 startPosition: selectionRange.start,
                 endPosition: selectionRange.end,
                 host: notImplementedHost,
-                rulesProvider: getRuleProvider()
+                formatContext: formatting.getFormatContext(testFormatOptions),
             };
             const rangeToExtract = refactor.extractSymbol.getRangeToExtract(sourceFile, createTextSpanFromBounds(selectionRange.start, selectionRange.end));
             assert.isUndefined(rangeToExtract.errors, rangeToExtract.errors && "Range error: " + rangeToExtract.errors[0].messageText);

src/harness/unittests/textChanges.ts

@@ -23,60 +23,8 @@ namespace ts {
         const printerOptions = { newLine: NewLineKind.LineFeed };
         const newLineCharacter = getNewLineCharacter(printerOptions);
 
-        const getRuleProviderDefault = memoize(() => {
-            const options = {
-                indentSize: 4,
-                tabSize: 4,
-                newLineCharacter,
-                convertTabsToSpaces: true,
-                indentStyle: ts.IndentStyle.Smart,
-                insertSpaceAfterConstructor: false,
-                insertSpaceAfterCommaDelimiter: true,
-                insertSpaceAfterSemicolonInForStatements: true,
-                insertSpaceBeforeAndAfterBinaryOperators: true,
-                insertSpaceAfterKeywordsInControlFlowStatements: true,
-                insertSpaceAfterFunctionKeywordForAnonymousFunctions: false,
-                insertSpaceAfterOpeningAndBeforeClosingNonemptyParenthesis: false,
-                insertSpaceAfterOpeningAndBeforeClosingNonemptyBrackets: false,
-                insertSpaceAfterOpeningAndBeforeClosingNonemptyBraces: true,
-                insertSpaceAfterOpeningAndBeforeClosingTemplateStringBraces: false,
-                insertSpaceAfterOpeningAndBeforeClosingJsxExpressionBraces: false,
-                insertSpaceBeforeFunctionParenthesis: false,
-                placeOpenBraceOnNewLineForFunctions: false,
-                placeOpenBraceOnNewLineForControlBlocks: false,
-            };
-            const rulesProvider = new formatting.RulesProvider();
-            rulesProvider.ensureUpToDate(options);
-            return rulesProvider;
-        });
-        const getRuleProviderNewlineBrace = memoize(() => {
-            const options = {
-                indentSize: 4,
-                tabSize: 4,
-                newLineCharacter,
-                convertTabsToSpaces: true,
-                indentStyle: ts.IndentStyle.Smart,
-                insertSpaceAfterConstructor: false,
-                insertSpaceAfterCommaDelimiter: true,
-                insertSpaceAfterSemicolonInForStatements: true,
-                insertSpaceBeforeAndAfterBinaryOperators: true,
-                insertSpaceAfterKeywordsInControlFlowStatements: true,
-                insertSpaceAfterFunctionKeywordForAnonymousFunctions: false,
-                insertSpaceAfterOpeningAndBeforeClosingNonemptyParenthesis: false,
-                insertSpaceAfterOpeningAndBeforeClosingNonemptyBrackets: false,
-                insertSpaceAfterOpeningAndBeforeClosingNonemptyBraces: true,
-                insertSpaceAfterOpeningAndBeforeClosingTemplateStringBraces: false,
-                insertSpaceAfterOpeningAndBeforeClosingJsxExpressionBraces: false,
-                insertSpaceBeforeFunctionParenthesis: false,
-                placeOpenBraceOnNewLineForFunctions: true,
-                placeOpenBraceOnNewLineForControlBlocks: false,
-            };
-            const rulesProvider = new formatting.RulesProvider();
-            rulesProvider.ensureUpToDate(options);
-            return rulesProvider;
-        });
-        function getRuleProvider(placeOpenBraceOnNewLineForFunctions: boolean) {
-            return placeOpenBraceOnNewLineForFunctions ? getRuleProviderNewlineBrace() : getRuleProviderDefault();
+        function getRuleProvider(placeOpenBraceOnNewLineForFunctions: boolean): formatting.FormatContext {
+            return formatting.getFormatContext(placeOpenBraceOnNewLineForFunctions ? { ...testFormatOptions, placeOpenBraceOnNewLineForFunctions: true } : testFormatOptions);
         }
 
         // validate that positions that were recovered from the printed text actually match positions that will be created if the same text is parsed.

src/services/codefixes/importFixes.ts

@@ -166,7 +166,7 @@ namespace ts.codefix {
         return {
             host: context.host,
             newLineCharacter: context.newLineCharacter,
-            rulesProvider: context.rulesProvider,
+            formatContext: context.formatContext,
             sourceFile: context.sourceFile,
             checker,
             compilerOptions: context.program.getCompilerOptions(),

src/services/completions.ts

@@ -415,7 +415,7 @@ namespace ts.Completions {
         entryId: CompletionEntryIdentifier,
         allSourceFiles: ReadonlyArray<SourceFile>,
         host: LanguageServiceHost,
-        rulesProvider: formatting.RulesProvider,
+        formatContext: formatting.FormatContext,
     ): CompletionEntryDetails {
         const { name, source } = entryId;
         // Compute all the completion symbols again.
@@ -436,7 +436,7 @@ namespace ts.Completions {
             }
             case "symbol": {
                 const { symbol, location, symbolToOriginInfoMap } = symbolCompletion;
-                const codeActions = getCompletionEntryCodeActions(symbolToOriginInfoMap, symbol, typeChecker, host, compilerOptions, sourceFile, rulesProvider);
+                const codeActions = getCompletionEntryCodeActions(symbolToOriginInfoMap, symbol, typeChecker, host, compilerOptions, sourceFile, formatContext);
                 const kindModifiers = SymbolDisplay.getSymbolModifiers(symbol);
                 const { displayParts, documentation, symbolKind, tags } = SymbolDisplay.getSymbolDisplayPartsDocumentationAndSymbolKind(typeChecker, symbol, sourceFile, location, location, SemanticMeaning.All);
                 return { name, kindModifiers, kind: symbolKind, displayParts, documentation, tags, codeActions, source: source === undefined ? undefined : [textPart(source)] };
@@ -467,7 +467,7 @@ namespace ts.Completions {
         host: LanguageServiceHost,
         compilerOptions: CompilerOptions,
         sourceFile: SourceFile,
-        rulesProvider: formatting.RulesProvider,
+        formatContext: formatting.FormatContext,
     ): CodeAction[] | undefined {
         const symbolOriginInfo = symbolToOriginInfoMap[getSymbolId(symbol)];
         if (!symbolOriginInfo) {
@@ -481,7 +481,7 @@ namespace ts.Completions {
             newLineCharacter: host.getNewLine(),
             compilerOptions,
             sourceFile,
-            rulesProvider,
+            formatContext,
             symbolName: symbol.name,
             getCanonicalFileName: createGetCanonicalFileName(host.useCaseSensitiveFileNames ? host.useCaseSensitiveFileNames() : false),
             symbolToken: undefined,