Don't emit `const enum`s with reverse mapping (under `preserveConstEnum`)

timocov commented 4 years ago

Search Terms

preserveConstEnums, const enum, enum

Suggestion

By default all const enums are preserved from output. One of the key differences of const enums is disallowing to looking up the reversed value:

enum Enum {
  Zero,
  One,
}

console.log(Enum[1]); // allowed, result is 'One'

const enum ConstEnum {
  Zero,
  One,
}

console.log(ConstEnum[1]); // Error

This means that we can't access const enum's "reversed" member even if preserveConstEnums flag is enabled.

JS code of const enum with enabled preserveConstEnums is pretty similar to just enums right now and contains string literals (even they couldn't be accessed from the code):

var ConstEnum;
(function (ConstEnum) {
    ConstEnum[ConstEnum["Zero"] = 0] = "Zero";
    ConstEnum[ConstEnum["One"] = 1] = "One";
})(ConstEnum || (ConstEnum = {}));

My feature request is change output of const enums when preserveConstEnums is enabled and strip "reversed" values from it:

var ConstEnum;
(function (ConstEnum) {
    ConstEnum["Zero"] = 0;
    ConstEnum["One"] = 1;
})(ConstEnum || (ConstEnum = {}));

Note: actually tsc already has similar behaviour if you specify string constant value for every const enum's member, but the values are strings, not numbers - it is kind of workaround if your const enum is used to declare string constants.

Use Cases

Reversed values for const enums are useless and cannot be accessed in the TS code, so why we should emit them? 🤔 I guess in this case the behaviour of const enums from types and from execution (JS) purposes will be the same.

Checklist

My suggestion meets these guidelines:

[x] This wouldn't be a breaking change in existing TypeScript/JavaScript code
[ ] This wouldn't change the runtime behavior of existing JavaScript code
[x] This could be implemented without emitting different JS based on the types of the expressions
[x] This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
[x] This feature would agree with the rest of TypeScript's Design Goals.

RyanCavanaugh commented 4 years ago

Reversed values for const enums are useless and cannot be accessed in the TS code, so why we should emit them?

I mean, that's 100% true of const enum in general for both directions.

We created this flag because we found it very tiresome to do reverse lookups (from the value to the name) by hand in the debugger. I have to imagine other people are using it for the same reason and would be quite bothered by that scenario being broken.

timocov commented 4 years ago

Just as an use-case of using preserveConstEnum and const enums: inside the project we don't to use just enums because they are "massive" and aren't inlined so we use const enums everywhere. In other hand we provide a library, which could be used in JS code, so we don't want "break" their code and tell our consumers to use magic constants instead. That's why we've enabled preserveConstEnum - in the project we have inlined values, and in opposite we provide a way to use that enums in JS code.

microsoft / TypeScript