convert @babel/types to typescript #12431

zxbodya · 2020-12-01T20:24:51Z

Q	A
License	MIT

@babel/types part of #11578

EDIT by @nicolo-ribaudo

This should be merged as two different commits, to help git track file renames (useful for things like git blame):

fbf88cc
Everything else

codesandbox-ci · 2020-12-01T20:30:10Z

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit c9a67e9:

Sandbox	Source
babel-repl-custom-plugin	Configuration
babel-plugin-multi-config	Configuration

Makefile

JLHwung · 2020-12-01T21:29:52Z

Makefile

@@ -149,6 +148,10 @@ clean-tsconfig:
 	rm -f packages/*/tsconfig.{tsbuildinfo,json}
 	rm -f codemods/*/tsconfig.{tsbuildinfo,json}
 	rm -f eslint/*/tsconfig.{tsbuildinfo,json}
+	# revert files in git


I don't think we have added any tsconfig.json to git. Why we have to revert here?

@zxbodya If it is for rebasing the ts branch, you can split it in a separate commit used by that branch only.

there is separate PR #12420 - this is needed when converting other packages, for tsconfigs that can not be generated

babel-bot · 2020-12-01T22:06:22Z

Build successful! You can test your changes in the REPL here: https://babeljs.io/repl/build/34750/

packages/babel-types/src/builders/builder.ts

nicolo-ribaudo · 2020-12-04T12:56:07Z

@zxbodya I'll open a PR to your fork later today to fix the e2e test failure.

zxbodya#1

packages/babel-types/src/builders/generated/deprecated.js

packages/babel-types/lib/builders/generated/deprecated.d.ts

packages/babel-types/src/builders/generated/deprecated.js

nicolo-ribaudo · 2020-12-04T22:36:24Z

(I'm preparing a longer review)

nicolo-ribaudo

Overall, this is awesome!

nicolo-ribaudo · 2020-12-04T21:33:26Z

packages/babel-types/src/builders/builder.ts

+export default function builder(
+  type: t.Node["type"],
+  ...args: Array<any>
+): any {


This should return a t.Node. Maybe even better, we can type it as

export default function builder<T extends t.Node>( type: T["type"], ...args: Array<any> ): T

nicolo-ribaudo · 2020-12-04T21:35:37Z

packages/babel-types/src/builders/typescript/createTSUnionType.ts

-export default function createTSUnionType(
-  typeAnnotations: Array<Object>,
-): Object {
+export default function createTSUnionType(typeAnnotations: Array<any>): any {


This should be typed similarly to createFlowUnionType

function createTSUnionType<T extends t.TSType>(types: [T] | Array<T>): T | t.TSUnionType

Or maybe this is enough?

function createTSUnionType(types: Array<t.TSType>): t.TSType

interesting one - when added types, found few bugs - will add fix to pr 🙈

nicolo-ribaudo · 2020-12-04T21:36:31Z

packages/babel-types/src/index.ts

@@ -13,6 +12,7 @@ export { default as createUnionTypeAnnotation } from "./builders/flow/createFlow
 export { default as createFlowUnionType } from "./builders/flow/createFlowUnionType";


Could you mark the line above this one (createUnionTypeAnnotation) as deprecated?

nicolo-ribaudo · 2020-12-04T21:42:05Z

packages/babel-types/src/converters/gatherSequenceExpressions.ts

+  declars: Array<any>,
+): any | undefined | null {


Here instead of any we should use t.Node at least.

(with flow we had some problems with t.Node so we often used Object)

nicolo-ribaudo · 2020-12-04T21:42:54Z

packages/babel-types/src/converters/toBlock.ts

-export default function toBlock(node: Object, parent: Object): Object {
+export default function toBlock(
+  node: t.Statement | t.Expression,
+  parent?: t.Node | null,


Q: Do we pass null anywhere?

not sure… I suspect somewhere it was called with null and just added it to match the usage

but it looks to be not used anymore - removing the null

nicolo-ribaudo · 2020-12-04T22:29:10Z

packages/babel-types/src/utils/inherit.ts

-  child: Object,
-  parent: Object,
-): void {
+export default function inherit(key: string, child: any, parent: any): void {


t.Node instead of any.

nicolo-ribaudo · 2020-12-04T22:29:53Z

packages/babel-types/src/utils/react/cleanJSXElementLiteralChild.ts

+  child: {
+    value: string;
+  },
+  args: Array<any>,


nicolo-ribaudo · 2020-12-04T22:32:19Z

packages/babel-types/src/validators/isPlaceholderType.ts

@@ -10,7 +9,8 @@ export default function isPlaceholderType(
 ): boolean {
  if (placeholderType === targetType) return true;

-  const aliases: ?Array<string> = PLACEHOLDERS_ALIAS[placeholderType];
+  const aliases: Array<string> | undefined | null =


This is never null

nicolo-ribaudo · 2020-12-04T22:40:19Z

packages/babel-types/src/validators/is.ts

+  type: T,
+  node: t.Node | null | undefined,
+  opts?: undefined,
+): node is Extract<t.Node, { type: T }>;


nicolo-ribaudo · 2020-12-04T22:40:42Z

packages/babel-types/src/validators/isType.ts

  if (nodeType === targetType) return true;

  // This is a fast-path. If the test above failed, but an alias key is found, then the
  // targetType was a primary node type, so there's no need to check the aliases.
  if (ALIAS_KEYS[targetType]) return false;

-  const aliases: ?Array<string> = FLIPPED_ALIAS_KEYS[targetType];
+  const aliases: Array<string> | undefined | null =


This is never null

updated
this btw, is coming from from converted flow type: ?Array<string> ==> null | undefined | Array<string>

zxbodya · 2020-12-05T16:35:29Z

packages/babel-types/src/builders/typescript/createTSUnionType.ts

-  const types = typeAnnotations.map(type => type.typeAnnotations);
+  typeAnnotations: Array<t.TSTypeAnnotation>,
+): t.TSType {
+  const types = typeAnnotations.map(type => type.typeAnnotation);


looking at usage from babel-traverse apparently this was a typo and instead it should be . typeAnnotation instead

nicolo-ribaudo · 2020-12-09T15:28:33Z

Here you can see the published package - the published types look good.

types-7.12.10.tgz

zxbodya · 2020-12-09T15:28:33Z

Makefile

-build-typescript-typings:
-	echo "TODO: maybe add types for typescript 3.7"
+build-typescript-3.7-typings:
+	$(NODE) packages/babel-types/scripts/generators/typescript-3.7.js > packages/babel-types/lib/index-ts3.7.d.ts


would like to not have duplicated script for typescript type generation… - going to try https://github.com/sandersn/downlevel-dts (but this can also be after merging this pr)

I'd prefer to keep this solution that has been working well for a while. We'll remove it in Babel 8 anyway.

packages/babel-types/package.json

nicolo-ribaudo · 2020-12-10T17:28:31Z

I'm rebasing

* babel-types flowts convert * babel-types code generation updates * babel-types add more generated types to src (copy logic from scripts/typescript) * babel-types update generateBuilders to specify exact argument types * babel-types fix deprecated types generation * babel-types fixes * babel-types fix potential bug * babel-types update generateBuilders, to include proper return types * babel-types backport types from generated index.d.ts to be included in sources * babel-types fixes * babel-types avoid export of builders starting with upper case in ts sources * babel-types * babel-types todo updates, small fixes * babel-types generate helpers * babel-types remove typescript definitions generation * babel-types generate files * babel-types copy d.ts file for deprecated ast node creators into lib folder * babel-types use t as alias for ast node types namespace * babel-types update generateBuilders script to use "t" as alias instead of "types" * babel-types update deprecated builders generation to have more compact file * babel-types publish the .d.ts file for `@babel/types` * Publish the .d.ts file for `@babel/types` * Fix flowcheck * Prettier * No need to lint generated .d.ts files (now they are generated by tsc) * Run prepublish-prepare-dts from prepublish-build * Fix Babel 8 tests * Update codecov config * babel-types more improvements - better type for gatherSequenceExpressions - mark createUnionTypeAnnotation as deprecated - fix createTSUnionType - babel-types better type for builder - other improvements from PR comments * babel-types lint fix * babel-types fix createTSUnionType * Don't commit .d.ts file in lib, and rename "deprecated"->"uppercase" for builders * Add back types for TS 3.7 * Update packages/babel-types/package.json * Cleanup converters types Co-Authored-By: Nicolò Ribaudo <nicolo.ribaudo@gmail.com>

nicolo-ribaudo · 2020-12-10T18:19:36Z

Gulpfile.js

@@ -102,6 +113,8 @@ function generateTypeHelpers(helperKind) {
      })
    )
    .pipe(gulp.dest(dest));
+
+  return finish(stream);


@JLHwung This is a bug introduced by the recent gulpfile changes: we were returning a stream instead of a promise, and we were passing those streams to Promise.all.

Ah good catch!

JLHwung

This is awesome!

nicolo-ribaudo · 2020-12-10T20:20:24Z

JLHwung reviewed Dec 1, 2020

View reviewed changes

Makefile Outdated Show resolved Hide resolved

JLHwung reviewed Dec 1, 2020

View reviewed changes

zxbodya force-pushed the ts-migration/babel-types branch from 19506e5 to a42aee4 Compare December 1, 2020 22:04

nicolo-ribaudo reviewed Dec 1, 2020

View reviewed changes

packages/babel-types/src/builders/builder.ts Outdated Show resolved Hide resolved

nicolo-ribaudo added the Flow -> TS Tracking repository migration from Flow to TS label Dec 1, 2020

nicolo-ribaudo mentioned this pull request Dec 4, 2020

Publish the .d.ts file for @babel/types zxbodya/babel#1

Merged

nicolo-ribaudo reviewed Dec 4, 2020

View reviewed changes

packages/babel-types/src/builders/generated/deprecated.js Outdated Show resolved Hide resolved

nicolo-ribaudo reviewed Dec 4, 2020

View reviewed changes

packages/babel-types/lib/builders/generated/deprecated.d.ts Outdated Show resolved Hide resolved

nicolo-ribaudo reviewed Dec 4, 2020

View reviewed changes

packages/babel-types/src/builders/generated/deprecated.js Outdated Show resolved Hide resolved

nicolo-ribaudo reviewed Dec 4, 2020

View reviewed changes

zxbodya force-pushed the ts-migration/babel-types branch from ec46b84 to 29d0b3a Compare December 4, 2020 22:50

zxbodya commented Dec 5, 2020

View reviewed changes

This was referenced Dec 8, 2020

[babel 8] Remove the Noop node type #12361

Merged

Move some build steps to gulp #12127

Merged

zxbodya commented Dec 9, 2020

View reviewed changes

packages/babel-types/package.json Outdated Show resolved Hide resolved

nicolo-ribaudo force-pushed the ts-migration/babel-types branch 2 times, most recently from a6a268a to 1669fe6 Compare December 10, 2020 14:45

nicolo-ribaudo approved these changes Dec 10, 2020

View reviewed changes

nicolo-ribaudo added the pkg: types label Dec 10, 2020

zxbodya and others added 2 commits December 10, 2020 18:54

Convert @babel/types to TS: rename files (babel#12431)

0a2a007

nicolo-ribaudo force-pushed the ts-migration/babel-types branch from 1669fe6 to c9a67e9 Compare December 10, 2020 18:17

nicolo-ribaudo reviewed Dec 10, 2020

View reviewed changes

JLHwung approved these changes Dec 10, 2020

View reviewed changes

nicolo-ribaudo merged commit 1290d21 into babel:main Dec 10, 2020

nicolo-ribaudo deleted the ts-migration/babel-types branch December 10, 2020 20:22

nicolo-ribaudo pushed a commit that referenced this pull request Dec 10, 2020

Convert @babel/types to TS: rename files (#12431)

c0a8cbd

github-actions bot added the outdated A closed issue/PR that is archived due to age. Recommended to make a new issue label Mar 12, 2021

github-actions bot locked as resolved and limited conversation to collaborators Mar 12, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

convert @babel/types to typescript #12431

convert @babel/types to typescript #12431

zxbodya commented Dec 1, 2020 •

edited by gitpod-io bot

codesandbox-ci bot commented Dec 1, 2020 •

edited

JLHwung Dec 1, 2020

zxbodya Dec 1, 2020

babel-bot commented Dec 1, 2020 •

edited

nicolo-ribaudo commented Dec 4, 2020 •

edited

nicolo-ribaudo commented Dec 4, 2020

nicolo-ribaudo left a comment

nicolo-ribaudo Dec 4, 2020

nicolo-ribaudo Dec 4, 2020

zxbodya Dec 4, 2020

nicolo-ribaudo Dec 4, 2020

nicolo-ribaudo Dec 4, 2020

nicolo-ribaudo Dec 4, 2020

zxbodya Dec 4, 2020

nicolo-ribaudo Dec 4, 2020

zxbodya Dec 5, 2020

nicolo-ribaudo Dec 4, 2020

zxbodya Dec 5, 2020

nicolo-ribaudo Dec 4, 2020

nicolo-ribaudo Dec 4, 2020

nicolo-ribaudo Dec 4, 2020

zxbodya Dec 5, 2020

zxbodya Dec 5, 2020

nicolo-ribaudo commented Dec 9, 2020

zxbodya Dec 9, 2020 •

edited

nicolo-ribaudo Dec 9, 2020 •

edited

nicolo-ribaudo commented Dec 10, 2020

nicolo-ribaudo Dec 10, 2020

JLHwung Dec 10, 2020

JLHwung left a comment

nicolo-ribaudo commented Dec 10, 2020

		@@ -13,6 +12,7 @@ export { default as createUnionTypeAnnotation } from "./builders/flow/createFlow
		export { default as createFlowUnionType } from "./builders/flow/createFlowUnionType";

convert @babel/types to typescript #12431

convert @babel/types to typescript #12431

Conversation

zxbodya commented Dec 1, 2020 • edited by gitpod-io bot

codesandbox-ci bot commented Dec 1, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

babel-bot commented Dec 1, 2020 • edited

nicolo-ribaudo commented Dec 4, 2020 • edited

nicolo-ribaudo commented Dec 4, 2020

nicolo-ribaudo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicolo-ribaudo commented Dec 9, 2020

zxbodya Dec 9, 2020 • edited

Choose a reason for hiding this comment

nicolo-ribaudo Dec 9, 2020 • edited

Choose a reason for hiding this comment

nicolo-ribaudo commented Dec 10, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JLHwung left a comment

Choose a reason for hiding this comment

nicolo-ribaudo commented Dec 10, 2020

zxbodya commented Dec 1, 2020 •

edited by gitpod-io bot

codesandbox-ci bot commented Dec 1, 2020 •

edited

babel-bot commented Dec 1, 2020 •

edited

nicolo-ribaudo commented Dec 4, 2020 •

edited

zxbodya Dec 9, 2020 •

edited

nicolo-ribaudo Dec 9, 2020 •

edited