Clean up public API a bit #58076

jakebailey · 2024-04-04T18:19:02Z

Following #58036, I made a script to process our public API and find elements which are unreferenced.

There's a lot more than this, including:

Type aliases for unions of different Nodes, which we may use internally for helpers but have exported for some reason.
The server protocol namespace
The typings installer protocol stuff
All of our Type interfaces, which are not connected to anything as they require casting

I can also make some of that internal (not the server protocol of course), if that's desirable.

typescript-bot · 2024-04-04T18:19:16Z

Looks like you're introducing a change to the public API surface area. If this includes breaking changes, please document them on our wiki's API Breaking Changes page.

Also, please make sure @DanielRosenwasser and @RyanCavanaugh are aware of the changes, just as a heads up.

jakebailey · 2024-04-04T18:19:41Z

src/compiler/types.ts

@@ -4167,6 +4169,7 @@ export interface FlowReduceLabel extends FlowNodeBase {
    antecedent: FlowNode;
 }

+/** @internal */
 export type FlowType = Type | IncompleteType;


Probably I should have noticed this in #58036, but we already make public all of the other types.

This is used by nobody: https://github.com/search?q=%2F%5Cbts%5C.FlowType%2F+%28language%3ATypeScript+OR+language%3AJavaScript%29&type=code

jakebailey · 2024-04-10T23:48:46Z

src/services/types.ts

@@ -1236,6 +1238,7 @@ export interface ReferencedSymbolEntry extends ReferenceEntry {
    isDefinition?: boolean;
 }

+/** @internal */


Need to revert this one; it's used :( https://github.com/search?q=%2Fts%5C.SymbolDisplayPartKind%2F&type=code

jakebailey · 2024-04-10T23:49:09Z

src/services/types.ts

@@ -1275,6 +1278,7 @@ export interface SymbolDisplayPart {
    kind: string;
 }

+/** @internal */


This too https://github.com/search?q=%2Fts%5C.JSDocLinkDisplayPart%2F&type=code

jakebailey · 2024-04-11T00:00:27Z

src/compiler/types.ts

@@ -896,6 +896,7 @@ export const enum ModifierFlags {
    Modifier = All & ~Decorator,
 }

+/** @internal */
 export const enum JsxFlags {


This is used once, but I feel like this shouldn't be exported: https://github.com/search?q=%2F%5Cbts%5C.JsxFlags%2F+%28language%3ATypeScript+OR+language%3AJavaScript%29&type=code

jakebailey · 2024-04-11T00:00:57Z

src/compiler/types.ts

@@ -3787,6 +3788,7 @@ export interface FileReference extends TextRange {
    preserve?: boolean;
 }

+/** @internal */
 export interface CheckJsDirective extends TextRange {


This is used by tsutils :( https://github.com/search?q=%2F%5Cbts%5C.CheckJsDirective%2F+%28language%3ATypeScript+OR+language%3AJavaScript%29&type=code

jakebailey · 2024-04-11T00:01:34Z

src/compiler/types.ts

@@ -4812,21 +4815,6 @@ export interface EmitTransformers {
    declarationTransformers: readonly TransformerFactory<SourceFile | Bundle>[];
 }

-export interface SourceMapSpan {


This looked bad but these are all forks of ourselves: https://github.com/search?q=%2F%5Cbts%5C.SourceMapSpan%2F+%28language%3ATypeScript+OR+language%3AJavaScript%29&type=code

jakebailey · 2024-04-11T00:01:59Z

src/compiler/types.ts

@@ -6774,6 +6762,7 @@ export type TypeMapper =
    | { kind: TypeMapKind.Function; func: (t: Type) => Type; debugInfo?: () => string; }
    | { kind: TypeMapKind.Composite | TypeMapKind.Merged; mapper1: TypeMapper; mapper2: TypeMapper; };

+/** @internal */
 // dprint-ignore
 export const enum InferencePriority {


This is used by nobody: https://github.com/search?q=%2F%5Cbts%5C.InferencePriority%2F+%28language%3ATypeScript+OR+language%3AJavaScript%29&type=code

jakebailey · 2024-04-11T00:02:21Z

src/server/editorServices.ts

@@ -509,7 +509,7 @@ export function convertUserPreferences(preferences: protocol.UserPreferences): U
    return userPreferences;
 }

-export interface HostConfiguration {
+interface HostConfiguration {


This looks like it may be used: https://github.com/search?q=%2F%5Cbts%5C.server%5C.HostConfiguration%2F+%28language%3ATypeScript+OR+language%3AJavaScript%29&type=code

jakebailey · 2024-04-11T00:02:55Z

src/server/session.ts

@@ -298,7 +298,7 @@ export function formatDiagnosticToProtocol(diag: Diagnostic, includeFileName: bo
        : common;
 }

-export interface PendingErrorCheck {
+interface PendingErrorCheck {


This may be used? https://github.com/search?q=%2F%5Cbts%5C.server%5C.PendingErrorCheck%2F+%28language%3ATypeScript+OR+language%3AJavaScript%29&type=code

jakebailey · 2024-04-11T00:03:16Z

src/server/types.ts

@@ -6,12 +6,6 @@ import {
    WatchOptions,
 } from "./_namespaces/ts";

-export interface CompressedData {


This is used by nobody: https://github.com/search?q=%2F%5Cbts%5C.server%5C.CompressedData%2F+%28language%3ATypeScript+OR+language%3AJavaScript%29&type=code

jakebailey

Doing a full search, it seems like a lot of this is somehow used externally :(

jakebailey · 2024-04-11T00:03:42Z

src/services/types.ts

@@ -293,6 +293,7 @@ export const enum PackageJsonAutoImportPreference {
    Auto,
 }

+/** @internal */
 export interface PerformanceEvent {


Unused: https://github.com/search?q=%2F%5Cbts%5C.PerformanceEvent%2F+%28language%3ATypeScript+OR+language%3AJavaScript%29&type=code

jakebailey · 2024-04-11T00:03:52Z

src/services/types.ts

@@ -304,6 +305,7 @@ export enum LanguageServiceMode {
    Syntactic,
 }

+/** @internal */
 export interface IncompleteCompletionsCache {


Unused: https://github.com/search?q=%2F%5Cbts%5C.IncompleteCompletionsCache%2F+%28language%3ATypeScript+OR+language%3AJavaScript%29&type=code

jakebailey · 2024-04-11T00:04:09Z

src/services/types.ts

@@ -1585,12 +1589,6 @@ export const enum OutliningSpanKind {
    Imports = "imports",
 }

-export const enum OutputFileType {


Used but by a very, very old project https://github.com/search?q=%2F%5Cbts%5C.OutputFileType%2F+%28language%3ATypeScript+OR+language%3AJavaScript%29&type=code

jakebailey · 2024-04-11T00:04:25Z

src/services/types.ts

@@ -1771,6 +1769,7 @@ export const enum ScriptElementKind {
    linkText = "link text",
 }

+/** @internal */
 export const enum ScriptElementKindModifier {


This is used https://github.com/search?q=%2F%5Cbts%5C.ScriptElementKindModifier%2F+%28language%3ATypeScript+OR+language%3AJavaScript%29&type=code

jakebailey · 2024-04-11T00:04:36Z

src/services/types.ts

@@ -1907,6 +1906,7 @@ export interface RefactorContext extends textChanges.TextChangesContext {
    kind?: string;
 }

+/** @internal */
 export interface InlayHintsContext {


Unused: https://github.com/search?q=%2F%5Cbts%5C.InlayHintsContext%2F+%28language%3ATypeScript+OR+language%3AJavaScript%29&type=code

Clean up public API a bit

28424a2

typescript-bot assigned jakebailey Apr 4, 2024

typescript-bot added Author: Team For Uncommitted Bug PR for untriaged, rejected, closed or missing bug labels Apr 4, 2024

jakebailey commented Apr 4, 2024

View reviewed changes

sheetalkamat approved these changes Apr 4, 2024

View reviewed changes

jakebailey requested review from andrewbranch and rbuckton April 5, 2024 19:28

andrewbranch approved these changes Apr 10, 2024

View reviewed changes

jakebailey requested a review from DanielRosenwasser April 10, 2024 17:42

jakebailey commented Apr 10, 2024

View reviewed changes

jakebailey commented Apr 11, 2024

View reviewed changes

jakebailey marked this pull request as draft April 11, 2024 00:05

jakebailey closed this Jul 25, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Clean up public API a bit #58076

Clean up public API a bit #58076

jakebailey commented Apr 4, 2024

typescript-bot commented Apr 4, 2024

jakebailey Apr 4, 2024

jakebailey Apr 11, 2024

jakebailey Apr 10, 2024

jakebailey Apr 10, 2024

jakebailey Apr 11, 2024

jakebailey Apr 11, 2024

jakebailey Apr 11, 2024

jakebailey Apr 11, 2024

jakebailey Apr 11, 2024

jakebailey Apr 11, 2024

jakebailey Apr 11, 2024

jakebailey left a comment

jakebailey Apr 11, 2024

jakebailey Apr 11, 2024

jakebailey Apr 11, 2024

jakebailey Apr 11, 2024

jakebailey Apr 11, 2024

Clean up public API a bit #58076

Clean up public API a bit #58076

Conversation

jakebailey commented Apr 4, 2024

typescript-bot commented Apr 4, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jakebailey left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment