userpreferences refactor

iisaduan · iisaduan · commit cf1f9769beca · 2025-10-02T12:52:28.000-07:00
diff --git a/internal/checker/nodebuilderimpl.go b/internal/checker/nodebuilderimpl.go
@@ -1207,8 +1207,8 @@ func (b *nodeBuilderImpl) getSpecifierForModuleSymbol(symbol *ast.Symbol, overri
 		contextFile,
 		host,
 		modulespecifiers.UserPreferences{
-			ImportModuleSpecifierPreference:       specifierPref,
-			ImportModuleSpecifierEndingPreference: endingPref,
+			ImportModuleSpecifierPreference: specifierPref,
+			ImportModuleSpecifierEnding:     endingPref,
 		},
 		modulespecifiers.ModuleSpecifierOptions{
 			OverrideImportMode: overrideImportMode,
diff --git a/internal/fourslash/fourslash.go b/internal/fourslash/fourslash.go
@@ -1611,11 +1611,11 @@ func (f *FourslashTest) verifyBaselineRename(
 
 		var renameOptions strings.Builder
 		if preferences != nil {
-			if preferences.UseAliasesForRename != nil {
-				fmt.Fprintf(&renameOptions, "// @useAliasesForRename: %v\n", *preferences.UseAliasesForRename)
+			if preferences.UseAliasesForRename != core.TSUnknown {
+				fmt.Fprintf(&renameOptions, "// @useAliasesForRename: %v\n", preferences.UseAliasesForRename.IsTrue())
 			}
-			if preferences.QuotePreference != nil {
-				fmt.Fprintf(&renameOptions, "// @quotePreference: %v\n", *preferences.QuotePreference)
+			if preferences.QuotePreference != ls.QuotePreferenceUnknown {
+				fmt.Fprintf(&renameOptions, "// @quotePreference: %v\n", preferences.QuotePreference)
 			}
 		}
 
diff --git a/internal/fourslash/tests/autoImportCompletion_test.go b/internal/fourslash/tests/autoImportCompletion_test.go
@@ -3,6 +3,7 @@ package fourslash_test
 import (
 	"testing"
 
+	"github.com/microsoft/typescript-go/internal/core"
 	"github.com/microsoft/typescript-go/internal/fourslash"
 	. "github.com/microsoft/typescript-go/internal/fourslash/tests/util"
 	"github.com/microsoft/typescript-go/internal/ls"
@@ -26,8 +27,8 @@ a/**/
 	f := fourslash.NewFourslash(t, nil /*capabilities*/, content)
 	f.VerifyCompletions(t, "", &fourslash.CompletionsExpectedList{
 		UserPreferences: &ls.UserPreferences{
-			IncludeCompletionsForModuleExports:    PtrTo(true),
-			IncludeCompletionsForImportStatements: PtrTo(true),
+			IncludeCompletionsForModuleExports:    core.TSTrue,
+			IncludeCompletionsForImportStatements: core.TSTrue,
 		},
 		IsIncomplete: false,
 		ItemDefaults: &fourslash.CompletionsExpectedItemDefaults{
@@ -56,8 +57,8 @@ a/**/
 	f := fourslash.NewFourslash(t, nil /*capabilities*/, content)
 	f.VerifyCompletions(t, "", &fourslash.CompletionsExpectedList{
 		UserPreferences: &ls.UserPreferences{
-			IncludeCompletionsForModuleExports:    PtrTo(true),
-			IncludeCompletionsForImportStatements: PtrTo(true),
+			IncludeCompletionsForModuleExports:    core.TSTrue,
+			IncludeCompletionsForImportStatements: core.TSTrue,
 		},
 		IsIncomplete: false,
 		ItemDefaults: &fourslash.CompletionsExpectedItemDefaults{
@@ -87,8 +88,8 @@ b/**/
 	f := fourslash.NewFourslash(t, nil /*capabilities*/, content)
 	f.VerifyCompletions(t, "", &fourslash.CompletionsExpectedList{
 		UserPreferences: &ls.UserPreferences{
-			IncludeCompletionsForModuleExports:    PtrTo(true),
-			IncludeCompletionsForImportStatements: PtrTo(true),
+			IncludeCompletionsForModuleExports:    core.TSTrue,
+			IncludeCompletionsForImportStatements: core.TSTrue,
 		},
 		IsIncomplete: false,
 		ItemDefaults: &fourslash.CompletionsExpectedItemDefaults{
diff --git a/internal/fourslash/tests/gen/renameExportSpecifier2_test.go b/internal/fourslash/tests/gen/renameExportSpecifier2_test.go
@@ -3,8 +3,8 @@ package fourslash_test
 import (
 	"testing"
 
+	"github.com/microsoft/typescript-go/internal/core"
 	"github.com/microsoft/typescript-go/internal/fourslash"
-	. "github.com/microsoft/typescript-go/internal/fourslash/tests/util"
 	"github.com/microsoft/typescript-go/internal/ls"
 	"github.com/microsoft/typescript-go/internal/testutil"
 )
@@ -20,5 +20,5 @@ export { name/**/ };
 import { name } from './a';
 const x = name.toString();`
 	f := fourslash.NewFourslash(t, nil /*capabilities*/, content)
-	f.VerifyBaselineRename(t, &ls.UserPreferences{UseAliasesForRename: PtrTo(false)}, "")
+	f.VerifyBaselineRename(t, &ls.UserPreferences{UseAliasesForRename: core.TSFalse}, "")
 }
diff --git a/internal/fourslash/tests/gen/renameExportSpecifier_test.go b/internal/fourslash/tests/gen/renameExportSpecifier_test.go
@@ -3,8 +3,8 @@ package fourslash_test
 import (
 	"testing"
 
+	"github.com/microsoft/typescript-go/internal/core"
 	"github.com/microsoft/typescript-go/internal/fourslash"
-	. "github.com/microsoft/typescript-go/internal/fourslash/tests/util"
 	"github.com/microsoft/typescript-go/internal/ls"
 	"github.com/microsoft/typescript-go/internal/testutil"
 )
@@ -20,5 +20,5 @@ export { name as name/**/ };
 import { name } from './a';
 const x = name.toString();`
 	f := fourslash.NewFourslash(t, nil /*capabilities*/, content)
-	f.VerifyBaselineRename(t, &ls.UserPreferences{UseAliasesForRename: PtrTo(false)}, "")
+	f.VerifyBaselineRename(t, &ls.UserPreferences{UseAliasesForRename: core.TSFalse}, "")
 }
diff --git a/internal/fourslash/tests/gen/renameModuleExportsProperties1_test.go b/internal/fourslash/tests/gen/renameModuleExportsProperties1_test.go
@@ -3,8 +3,8 @@ package fourslash_test
 import (
 	"testing"
 
+	"github.com/microsoft/typescript-go/internal/core"
 	"github.com/microsoft/typescript-go/internal/fourslash"
-	. "github.com/microsoft/typescript-go/internal/fourslash/tests/util"
 	"github.com/microsoft/typescript-go/internal/ls"
 	"github.com/microsoft/typescript-go/internal/testutil"
 )
@@ -16,5 +16,5 @@ func TestRenameModuleExportsProperties1(t *testing.T) {
 	const content = `[|class [|{| "contextRangeIndex": 0 |}A|] {}|]
 module.exports = { [|A|] }`
 	f := fourslash.NewFourslash(t, nil /*capabilities*/, content)
-	f.VerifyBaselineRename(t, &ls.UserPreferences{UseAliasesForRename: PtrTo(true)}, f.Ranges()[1], f.Ranges()[2])
+	f.VerifyBaselineRename(t, &ls.UserPreferences{UseAliasesForRename: core.TSTrue}, f.Ranges()[1], f.Ranges()[2])
 }
diff --git a/internal/fourslash/tests/gen/renameModuleExportsProperties3_test.go b/internal/fourslash/tests/gen/renameModuleExportsProperties3_test.go
@@ -3,8 +3,8 @@ package fourslash_test
 import (
 	"testing"
 
+	"github.com/microsoft/typescript-go/internal/core"
 	"github.com/microsoft/typescript-go/internal/fourslash"
-	. "github.com/microsoft/typescript-go/internal/fourslash/tests/util"
 	"github.com/microsoft/typescript-go/internal/ls"
 	"github.com/microsoft/typescript-go/internal/testutil"
 )
@@ -18,5 +18,5 @@ func TestRenameModuleExportsProperties3(t *testing.T) {
 [|class [|{| "contextRangeIndex": 0 |}A|] {}|]
 module.exports = { [|A|] }`
 	f := fourslash.NewFourslash(t, nil /*capabilities*/, content)
-	f.VerifyBaselineRename(t, &ls.UserPreferences{UseAliasesForRename: PtrTo(true)}, f.Ranges()[1], f.Ranges()[2])
+	f.VerifyBaselineRename(t, &ls.UserPreferences{UseAliasesForRename: core.TSTrue}, f.Ranges()[1], f.Ranges()[2])
 }
diff --git a/internal/fourslash/tests/gen/renameNamedImport_test.go b/internal/fourslash/tests/gen/renameNamedImport_test.go
@@ -3,8 +3,8 @@ package fourslash_test
 import (
 	"testing"
 
+	"github.com/microsoft/typescript-go/internal/core"
 	"github.com/microsoft/typescript-go/internal/fourslash"
-	. "github.com/microsoft/typescript-go/internal/fourslash/tests/util"
 	"github.com/microsoft/typescript-go/internal/ls"
 	"github.com/microsoft/typescript-go/internal/testutil"
 )
@@ -28,5 +28,5 @@ someExportedVariable;
 	f := fourslash.NewFourslash(t, nil /*capabilities*/, content)
 	f.GoToFile(t, "/home/src/workspaces/project/lib/index.ts")
 	f.GoToFile(t, "/home/src/workspaces/project/src/index.ts")
-	f.VerifyBaselineRename(t, &ls.UserPreferences{UseAliasesForRename: PtrTo(true)}, "i")
+	f.VerifyBaselineRename(t, &ls.UserPreferences{UseAliasesForRename: core.TSTrue}, "i")
 }
diff --git a/internal/fourslash/tests/gen/renameNumericalIndexSingleQuoted_test.go b/internal/fourslash/tests/gen/renameNumericalIndexSingleQuoted_test.go
@@ -4,7 +4,6 @@ import (
 	"testing"
 
 	"github.com/microsoft/typescript-go/internal/fourslash"
-	. "github.com/microsoft/typescript-go/internal/fourslash/tests/util"
 	"github.com/microsoft/typescript-go/internal/ls"
 	"github.com/microsoft/typescript-go/internal/testutil"
 )
@@ -16,5 +15,5 @@ func TestRenameNumericalIndexSingleQuoted(t *testing.T) {
 	const content = `const foo = { [|0|]: true };
 foo[[|0|]];`
 	f := fourslash.NewFourslash(t, nil /*capabilities*/, content)
-	f.VerifyBaselineRenameAtRangesWithText(t, &ls.UserPreferences{QuotePreference: PtrTo(ls.QuotePreference("single"))}, "0")
+	f.VerifyBaselineRenameAtRangesWithText(t, &ls.UserPreferences{QuotePreference: ls.QuotePreference("single")}, "0")
 }
diff --git a/internal/fourslash/tests/gen/renameRestBindingElement_test.go b/internal/fourslash/tests/gen/renameRestBindingElement_test.go
@@ -3,8 +3,8 @@ package fourslash_test
 import (
 	"testing"
 
+	"github.com/microsoft/typescript-go/internal/core"
 	"github.com/microsoft/typescript-go/internal/fourslash"
-	. "github.com/microsoft/typescript-go/internal/fourslash/tests/util"
 	"github.com/microsoft/typescript-go/internal/ls"
 	"github.com/microsoft/typescript-go/internal/testutil"
 )
@@ -22,5 +22,5 @@ function foo([|{ a, ...[|{| "contextRangeIndex": 0 |}rest|] }: I|]) {
     [|rest|];
 }`
 	f := fourslash.NewFourslash(t, nil /*capabilities*/, content)
-	f.VerifyBaselineRename(t, &ls.UserPreferences{UseAliasesForRename: PtrTo(true)}, f.Ranges()[1])
+	f.VerifyBaselineRename(t, &ls.UserPreferences{UseAliasesForRename: core.TSTrue}, f.Ranges()[1])
 }
diff --git a/internal/ls/autoimportfixes.go b/internal/ls/autoimportfixes.go
@@ -266,7 +266,7 @@ func (ct *changeTracker) getNewImports(
 		// even though it's not an error, it would add unnecessary runtime emit.
 		topLevelTypeOnly := (defaultImport == nil || needsTypeOnly(defaultImport.addAsTypeOnly)) &&
 			core.Every(namedImports, func(i *Import) bool { return needsTypeOnly(i.addAsTypeOnly) }) ||
-			(compilerOptions.VerbatimModuleSyntax.IsTrue() || ptrIsTrue(preferences.PreferTypeOnlyAutoImports)) &&
+			(compilerOptions.VerbatimModuleSyntax.IsTrue() || preferences.PreferTypeOnlyAutoImports) &&
 				defaultImport != nil && defaultImport.addAsTypeOnly != AddAsTypeOnlyNotAllowed && !core.Some(namedImports, func(i *Import) bool { return i.addAsTypeOnly == AddAsTypeOnlyNotAllowed })
 
 		var defaultImportNode *ast.Node
@@ -321,5 +321,5 @@ func needsTypeOnly(addAsTypeOnly AddAsTypeOnly) bool {
 }
 
 func shouldUseTypeOnly(addAsTypeOnly AddAsTypeOnly, preferences *UserPreferences) bool {
-	return needsTypeOnly(addAsTypeOnly) || addAsTypeOnly != AddAsTypeOnlyNotAllowed && preferences.PreferTypeOnlyAutoImports != nil && *preferences.PreferTypeOnlyAutoImports
+	return needsTypeOnly(addAsTypeOnly) || addAsTypeOnly != AddAsTypeOnlyNotAllowed && preferences.PreferTypeOnlyAutoImports
 }
diff --git a/internal/ls/completions.go b/internal/ls/completions.go
@@ -354,7 +354,7 @@ func (l *LanguageService) getCompletionsAtPosition(
 
 	if triggerCharacter != nil && *triggerCharacter == " " {
 		// `isValidTrigger` ensures we are at `import |`
-		if ptrIsTrue(preferences.IncludeCompletionsForImportStatements) {
+		if preferences.IncludeCompletionsForImportStatements.IsTrue() {
 			return &lsproto.CompletionList{
 				IsIncomplete: true,
 			}
@@ -586,7 +586,7 @@ func (l *LanguageService) getCompletionData(
 			}
 			keywordFilters = keywordFiltersFromSyntaxKind(importStatementCompletionInfo.keywordCompletion)
 		}
-		if importStatementCompletionInfo.replacementSpan != nil && ptrIsTrue(preferences.IncludeCompletionsForImportStatements) {
+		if importStatementCompletionInfo.replacementSpan != nil && preferences.IncludeCompletionsForImportStatements.IsTrue() {
 			// !!! flags |= CompletionInfoFlags.IsImportStatementCompletion;
 			importStatementCompletion = &importStatementCompletionInfo
 			isNewIdentifierLocation = importStatementCompletionInfo.isNewIdentifierLocation
@@ -936,7 +936,7 @@ func (l *LanguageService) getCompletionData(
 						insertQuestionDot := false
 						if typeChecker.IsNullableType(t) {
 							canCorrectToQuestionDot := isRightOfDot && !isRightOfQuestionDot &&
-								!ptrIsFalse(preferences.IncludeAutomaticOptionalChainCompletions)
+								!preferences.IncludeAutomaticOptionalChainCompletions.IsFalse()
 							if canCorrectToQuestionDot || isRightOfQuestionDot {
 								t = typeChecker.GetNonNullableType(t)
 								if canCorrectToQuestionDot {
@@ -963,7 +963,7 @@ func (l *LanguageService) getCompletionData(
 				insertQuestionDot := false
 				if typeChecker.IsNullableType(t) {
 					canCorrectToQuestionDot := isRightOfDot && !isRightOfQuestionDot &&
-						!ptrIsFalse(preferences.IncludeAutomaticOptionalChainCompletions)
+						!preferences.IncludeAutomaticOptionalChainCompletions.IsFalse()
 
 					if canCorrectToQuestionDot || isRightOfQuestionDot {
 						t = typeChecker.GetNonNullableType(t)
@@ -1128,7 +1128,7 @@ func (l *LanguageService) getCompletionData(
 			symbols = append(symbols, filteredMembers...)
 
 			// Set sort texts.
-			transformObjectLiteralMembers := ptrIsTrue(preferences.IncludeCompletionsWithObjectLiteralMethodSnippets) &&
+			transformObjectLiteralMembers := preferences.IncludeCompletionsWithObjectLiteralMethodSnippets.IsTrue() &&
 				objectLikeContainer.Kind == ast.KindObjectLiteralExpression
 			for _, member := range filteredMembers {
 				symbolId := ast.GetSymbolId(member)
@@ -1156,7 +1156,7 @@ func (l *LanguageService) getCompletionData(
 			return true
 		}
 		// If not already a module, must have modules enabled.
-		if !ptrIsTrue(preferences.IncludeCompletionsForModuleExports) {
+		if !preferences.IncludeCompletionsForModuleExports.IsTrue() {
 			return false
 		}
 		// Always using ES modules in 6.0+
@@ -2240,7 +2240,7 @@ func (l *LanguageService) createCompletionItem(
 		}
 	}
 
-	if ptrIsTrue(preferences.IncludeCompletionsWithClassMemberSnippets) &&
+	if preferences.IncludeCompletionsWithClassMemberSnippets.IsTrue() &&
 		data.completionKind == CompletionKindMemberLike &&
 		isClassLikeMemberCompletion(symbol, data.location, file) {
 		// !!! class member completions
@@ -2261,13 +2261,13 @@ func (l *LanguageService) createCompletionItem(
 	if data.isJsxIdentifierExpected &&
 		!data.isRightOfOpenTag &&
 		clientSupportsItemSnippet(clientOptions) &&
-		!jsxAttributeCompletionStyleIs(preferences.JsxAttributeCompletionStyle, JsxAttributeCompletionStyleNone) &&
+		preferences.JsxAttributeCompletionStyle != JsxAttributeCompletionStyleNone &&
 		!(ast.IsJsxAttribute(data.location.Parent) && data.location.Parent.Initializer() != nil) {
-		useBraces := jsxAttributeCompletionStyleIs(preferences.JsxAttributeCompletionStyle, JsxAttributeCompletionStyleBraces)
+		useBraces := preferences.JsxAttributeCompletionStyle == JsxAttributeCompletionStyleBraces
 		t := typeChecker.GetTypeOfSymbolAtLocation(symbol, data.location)
 
 		// If is boolean like or undefined, don't return a snippet, we want to return just the completion.
-		if jsxAttributeCompletionStyleIs(preferences.JsxAttributeCompletionStyle, JsxAttributeCompletionStyleAuto) &&
+		if preferences.JsxAttributeCompletionStyle == JsxAttributeCompletionStyleAuto &&
 			!t.IsBooleanLike() &&
 			!(t.IsUnion() && core.Some(t.Types(), (*checker.Type).IsBooleanLike)) {
 			if t.IsStringLike() ||
@@ -2533,13 +2533,6 @@ func boolToPtr(v bool) *bool {
 	return nil
 }
 
-func jsxAttributeCompletionStyleIs(preferenceStyle *JsxAttributeCompletionStyle, style JsxAttributeCompletionStyle) bool {
-	if preferenceStyle == nil {
-		return false
-	}
-	return *preferenceStyle == style
-}
-
 func getLineOfPosition(file *ast.SourceFile, pos int) int {
 	line, _ := scanner.GetECMALineAndCharacterOfPosition(file, pos)
 	return line
@@ -5170,7 +5163,7 @@ func (l *LanguageService) getSymbolCompletionFromItemData(
 		}
 	}
 
-	completionData := l.getCompletionData(ctx, ch, file, position, &UserPreferences{IncludeCompletionsForModuleExports: ptrTo(true), IncludeCompletionsForImportStatements: ptrTo(true)})
+	completionData := l.getCompletionData(ctx, ch, file, position, &UserPreferences{IncludeCompletionsForModuleExports: core.TSTrue, IncludeCompletionsForImportStatements: core.TSTrue})
 	if completionData == nil {
 		return detailsData{}
 	}
diff --git a/internal/ls/types.go b/internal/ls/types.go
diff --git a/internal/ls/userpreferences.go b/internal/ls/userpreferences.go
diff --git a/internal/lsp/server.go b/internal/lsp/server.go
diff --git a/internal/modulespecifiers/preferences.go b/internal/modulespecifiers/preferences.go
diff --git a/internal/modulespecifiers/types.go b/internal/modulespecifiers/types.go

Original file line number	Diff line number	Diff line change
`@@ -1611,11 +1611,11 @@ func (f *FourslashTest) verifyBaselineRename(`
`1611`	`1611`
`1612`	`1612`	`var renameOptions strings.Builder`
`1613`	`1613`	`if preferences != nil {`
`1614`		`- if preferences.UseAliasesForRename != nil {`
`1615`		`- fmt.Fprintf(&renameOptions, "// @useAliasesForRename: %v\n", *preferences.UseAliasesForRename)`
	`1614`	`+ if preferences.UseAliasesForRename != core.TSUnknown {`
	`1615`	`+ fmt.Fprintf(&renameOptions, "// @useAliasesForRename: %v\n", preferences.UseAliasesForRename.IsTrue())`
`1616`	`1616`	`}`
`1617`		`- if preferences.QuotePreference != nil {`
`1618`		`- fmt.Fprintf(&renameOptions, "// @quotePreference: %v\n", *preferences.QuotePreference)`
	`1617`	`+ if preferences.QuotePreference != ls.QuotePreferenceUnknown {`
	`1618`	`+ fmt.Fprintf(&renameOptions, "// @quotePreference: %v\n", preferences.QuotePreference)`
`1619`	`1619`	`}`
`1620`	`1620`	`}`
`1621`	`1621`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,6 @@ import (`
`4`	`4`	`"testing"`
`5`	`5`
`6`	`6`	`"github.com/microsoft/typescript-go/internal/fourslash"`
`7`		`- . "github.com/microsoft/typescript-go/internal/fourslash/tests/util"`
`8`	`7`	`"github.com/microsoft/typescript-go/internal/ls"`
`9`	`8`	`"github.com/microsoft/typescript-go/internal/testutil"`
`10`	`9`	`)`
`@@ -16,5 +15,5 @@ func TestRenameNumericalIndexSingleQuoted(t *testing.T) {`
`16`	`15`	const content = `const foo = { [\|0\|]: true };
`17`	`16`	foo[[\|0\|]];`
`18`	`17`	`f := fourslash.NewFourslash(t, nil /capabilities/, content)`
`19`		`- f.VerifyBaselineRenameAtRangesWithText(t, &ls.UserPreferences{QuotePreference: PtrTo(ls.QuotePreference("single"))}, "0")`
	`18`	`+ f.VerifyBaselineRenameAtRangesWithText(t, &ls.UserPreferences{QuotePreference: ls.QuotePreference("single")}, "0")`
`20`	`19`	`}`