microsoft / microsoft/TypeScript

Suggestion: flip the assignment direction of generated enums to save some bits

Open
#34,983 8 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Awaiting More Feedback Suggestion
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

Search Terms

enum assignment

Suggestion

Flip the assignment order

Use Cases

enums

Examples

enum Action {
  foo
  bar
  baz
  thequickbrownfoxjumpsoverthelazydog
}

currently generates:

"use strict";
var Action;
(function (Action) {
    Action[Action["foo"] = 0] = "foo";
    Action[Action["bar"] = 1] = "bar";
    Action[Action["baz"] = 2] = "baz";
    Action[Action["thequickbrownfoxjumpsoverthelazydog"] = 3] = "thequickbrownfoxjumpsoverthelazydog";
})(Action || (Action = {}));

Suggesting instead:

"use strict";
var Action;
(function (Action) {
    Action[Action[0] = "foo"] = 0;
    Action[Action[1] = "bar"] = 1;
    Action[Action[2] = "baz"] = 2;
    Action[Action[3] = "thequickbrownfoxjumpsoverthelazydog"] = 3;
})(Action || (Action = {}));

Checklist

My suggestion meets these guidelines:

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by compiling the enum example from the issue and comparing the current generated JavaScript with the proposed assignment order. Trace the TypeScript compiler's enum emission path, then verify that generated enums use the proposed form without changing runtime behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
compilers
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.