microsoft / microsoft/TypeScript

Feature: triple-slash directive to override "target" compiler option

未关闭
#35,656 3 条评论 7 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

In Discussion Suggestion
主要语言
Go
星标
111k
派生
14.4k
平均合并
1 天 19 小时
30 天内合并 PR
117

描述

Search Terms

tsconfig override per-file compilerOptions code emit

Suggestion

Add a triple-slash directive to override the target compiler option within specific .ts code files.

Use Cases

With the final death of IE11 coming soon 🎈🎉🎊, my team and (I'm sure) many other teams are finally upgrading TS projects from "target": "ES5" to "ES6" or beyond.

What many of us will discover is that there can be subtle (or not-so-subtle) runtime differences between ES5 and newer syntactic equivalents--like true ES6 class declarations and the ES5 equivalent function+prototype object.

Our team has run into a problem where a library we still need to use calls class constructor functions using apply (not new) in its own implementation of inheritance/mixins - this throws a TypeError at runtime (and no, it would be impossible to fix it without a prohibitive, major breaking change to the library).

For reference, here's the relevant section of the ECMAScript standard: http://www.ecma-international.org/ecma-262/6.0/#sec-ecmascript-function-objects-call-thisargument-argumentslist, specifically 2. If F’s [[FunctionKind]] internal slot is "classConstructor", throw a TypeError exception..

Because of this and other runtime differences that exist between different target values, it would be extremely helpful to allow overriding this setting per-file, for those files where problems are encountered that can't be fixed in any other way. Locating the override within source code makes sense, since codegen options that affect runtime have parallel concern with the source code itself.

Alternatives?

The only alternatives I'm aware of are:

  • Continue to use ES5, don't upgrade projects
  • Run a multi-step build with different tsconfig.json files, specifically excluding/including the files with issues (not sure if this is really possible in a large project)
  • Transpile offending files down to ES5 using babel or similar (or maybe even tsc itself)
  • Locate offending files in a separate project (may not be possible, or may require prohibitive refactoring/reworking)

Besides the first option, the alternatives all require separating the information "these files need to be ES5" from the content of those files. A triple-slash TS directive is the best option because it doesn't separate these parallel concerns.

TS Syntax

Using a triple-slash directive makes sense since this is a pattern that is already supported and used extensively. I suggest the following syntax:

/// <compiler-options target="ES5"/>

This would also allow adding support for other compiler options in the future. However, it would only make sense to consider options that only affect code emit.

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.

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

首先检查 TypeScript 现有的 triple-slash directives 处理和 compiler options 处理,然后评估提议的 语法如何应用于单个 .ts 文件。完成标准是支持按文件设置的 target override,并且已针对所述的 ES5 与更新版本 emit 用例验证其行为和兼容性。

由索引模型根据 Issue 内容生成。

评估

技术栈
typescript
领域
compilers
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
基本清楚
新手友好度
25/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。