Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
5 tasks done
RoyTinker opened this issue Dec 12, 2019 · 3 comments · Fixed by RoyTinker/TypeScript#1
Open
5 tasks done
Labels
In Discussion Not yet reached consensus Suggestion An idea for TypeScript

Comments

@RoyTinker
Copy link

RoyTinker commented Dec 12, 2019

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.
@MartinJohns
Copy link
Contributor

Related: #31035

@RoyTinker
Copy link
Author

RoyTinker commented Dec 12, 2019

@MartinJohns This issue is specifically only for target - which is doable because it only affects code emit.

#31035 isn't doable because it would include type resolution and other options that would lead to undefined requirements/behavior.

RoyTinker pushed a commit to RoyTinker/TypeScript that referenced this issue Dec 19, 2019
RoyTinker pushed a commit to RoyTinker/TypeScript that referenced this issue Dec 19, 2019
RoyTinker pushed a commit to RoyTinker/TypeScript that referenced this issue Dec 19, 2019
@RoyTinker RoyTinker reopened this Dec 20, 2019
@RoyTinker
Copy link
Author

Apologies - I'm trying to work on this in a fork and accidentally closed this issue via a commit message.

@RyanCavanaugh RyanCavanaugh added In Discussion Not yet reached consensus Suggestion An idea for TypeScript labels Jan 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
In Discussion Not yet reached consensus Suggestion An idea for TypeScript
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants