Make ScriptElementKind and HighlightSpanKind string enums #15966

ghost · 2017-05-20T14:56:13Z

Note: is technically a change to our public API as many strings are now ScriptElementKinds. And anyone using the API must now have ts@next or they will get compile errors on the string enums -- but presumably people compiling against the ts@next API are compiling using ts@next too.
Required running gulp LKG to get #15486 in.

mhegazy · 2017-05-22T16:14:46Z

src/services/types.ts


        /**
         * <JsxTagName attribute1 attribute2={0} />
         */
-        export const jsxAttribute = "JSX attribute";
+        jsxAttribute = "JSX attribute",
    }

    export namespace ScriptElementKindModifier {


should also change ScriptElementKindModifier to be an enum.

and ClassificationTypeNames

also server.CommandTypes

and HighlightSpanKind

mhegazy · 2017-05-22T16:15:07Z

src/services/types.ts


        /**
         * <JsxTagName attribute1 attribute2={0} />
         */
-        export const jsxAttribute = "JSX attribute";
+        jsxAttribute = "JSX attribute",
    }

    export namespace ScriptElementKindModifier {


and ClassificationTypeNames

mhegazy · 2017-05-22T16:16:16Z

src/services/types.ts


        /**
         * <JsxTagName attribute1 attribute2={0} />
         */
-        export const jsxAttribute = "JSX attribute";
+        jsxAttribute = "JSX attribute",
    }

    export namespace ScriptElementKindModifier {


also server.CommandTypes

mhegazy · 2017-05-22T16:17:48Z

src/services/types.ts


        /**
         * <JsxTagName attribute1 attribute2={0} />
         */
-        export const jsxAttribute = "JSX attribute";
+        jsxAttribute = "JSX attribute",
    }

    export namespace ScriptElementKindModifier {


and HighlightSpanKind

mhegazy · 2017-05-22T16:18:33Z

Also please add a note for this in https://github.com/Microsoft/TypeScript/wiki/API-Breaking-Changes#typescript-24

ghost · 2017-05-22T17:51:06Z

@mhegazy Is there any reason to avoid a non-const enum in protocol.ts? We iterate over for (const name in CommandNames) in a unit test (and now CommandNames = CommandTypes).

mhegazy · 2017-05-22T18:00:12Z

src/server/protocol.ts

@@ -2,103 +2,103 @@
 * Declaration module describing the TypeScript Server protocol
 */
 namespace ts.server.protocol {
-    export namespace CommandTypes {
-        export type Brace = "brace";
+    export enum CommandTypes {


this should be const enum, since it does not exist at time of building the client against the protocol file.

We need to iterate over it though -- I guess I could define a CommandTypes[] elsewhere but we'd have to remember to update both places every time a new command is added.

mhegazy · 2017-05-22T18:00:58Z

src/server/protocol.ts

-    export namespace NewLineKind {
-        export type Crlf = "Crlf";
-        export type Lf = "Lf";
+    export const enum NewLineKind {


missing the initialization here.

mhegazy · 2017-05-22T18:06:26Z

@mhegazy Is there any reason to avoid a non-const enum in protocol.ts? We iterate over for (const name in CommandNames) in a unit test (and now CommandNames = CommandTypes).

yes. protocol.ts compiles down to protocol.d.ts which is then used by the clients to compile against.

so either we make them const in protocol.ts or do that while we put together protocol.d.ts in buildProtocol.js.

msftclas added the cla-not-required label May 20, 2017

Make ScriptElementKind and HighlightSpanKind string enums

b162097

ghost force-pushed the kind branch from eed650e to b162097 Compare May 20, 2017 14:56

mhegazy reviewed May 22, 2017

View reviewed changes

mhegazy suggested changes May 22, 2017

View reviewed changes

mhegazy added Breaking Change Would introduce errors in existing code API Relates to the public API for TypeScript labels May 22, 2017

mhegazy added this to the TypeScript 2.4 milestone May 22, 2017

Andy Hanson added 2 commits May 22, 2017 10:40

Also convert ClassificationTypeNames and CommandTypes/CommandNames

f94818d

Convert other namespace + type alias in protocol.ts to const enums

3b56ebe

mhegazy reviewed May 22, 2017

View reviewed changes

mhegazy suggested changes May 22, 2017

View reviewed changes

Fix missing initializers

c6e69dd

Make CommandTypes a const enum and use allCommandTypes for unit test

f6240cb

mhegazy approved these changes May 22, 2017

View reviewed changes

Merge branch 'master' into kind

b1e100e

ghost merged commit 73ee2fe into master May 23, 2017

ghost deleted the kind branch May 23, 2017 14:19

microsoft locked and limited conversation to collaborators Jun 14, 2018

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make ScriptElementKind and HighlightSpanKind string enums #15966

Make ScriptElementKind and HighlightSpanKind string enums #15966

ghost commented May 20, 2017

mhegazy May 22, 2017

mhegazy May 22, 2017

mhegazy May 22, 2017

mhegazy May 22, 2017

mhegazy May 22, 2017

mhegazy May 22, 2017

mhegazy May 22, 2017

mhegazy commented May 22, 2017

ghost commented May 22, 2017

mhegazy May 22, 2017

ghost May 22, 2017

mhegazy May 22, 2017

mhegazy commented May 22, 2017

Make ScriptElementKind and HighlightSpanKind string enums #15966

Make ScriptElementKind and HighlightSpanKind string enums #15966

Conversation

ghost commented May 20, 2017

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

mhegazy commented May 22, 2017

ghost commented May 22, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mhegazy commented May 22, 2017