babel-types: Add TypeScript definitions #5856

andy-ms · 2017-06-13T21:47:49Z

Q	A
Patch: Bug Fix?	no
Major: Breaking Change?	Yes in a few places, but only where it was wrong before.
Minor: New Feature?	yes
Deprecations?	no
Spec Compliancy?	yes
Tests Added/Pass?	n/a (see below)
Fixed Tickets
License	MIT
Doc PR
Dependency Changes

Companion to babel/babylon#523. This adds definitions for all of the TypeScript nodes.
I tested this by recursively validating TypeScript trees parsed from DefinitelyTyped. That script also tests the TS plugin, so I'll wait to include the script in the PR that adds the plugin.

CC @JamesHenry @soda0289 This defines the spec for TypeScript nodes, and duplicates the information found in types.js in babel/babylon#523.


        babel-types: Add TypeScript definitions

jridgewell · 2017-06-14T00:59:23Z

packages/babel-types/src/definitions/core.js

+    optional: true,
+  },
+};
+
 defineType("CallExpression", {


This now requires a builder property.

jridgewell · 2017-06-14T00:59:23Z

packages/babel-types/src/definitions/core.js

@@ -279,41 +302,44 @@ defineType("FunctionExpression", {
  inherits: "FunctionDeclaration",
  aliases: ["Scopable", "Function", "BlockParent", "FunctionParent", "Expression", "Pureish"],
  fields: {


Is this necessary? It already inherits.

It doesn't look like "inherits" merges things? opts.fields = opts.fields || inherits.fields || {};

But all the fields are the same, right?

A FunctionExpression can't have declare. id and body are the same but I don't think it would be worth extracting those out separately.

jridgewell · 2017-06-14T00:59:23Z

packages/babel-types/src/definitions/core.js

@@ -441,22 +467,18 @@ defineType("MemberExpression", {
 });

 defineType("NewExpression", {


This now requires a builder property.

jridgewell · 2017-06-14T00:59:23Z

packages/babel-types/src/definitions/core.js

@@ -494,8 +517,8 @@ defineType("ObjectMethod", {
    },
    key: {
      validate: (function () {
-        const normal = assertNodeType("Expression");
-        const computed = assertNodeType("Identifier", "StringLiteral", "NumericLiteral");
+        const normal = assertNodeType("Identifier", "StringLiteral", "NumericLiteral");


Shit, did I get these backwards? 😳

jridgewell · 2017-06-14T00:59:23Z

packages/babel-types/src/definitions/core.js

@@ -558,14 +575,12 @@ defineType("ObjectProperty", {

 defineType("RestElement", {


This now requires a builder property.

jridgewell · 2017-06-14T00:59:23Z

packages/babel-types/src/definitions/es2015.js

@@ -7,11 +7,13 @@ import defineType, {
  assertEach,
  assertOneOf,
 } from "./index";
+import { functionCommon, patternLikeCommon } from "./core";

 defineType("AssignmentPattern", {


This now requires a builder property.

jridgewell · 2017-06-14T00:59:23Z

packages/babel-types/src/definitions/es2015.js

@@ -26,10 +28,11 @@ defineType("AssignmentPattern", {

 defineType("ArrayPattern", {


This now requires a builder property.

jridgewell · 2017-06-14T00:59:23Z

packages/babel-types/src/definitions/es2015.js

-    params: {
-      validate: chain(assertValueType("array"), assertEach(assertNodeType("LVal"))),
+    // Unlike other functions, arrow functions are never generators.
+    ...(() => { const x = functionCommon; delete x.generator; return x; })(),


This is icky.

There is a proposal for arrow function generators at Stage 1 (not implemented) https://github.com/tc39/proposals

JamesHenry · 2017-06-14T08:07:04Z

Thanks for sharing @andy-ms 👍 I'll use this to build out a separate, shared test suite now that we are much closer to convergence

andy-ms · 2017-06-14T14:03:23Z

Hi @JamesHenry, I did write a validator that you can find in preview at https://github.com/andy-ms/babel/blob/typescript/packages/babel-plugin-transform-typescript/test/astUtils.js .


        Add missing builders


        Allow arrow function to have "generator"

codecov · 2017-06-14T22:25:01Z

Codecov Report

Merging #5856 into 7.0 will increase coverage by 0.08%.
The diff coverage is 98.83%.

@@            Coverage Diff             @@
##              7.0    #5856      +/-   ##
==========================================
+ Coverage   85.25%   85.34%   +0.08%     
==========================================
  Files         284      286       +2     
  Lines        9963    10030      +67     
  Branches     2781     2781              
==========================================
+ Hits         8494     8560      +66     
  Misses        969      969              
- Partials      500      501       +1

Impacted Files	Coverage Δ
packages/babel-types/src/definitions/flow.js	`100% <ø> (ø)`	⬆️
packages/babel-types/src/definitions/typescript.js	`100% <100%> (ø)`
packages/babel-types/src/definitions/core.js	`98.61% <100%> (+0.08%)`	⬆️
...ckages/babel-types/src/definitions/tsFlowCommon.js	`100% <100%> (ø)`
packages/babel-types/src/definitions/es2015.js	`96.96% <88.88%> (+0.3%)`	⬆️
...bel-plugin-transform-es2015-parameters/src/rest.js	`98.14% <0%> (-1.86%)`	⬇️
...bel-plugin-transform-es2015-classes/src/vanilla.js	`91.06% <0%> (+0.42%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5387d9f...3b4f31a. Read the comment docs.


        Replace link to resolved issue with comment

Jessidhia · 2017-06-28T08:57:08Z

packages/babel-types/src/definitions/typescript.js

+defineType("TSDeclareMethod", {
+  visitor: ["decorators", "key", "typeParameters", "params", "returnType"],
+  fields: classMethodOrDeclareMethodCommon,
+});


Are these for overload declarations, or for things that have the declare keyword?

Could be either. It's any method with no body.

declare class C1 { // ClassDeclaration with declare: true m(): void; // TSDeclareMethod } class C2 { m(x: number): number; // TSDeclareMethod m(x: string): string; // TSDeclareMethod m(x: any) { return x; } // ClassMethod }


        Merge branch '7.0' into ts-definitions

hzoo · 2017-07-12T20:19:55Z

packages/babel-types/src/definitions/core.js

@@ -264,30 +271,47 @@ defineType("ForStatement", {
  },
 });

+export const functionCommon = {
+  params: {


Looks like generator got removed?

generator: { default: false, validate: assertValueType("boolean"), }


        Re-add 'generator' to functionCommon

jridgewell · 2017-07-14T03:25:12Z

packages/babel-types/src/definitions/core.js

@@ -118,8 +118,10 @@ defineType("BreakStatement", {
  aliases: ["Statement", "Terminatorless", "CompletionStatement"],
 });

-defineType("CallExpression", {
-  visitor: ["callee", "arguments"],
+const callOrNew = {


Could we just have NewExpression inherit from CallExpression?

jridgewell · 2017-07-14T03:25:12Z

packages/babel-types/src/definitions/core.js

+  },
+  id: {
+    validate: assertNodeType("Identifier"),
+    optional: true, // May be null for `export default function`


Who's bright idea was this?!

export default function () {} should be named *default*, which you can't really represent as a valid Identifier :)

Moving this to babel/babylon#630.

jridgewell · 2017-07-14T03:25:12Z

packages/babel-types/src/definitions/es2015.js

-        assertEach(assertNodeType("LVal")),
-      ),
+    ...functionCommon,
+    expression: {


Instead of adding this, we should be removing it from babylon.

jridgewell · 2017-07-14T03:25:12Z

packages/babel-types/src/definitions/es2015.js

+    },
+    id: {
+      validate: assertNodeType("Identifier"),
+      optional: true, // Missing if this is the child of an ExportDefaultDeclaration.


Same reason as function. They're both special-cased in the spec to allow omitting the name specifically in this case.

hzoo

awesome work again andy, sorry for the wait

babel-types: Add TypeScript definitions

Loading status checks…

bd69873

jridgewell reviewed Jun 14, 2017

View changes

hzoo added the PR: New Feature 🚀 label Jun 14, 2017

andy-ms added 2 commits Jun 14, 2017

Add missing builders

545bb74

Allow arrow function to have "generator"

Loading status checks…

da2bc31

Replace link to resolved issue with comment

Loading status checks…

3b4f31a

Jessidhia reviewed Jun 28, 2017

View changes

Merge branch '7.0' into ts-definitions

Loading status checks…

cab6e7c

This was referenced Jun 28, 2017

babel-generator: Add TypeScript support #5896

Merged

Add babel-plugin-syntax-typescript, babel-plugin-transform-typescript, and babel-preset-typescript #5899

Merged

hzoo added the area: typescript label Jun 28, 2017

hzoo mentioned this pull request Jun 29, 2017

Typescript Plugin #320

Closed

0 of 5 tasks complete

hzoo reviewed Jul 12, 2017

View changes

Re-add 'generator' to functionCommon

Loading status checks…

03b8b82

jridgewell approved these changes Jul 14, 2017

View changes

jridgewell mentioned this pull request Jul 15, 2017

Export default unnamed declaration #5952

Closed

hzoo approved these changes Jul 25, 2017

View changes

hzoo merged commit 248743e into babel:7.0 Jul 25, 2017
3 checks passed

3 checks passed

ci/circleci Your tests passed on CircleCI!
Details

codecov/project 85.77% (target 80%)
Details

continuous-integration/travis-ci/pr The Travis CI build passed
Details

andy-ms deleted the andy-ms:ts-definitions branch Jul 26, 2017

andy-ms mentioned this pull request Jul 26, 2017

babel-types: Have NewExpression inherit from CallExpression #6019

Merged

JLHwung mentioned this pull request Jul 24, 2019

Add static to class property builder #10248

Merged

lock bot added the outdated label Oct 6, 2019

lock bot locked as resolved and limited conversation to collaborators Oct 6, 2019

babel/babel

babel-types: Add TypeScript definitions #5856

babel-types: Add TypeScript definitions #5856

andy-ms commented Jun 13, 2017 •

edited

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

JamesHenry commented Jun 14, 2017

This comment has been minimized.

andy-ms commented Jun 14, 2017

This comment has been minimized.

codecov bot commented Jun 14, 2017 •

edited

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

hzoo left a comment

Sponsor babel/babel

babel/babel

Join GitHub today

babel-types: Add TypeScript definitions #5856

Conversation

andy-ms commented Jun 13, 2017 • edited

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

JamesHenry commented Jun 14, 2017

This comment has been minimized.

andy-ms commented Jun 14, 2017

This comment has been minimized.

codecov bot commented Jun 14, 2017 • edited

Codecov Report

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

jridgewell Jul 14, 2017 • edited

This comment has been minimized.

hzoo left a comment

andy-ms commented Jun 13, 2017 •

edited

codecov bot commented Jun 14, 2017 •

edited

jridgewell Jul 14, 2017 •

edited