microsoft/TypeScript

JavaScript powered by TypeScript

billti opened this issue · 0 comments

billti commented

JavaScript powered by TypeScript

This proposal outlines the ability to provide a rich JavaScript development experience, by using and extending the capabilities present in TypeScript

The problem

  • JavaScript intellisense is a mixed bag today. The experiences differ, and it is often inconsistent and/or inaccurate. For example:
    • Execution based intellisense falls down on highly dynamic code (e.g. if code depends on external resources or user interaction), behaves differently on different hardware (due to timeout limits in allowing execution), and can be unpredictable (sometimes working or not-working based on seemingly unrelated edits)
    • Static analysis engines that do in depth code analysis such as tracking call-sites and conditional branches, can often be resource hungry (especially on large code bases) and requires a great deal of code & maintenance to handle the various JavaScript patterns used in the long tail of common libraries & modules
  • Types are great in TypeScript, and provide for accurate & consistent intellisense, but lots of developers want to keep writing JavaScript directly, or can't address all the TypeScript errors if migrating their existing JavaScript projects. Thus:
    • Some of the best JavaScript library definitions are in TypeScript, but are inaccessible to JavaScript developers
    • Even those wanting to move to projects (or part of them) to TypeScript have a tough challenge converting, due to TypeScript syntax and errors that typically occurs if one just renames a .js file to .ts
  • Types can be modeled in other ways in JavaScript, such as the common JsDoc comment format, but IDE support and modelling of existing libraries in these other formats is spotty at best
  • In Visual Studio currently, the integration across JavaScript tooling is poor, resulting in a less than stellar experience if working across areas:
    • The JavaScript language service - which is execution based, the Node Tools for Visual Studio - which is analysis based, and the TypeScript tooling - which has a static type system, have limited to zero integration points when authoring code across these project types
    • Beyond not understanding code across contexts, this results in a disparate editing experience, with ES6 syntax support, auto-formatting, intellisense behavior, etc… all slightly different across the three. (Not to mention the duplicate engineering in writing features and fixing bugs across three implementations)

The opportunity

If the TypeScript language service could be enhanced to work with JavaScript code:

  • The extensive library definitions provided by the TypeScript ecosystem could be leveraged, allowing for rich intellisense for common libraries.
  • Many of the challenges with execution based or analysis engine based intellisense could be avoided (though others occurs, as outlined further below).
  • As well as JavaScript leveraging the types defined in TypeScript, TypeScript could understand (to a degree) the code in JavaScript files.
  • This provides an ability to mix TypeScript & JavaScript code within a project, and also gradually migrate code if desired.
  • The ability of TypeScript to compile ES6+ constructs (classes, arrow functions, modules, etc…) down to ES5 code, could be applied to JavaScript as well (effectively allowing the authoring of ES6 JavaScript to run in ES5 engines). This applies to potentially other features in TypeScript also (e.g. providing JSX support based on TypeScript's TSX support).
  • Code across (currently) different project types could share context (e.g. browser targeted ES5 JavaScript could understand Node modules written in ES6 JavaScript, and could both leverage interfaces defined in TypeScript).
  • The editing experience and settings would be consistent across the experiences (and in Visual Studio for example, engineering costs for maintaining three implementations could be spent instead on improving the one).
  • Being based on the current TypeScript codebase would make this JavaScript experience available outside of Visual Studio (and for very cheap where the TypeScript language service is already used, e.g. the Sublime plugin, the VS Code editor, etc…).

The challenges

  • How to declare and use types within JavaScript (e.g. JsDoc, lib.d.ts, node.d.ts, 3rd party library definitions, custom code, inference, etc…)?
  • How to support common JavaScript patterns not supported by TypeScript today (RequireJS & CommonJS modules, constructor & prototype properties, etc…)?
  • How to feed JavaScript into TypeScript compilations (e.g. what files to pick up, compiler options, etc…)?
  • Assuming the above can be solved, what is the resulting JavaScript developer experience (e.g. making TypeScript "invisible" if just interested in writing JavaScript, the intellisense experience when type inference fails, example project structures and settings for different project types, how to author mixed code or migrate existing code)?

The above challenges are covered in the following separate write-ups: