microsoft / microsoft/TypeScript

Preserve computed property in `--isolatedDeclarations` emit

Open
#61,892 6 comments 6 reactions 0 assignees View on GitHub
Bug Domain: flag: isolatedDeclarations Help Wanted
Dominant language
Go
Stars
111k
Forks
14.3k
PR merge metrics
PR metrics pending

Description

### 🔍 Search Terms

isolated declarations, computed properties

### ✅ Viability Checklist

- [x] This wouldn't be a breaking change in existing TypeScript/JavaScript code
- [x] 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, new syntax sugar for JS, etc.)
- [x] This isn't a request to add a new utility type: https://github.com/microsoft/TypeScript/wiki/No-New-Utility-Types
- [x] This feature would agree with the rest of our Design Goals: https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals

### ⭐ Suggestion

Now that #60052 allows for (some) computed properties in in `.d.ts` files I think the next step is for `--isolatedDeclaration` to be updated to not error and to emit the computed properties. Opening this issue if helpful to track this work.

I believe the previous plan (#58800) to introduce a new syntactic marker is no longer required.

Related issues: #58533 #60818 #61068

### 📃 Motivating Example

```ts
export const prop: unique symbol = Symbol();

export class MyClass {
[prop] = () => Math.random();
}
```

### `@isolatedDeclarations: false`

[playground](https://www.typescriptlang.org/play/?isolatedDeclarations=false&ts=5.8.3#code/PTAEAEEsGcHsBsCGAXApgEwCKoMZIE4qSwB20AXKAGaLzSoBQqAHgA6z7Kg6nRev5YrSgFcSkAI4jUoaAE8AtgCMEoALygAyopXwAFAEoA3AyZsOXPImjRQAWTkBhJDdABvBqC+gA2gKEAuuqghuoAfPYoABYAdIQk6LAKhiYAvgxAA)

```ts
export declare const prop: unique symbol;
export declare class MyClass {
[prop]: () => number;
}
```

### `@isolatedDeclarations: true` (current 🙁)

[playground](https://www.typescriptlang.org/play/?isolatedDeclarations=true&ts=5.8.3#code/PTAEAEEsGcHsBsCGAXApgEwCKoMZIE4qSwB20AXKMvgK6oBQqAHgA6z7Kg6nScv6wWlGiUgBHOqGgBPALYAjBKAC8oAMpzF8ABQBKANz1GrdpzyJo0UAFlpAYSSXQAb3qh3oANr9BAXRWgeioAfDYoABYAdIQk6LCyeoYAvvRAA)

```sh
ts(9038) Computed property names on class or object literals cannot be inferred with --isolatedDeclarations.
```

```ts
export declare const prop: unique symbol;
export declare class MyClass {
}
```

### `@isolatedDeclarations: true` (future 🚀 )

No error and same emit as `@isolatedDeclarations: false`

```ts
export declare const prop: unique symbol;
export declare class MyClass {
[prop]: () => number;
}
```

### 💻 Use Cases

The primary use case is enabling isolated declarations at scale on large codebases that make heavy use of computed properties.

Contributor guide

Open the contributing guide

Research direction

Start by reproducing the motivating example with --isolatedDeclarations and review related issues #60052, #58800, #58533, #60818, and #61068. Trace the existing isolated-declaration handling for computed properties; done means no diagnostic and declaration emit preserves [prop] with the function's number return type.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
compilers
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.