Improve babel-core typings by liuxingbaoyu · Pull Request #14622 · babel/babel

liuxingbaoyu · 2022-05-30T22:08:51Z

Q	A
License	MIT

See #14601 for more info.

babel-bot · 2022-05-30T22:11:17Z

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

liuxingbaoyu · 2022-05-30T22:22:34Z

I didn't modify packages\babel-core\src\transformation\util\clone-deep.ts because of #14583.

liuxingbaoyu · 2022-05-30T23:04:50Z

packages/babel-core/src/transformation/index.ts

  code: string | null;
  map: SourceMap | null;
-  sourceType: "string" | "module";
+  sourceType: "script" | "module";


Seems to be a bug.

packages/babel-core/src/config/caching.ts

packages/babel-core/src/config/config-chain.ts

nicolo-ribaudo · 2022-05-31T09:37:51Z

packages/babel-core/src/config/files/index-browser.ts

 }

-export const ROOT_CONFIG_FILENAMES = [];
+export const ROOT_CONFIG_FILENAMES: any[] = [];


This is probably an array of strings?

I don't know, it's an empty implementation file. But string[] should be fine.

packages/babel-core/src/config/files/module-types.ts

nicolo-ribaudo · 2022-05-31T09:39:59Z

packages/babel-core/src/config/full.ts

-function enhanceError<T extends Function>(context, fn: T): T {
-  return function* (arg1, arg2) {
+function enhanceError<T extends Function>(context: any, fn: T): T {
+  return function* (arg1: unknown, arg2: unknown) {


We can use Parameters<T>[0] and Parameters<T>[1]

It doesn't seem to be, it can't be passed into the Function.

you should be able to use Parameters in here if you define proper correct type of T

i'm not sure what should be in here, but as simple example you can do something like this:

function enhanceError<T extends (arg1?: unknown, arg2?: unknown) => Generator<unknown>>( context: ConfigContext, fn: T, ): T { return function* (arg1: Parameters<T>[0], arg2: Parameters<T>[1]) {

see https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-6.html

packages/babel-core/src/config/full.ts

nicolo-ribaudo · 2022-05-31T09:44:58Z

packages/babel-core/src/config/full.ts

 );

-function chain(a, b) {
+function chain(a: any, b: any) {


Suggested change

function chain(a: any, b: any) {

function chain<Args extends any[])(a: undefined | (...args: Args) => void, b: undefined | (...args: Args) => void) {

and use Args instead of unknown[] below.

export default class Plugin { key: string | undefined | null; manipulateOptions?: (options: unknown, parserOpts: unknown) => void; post?: Function; pre?: Function; visitor: {};

Pre and post are passed in, and the types do not match. Do I need to modify the Plugin type?

packages/babel-core/src/config/helpers/config-api.ts

nicolo-ribaudo · 2022-05-31T09:48:28Z

packages/babel-core/src/config/index.ts

@@ -1,4 +1,5 @@
 import gensync from "gensync";


Todo (for myself): Continue reviewing from this file.

packages/babel-core/src/transformation/normalize-file.ts

packages/babel-core/src/transformation/block-hoist-plugin.ts

JLHwung

Awesome work.

I left some comments about Function. I think it should only be used when we have no idea about its signature, otherwise we'd better explicitly specify its input and output.

packages/babel-core/src/config/config-chain.ts

packages/babel-core/src/config/files/import-meta-resolve.ts

packages/babel-core/src/config/files/types.ts

packages/babel-core/src/config/full.ts

JLHwung · 2022-06-03T18:19:28Z

packages/babel-core/src/parser/util/missing-plugin-helper.ts

@@ -1,4 +1,7 @@
-const pluginNameMap = {
+const pluginNameMap: Record<


Can we mark this object as const? So we don't have to add typings at all and TS will infer the typings accordingly.

It doesn't seem to work, the object will be written below.

packages/babel-core/src/tools/build-external-helpers.ts

packages/babel-core/src/transform-file-browser.ts

rebase

packages/babel-core/src/config/index.ts

JLHwung · 2022-06-06T15:26:25Z

packages/babel-core/src/transform-ast.ts

  if (typeof opts === "function") {
    callback = opts;
-    opts = undefined;
+    opts = undefined as ValidatedOptions;


Q: why we need to cast undefined as ValidatedOptions?

Let the type of opts be ValidatedOptions from the function.

Isn't the opts parameter typed as InputOptions | undefined | null, so undefined should work? 🤔

opts: ValidatedOptions | FileParseCallback
Both ValidatedOptions and FileParseCallback can be undefined.

JLHwung · 2022-06-06T15:29:21Z

packages/babel-core/src/transformation/file/file.ts

+  metadata: { [key: string]: any } = {};
  code: string = "";
-  inputMap: any | null = null;
+  inputMap: any;


Is it SourceMapConverter from "convert-source-map"?

It seems yes, but there are such definitions in many files.
type SourceMap = any;
I don't know what the reason is.

packages\babel-core\src\transformation\file\generate.ts
packages\babel-core\src\transformation\index.ts
packages\babel-core\src\transformation\file\merge-map.ts

type SourceMap = any;

I believe it's a workaround due to lack of typings when we start transitioning to TS.

JLHwung · 2022-06-06T15:34:04Z

packages/babel-core/src/transformation/file/file.ts

-  path: NodePath<t.Program> = null;
-  ast: any = {};
+  _map: Map<unknown, unknown> = new Map();
+  opts: { [key: string]: any };


Is it ValidatedOptions from packages/babel-core/src/config/validation/options.ts returned by packages/babel-core/src/transformation/normalize-file.ts? Or should we come up with a new type NormalizedOptions?

Since I'm not familiar enough with babel internals, I can't confirm its type.
Maybe you can take a look after the PR is merged, I didn't change some code that was explicitly defined as any.

CI error is related.

packages/babel-core/src/config/resolve-targets-browser.ts

nicolo-ribaudo · 2022-06-10T19:54:00Z

packages/babel-core/src/config/index.ts

-  // NOTE: We want to return "null" explicitly, while ?. alone returns undefined
-  return config?.options ?? null;
-});
+const loadOptionsRunner = gensync<(opts: unknown) => ResolvedConfig | null>(


Future note: we will be able to drop our type definitions for gensync and use DefinitelyTyped/DefinitelyTyped#60125

packages/babel-core/src/config/resolve-targets-browser.ts

packages/babel-core/src/config/util.ts

packages/babel-core/src/gensync-utils/async.ts

nicolo-ribaudo · 2022-06-10T19:59:00Z

packages/babel-core/src/transform-ast.ts

  if (typeof opts === "function") {
    callback = opts;
-    opts = undefined;
+    opts = undefined as ValidatedOptions;


Isn't the opts parameter typed as InputOptions | undefined | null, so undefined should work? 🤔

nicolo-ribaudo · 2022-06-10T19:59:15Z

packages/babel-core/src/transform.ts

  if (typeof opts === "function") {
    callback = opts;
-    opts = undefined;
+    opts = undefined as InputOptions;


(also here)

nicolo-ribaudo · 2022-06-11T15:15:26Z

The linting error looks like a TS bug, I wonder if it's fixed in 4.7.

Co-authored-by: Nicolò Ribaudo <nicolo.ribaudo@gmail.com>

* enable noImplicitAny * codemod (#14602) * Improve preset/plugin-typescript typings (#14603) * preset-typescript * transform-typescript * Update packages/babel-plugin-transform-typescript/src/enum.ts Co-authored-by: Nicolò Ribaudo <nicolo.ribaudo@gmail.com> * prettier Co-authored-by: Nicolò Ribaudo <nicolo.ribaudo@gmail.com> * Improve transform-runtime typings (#14605) * enable noImplicitAny * codemod (#14602) * Improve preset/plugin-typescript typings (#14603) * preset-typescript * transform-typescript * Update packages/babel-plugin-transform-typescript/src/enum.ts Co-authored-by: Nicolò Ribaudo <nicolo.ribaudo@gmail.com> * prettier Co-authored-by: Nicolò Ribaudo <nicolo.ribaudo@gmail.com> * improve transform-runtime typings Co-authored-by: Nicolò Ribaudo <nicolo.ribaudo@gmail.com> * jsx (#14607) * Improve module transform packages typings (#14608) * improve babel-template typings (#14621) * Improve @babel/helper-* typings (#14620) * improve helper-function-name typings * helper hoist variables * helper-member-expression-to-functions * helper-simple-access * remap-async-to-generator * helper-annotate-as-pure * helper-builder-binary-assignment-operator-visitor * helper-check-duplicate-nodes * early return when export declaration is export all * split-export-declaration * helper-define-map * define-map * Update packages/babel-helper-builder-binary-assignment-operator-visitor/src/index.ts Co-authored-by: Nicolò Ribaudo <nicolo.ribaudo@gmail.com> * review comments Co-authored-by: Nicolò Ribaudo <nicolo.ribaudo@gmail.com> * improve helper-module-imports typings (#14623) * refactor: simplify ImportInjector._applyDefaults * helper-module-imports * map globals to the one used in Babel 8 * Improve fixture-test-runner typings (#14625) * plugin-test-runner * fixture-test-runner * Update packages/babel-helper-fixtures/src/index.ts Co-authored-by: Nicolò Ribaudo <nicolo.ribaudo@gmail.com> Co-authored-by: Nicolò Ribaudo <nicolo.ribaudo@gmail.com> * Improve preset-env typings (#14606) * refactor: move shipped-proposals to ts * preset-env * address review comments * Improve pipeline-operator typings (#14629) * refactor: simplify buildOptimizedSequenceExpression * proposal-pipeline-operator * address review comments * improve standalone typings (#14630) * babel-standalone * address review comment * Improve plugins typings (Part 1) (#14633) * change AssumptionFunction return type * helper-create-regexp-features-plugin * create-class-features-plugin * transform-for-of * improve unicode-escapes typings * transform-object-super * transform-react-constant-elements * proto-to-assign * function-name * flow-comments TS cannot infer Flow visitor type because we have both Flow type and Flow virtual type. * Improve code-frame/hightlight typings (#14643) * code-frame * map js-tokens to Babel 8 * highlight * Improve `@babel/types` typings (#14645) * bump to-fast-properties to v4 * types * mark node comments as mutable * Improve babel-core typings (#14622) Co-authored-by: Nicolò Ribaudo <nicolo.ribaudo@gmail.com> * improve transform-classes typings (#14624) * Improve `@babel/generator` typings (#14644) * generator * refactor: merge {start,end}Terminatorless to printTerminatorless * inline buildYieldAwait * inline ExportDeclaration * also export Pos * let getPossibleRaw return string | void * Apply suggestions from code review Co-authored-by: Nicolò Ribaudo <nicolo.ribaudo@gmail.com> Co-authored-by: liuxingbaoyu <30521560+liuxingbaoyu@users.noreply.github.com> * address review comments * do not export internal printer method * simplify needsWhitespace Co-authored-by: Nicolò Ribaudo <nicolo.ribaudo@gmail.com> Co-authored-by: liuxingbaoyu <30521560+liuxingbaoyu@users.noreply.github.com> * Improve plugins typings (Part 2) (#14639) * exponentiation-operator * duplicate-keys * computed-properties * replace-supers * block-scoping * block-scoped-functions * syntax-typescript * record-and-tuple * private-property-in-object * partial-application * json-strings * function-sent * function-bind * class-static-block * async-generator-functions * Update packages/babel-plugin-transform-block-scoping/src/index.ts * address review comments * helper-replace-supers * Improve plugins typings (Part 3) (#14642) * external-helpers * bugfix * transform-parameters * object-rest-spread * destructuring-private * transform-destructuring * proposal-decorators * optional-chaining * helper-wrap-function * explode-assignable-expression * helper-compilation-targets * helper-plugin-utils * helpers * helper-validator-option * fix: allow "+" and "-" in MappedType .readonly/.optional * fixture-test-runner * remove charcodes from dependencies the charcodes transform will inline charCodes.* so we can remove it from dependencies * Improve traverse typings (#14648) * export removeProperties options * traverse * fix other packages typings * fix gatherNodeParts * downgrade to-fast-properties to v3 * fix typo * babel-core/normalize-file * add ignore comment property used by flow plugin * refine getLastStatement typings * fix babel-standalone rebase typing error * fix assert.rejects polyfill * simplify _param typings * supress Babel 7 AST errors * loosen defineType typings The AST typings are generated from defineType calls, so defineType should accept a string as type. * restore legacy code * Suppress data/core-js-compat importing errors Co-authored-by: Nicolò Ribaudo <nicolo.ribaudo@gmail.com> Co-authored-by: liuxingbaoyu <30521560+liuxingbaoyu@users.noreply.github.com>

liuxingbaoyu commented May 30, 2022

View reviewed changes

nicolo-ribaudo reviewed May 31, 2022

View reviewed changes

armano2 reviewed May 31, 2022

View reviewed changes

packages/babel-core/src/transformation/normalize-file.ts Show resolved Hide resolved

armano2 reviewed May 31, 2022

View reviewed changes

packages/babel-core/src/transformation/block-hoist-plugin.ts Outdated Show resolved Hide resolved

JLHwung approved these changes Jun 3, 2022

View reviewed changes

liuxingbaoyu added 6 commits June 4, 2022 04:37

improve babel-core typings

bbbc06b

improve

4437ba2

rebase

fix

2a882d4

review

dc3f872

review

352273d

review

89f08e7

liuxingbaoyu force-pushed the improve-core-typings branch from e8ec5bf to 89f08e7 Compare June 3, 2022 20:41

JLHwung reviewed Jun 6, 2022

View reviewed changes

liuxingbaoyu added 3 commits June 7, 2022 06:00

review

e4db5f4

rebase

5f89ac8

improve

72fa686

JLHwung previously approved these changes Jun 7, 2022

View reviewed changes

JLHwung reviewed Jun 8, 2022

View reviewed changes

packages/babel-core/src/config/resolve-targets-browser.ts Show resolved Hide resolved

fix

4929a87

JLHwung approved these changes Jun 9, 2022

View reviewed changes

nicolo-ribaudo reviewed Jun 10, 2022

View reviewed changes

liuxingbaoyu and others added 3 commits June 11, 2022 20:50

review

e83294e

review

f5730b5

Avoid casting

72e34b5

nicolo-ribaudo approved these changes Jun 11, 2022

View reviewed changes

Fix TS crash

4b1e445

nicolo-ribaudo merged commit ac8bb49 into babel:noImplicitAny Jun 11, 2022

JLHwung pushed a commit that referenced this pull request Jun 20, 2022

Improve babel-core typings (#14622)

35fa868

Co-authored-by: Nicolò Ribaudo <nicolo.ribaudo@gmail.com>

JLHwung pushed a commit that referenced this pull request Jun 21, 2022

Improve babel-core typings (#14622)

79141a4

Co-authored-by: Nicolò Ribaudo <nicolo.ribaudo@gmail.com>

JLHwung pushed a commit that referenced this pull request Jun 21, 2022

Improve babel-core typings (#14622)

93ff5c3

Co-authored-by: Nicolò Ribaudo <nicolo.ribaudo@gmail.com>

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

github-actions bot locked as resolved and limited conversation to collaborators Sep 11, 2022

	function chain(a: any, b: any) {
	function chain<Args extends any[])(a: undefined \| (...args: Args) => void, b: undefined \| (...args: Args) => void) {

		@@ -1,4 +1,7 @@
		const pluginNameMap = {
		const pluginNameMap: Record<

Uh oh!

Conversation

liuxingbaoyu commented May 30, 2022 • edited by gitpod-io bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

babel-bot commented May 30, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

liuxingbaoyu commented May 30, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

armano2 Jun 6, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

JLHwung left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

liuxingbaoyu commented May 30, 2022 •

edited by gitpod-io bot

Loading

babel-bot commented May 30, 2022 •

edited

Loading

armano2 Jun 6, 2022 •

edited

Loading