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.

Sign up for GitHub

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

Jump to bottom

babel-parser(ts): Add new plugin option dts: boolean #13113

Merged
merged 7 commits into from
Apr 28, 2021
Merged

babel-parser(ts): Add new plugin option dts: boolean #13113

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7dfff8e
Rename inDeclareContext => inAmbientContext
sosukesuzuki Apr 7, 2021
2c9f5b1
Parse as ambient context when the dts plugin is enabled
sosukesuzuki Apr 7, 2021
8653fe2
Add tests for existing errors related ambient context
sosukesuzuki Apr 7, 2021
ca8668e
Fix fogot fix
sosukesuzuki Apr 7, 2021
45a26a5
Add tests for trailing comma for rest parameters
sosukesuzuki Apr 7, 2021
c397cf5
Address review
sosukesuzuki Apr 8, 2021
98f5c6a
Address review
sosukesuzuki Apr 9, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
31 changes: 21 additions & 10 deletions packages/babel-parser/src/plugins/typescript/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1563,7 +1563,7 @@ export default (superClass: Class<Parser>): Class<Parser> =>
kind = "let";
}

return this.tsInDeclareContext(() => {
return this.tsInAmbientContext(() => {
switch (starttype) {
case tt._function:
nany.declare = true;
Expand Down Expand Up @@ -1853,7 +1853,7 @@ export default (superClass: Class<Parser>): Class<Parser> =>
this.finishNode(node, bodilessType);
return;
}
if (bodilessType === "TSDeclareFunction" && this.state.isDeclareContext) {
if (bodilessType === "TSDeclareFunction" && this.state.isAmbientContext) {
this.raise(node.start, TSErrors.DeclareFunctionHasImplementation);
if (
// $FlowIgnore
Expand Down Expand Up @@ -2207,7 +2207,7 @@ export default (superClass: Class<Parser>): Class<Parser> =>
super.parseClassMember(classBody, member, state);
};
if (member.declare) {
this.tsInDeclareContext(callParseClassMember);
this.tsInAmbientContext(callParseClassMember);
} else {
callParseClassMember();
}
Expand Down Expand Up @@ -2430,7 +2430,7 @@ export default (superClass: Class<Parser>): Class<Parser> =>
parseClassProperty(node: N.ClassProperty): N.ClassProperty {
this.parseClassPropertyAnnotation(node);

if (this.state.isDeclareContext && this.match(tt.eq)) {
if (this.state.isAmbientContext && this.match(tt.eq)) {
this.raise(this.state.start, TSErrors.DeclareClassFieldHasInitializer);
}

Expand Down Expand Up @@ -2680,7 +2680,7 @@ export default (superClass: Class<Parser>): Class<Parser> =>
if (this.eat(tt.question)) {
if (
param.type !== "Identifier" &&
!this.state.isDeclareContext &&
!this.state.isAmbientContext &&
!this.state.inType
) {
this.raise(param.start, TSErrors.PatternIsOptional);
Expand Down Expand Up @@ -2791,7 +2791,7 @@ export default (superClass: Class<Parser>): Class<Parser> =>

checkCommaAfterRest(close) {
if (
this.state.isDeclareContext &&
this.state.isAmbientContext &&
this.match(tt.comma) &&
this.lookaheadCharCode() === close
) {
Expand Down Expand Up @@ -2940,13 +2940,13 @@ export default (superClass: Class<Parser>): Class<Parser> =>
return param;
}

tsInDeclareContext<T>(cb: () => T): T {
const oldIsDeclareContext = this.state.isDeclareContext;
this.state.isDeclareContext = true;
tsInAmbientContext<T>(cb: () => T): T {
const oldIsAmbientContext = this.state.isAmbientContext;
this.state.isAmbientContext = true;
try {
return cb();
} finally {
this.state.isDeclareContext = oldIsDeclareContext;
this.state.isAmbientContext = oldIsAmbientContext;
}
}

Expand Down Expand Up @@ -3011,4 +3011,15 @@ export default (superClass: Class<Parser>): Class<Parser> =>
}
return method;
}

shouldParseAsDts(): boolean {
existentialism marked this conversation as resolved.
Show resolved Hide resolved
return !!this.getPluginOption("typescript", "dts");
}

parse() {
if (this.shouldParseAsDts()) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doing so all files would be parsed as declaration though, maybe we should check the filename also?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The parser ignores filenames (e.g. it doesn't check if a file has a .ts extension). Only files for which the dts: true option is enabled will be parsed as declaration, and it's up to the @babel/parser consumer to decide when to enable it.

this.state.isAmbientContext = true;
}
return super.parse();
}
};
2 changes: 1 addition & 1 deletion packages/babel-parser/src/tokenizer/state.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ export default class State {
inPropertyName: boolean = false;
hasFlowComment: boolean = false;
isIterator: boolean = false;
isDeclareContext: boolean = false;
isAmbientContext: boolean = false;
inAbstractClass: boolean = false;

// For the smartPipelines plugin:
Expand Down
1 change: 1 addition & 0 deletions packages/babel-parser/test/fixtures/typescript/dts/invalid-class-implementation/input.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
function foo(): any {}
42 changes: 42 additions & 0 deletions packages/babel-parser/test/fixtures/typescript/dts/invalid-class-implementation/output.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
{
"type": "File",
"start":0,"end":22,"loc":{"start":{"line":1,"column":0},"end":{"line":1,"column":22}},
"errors": [
"SyntaxError: An implementation cannot be declared in ambient contexts. (1:0)"
],
"program": {
"type": "Program",
"start":0,"end":22,"loc":{"start":{"line":1,"column":0},"end":{"line":1,"column":22}},
"sourceType": "script",
"interpreter": null,
"body": [
{
"type": "FunctionDeclaration",
"start":0,"end":22,"loc":{"start":{"line":1,"column":0},"end":{"line":1,"column":22}},
"id": {
"type": "Identifier",
"start":9,"end":12,"loc":{"start":{"line":1,"column":9},"end":{"line":1,"column":12},"identifierName":"foo"},
"name": "foo"
},
"generator": false,
"async": false,
"params": [],
"returnType": {
"type": "TSTypeAnnotation",
"start":14,"end":19,"loc":{"start":{"line":1,"column":14},"end":{"line":1,"column":19}},
"typeAnnotation": {
"type": "TSAnyKeyword",
"start":16,"end":19,"loc":{"start":{"line":1,"column":16},"end":{"line":1,"column":19}}
}
},
"body": {
"type": "BlockStatement",
"start":20,"end":22,"loc":{"start":{"line":1,"column":20},"end":{"line":1,"column":22}},
"body": [],
"directives": []
}
}
],
"directives": []
}
}
3 changes: 3 additions & 0 deletions packages/babel-parser/test/fixtures/typescript/dts/invalid-class-initializer/input.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
class Foo {
foo = 3;
}
52 changes: 52 additions & 0 deletions packages/babel-parser/test/fixtures/typescript/dts/invalid-class-initializer/output.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
{
"type": "File",
"start":0,"end":24,"loc":{"start":{"line":1,"column":0},"end":{"line":3,"column":1}},
"errors": [
"SyntaxError: Initializers are not allowed in ambient contexts. (2:6)"
],
"program": {
"type": "Program",
"start":0,"end":24,"loc":{"start":{"line":1,"column":0},"end":{"line":3,"column":1}},
"sourceType": "script",
"interpreter": null,
"body": [
{
"type": "ClassDeclaration",
"start":0,"end":24,"loc":{"start":{"line":1,"column":0},"end":{"line":3,"column":1}},
"id": {
"type": "Identifier",
"start":6,"end":9,"loc":{"start":{"line":1,"column":6},"end":{"line":1,"column":9},"identifierName":"Foo"},
"name": "Foo"
},
"superClass": null,
"body": {
"type": "ClassBody",
"start":10,"end":24,"loc":{"start":{"line":1,"column":10},"end":{"line":3,"column":1}},
"body": [
{
"type": "ClassProperty",
"start":14,"end":22,"loc":{"start":{"line":2,"column":2},"end":{"line":2,"column":10}},
"static": false,
"key": {
"type": "Identifier",
"start":14,"end":17,"loc":{"start":{"line":2,"column":2},"end":{"line":2,"column":5},"identifierName":"foo"},
"name": "foo"
},
"computed": false,
"value": {
"type": "NumericLiteral",
"start":20,"end":21,"loc":{"start":{"line":2,"column":8},"end":{"line":2,"column":9}},
"extra": {
"rawValue": 3,
"raw": "3"
},
"value": 3
}
}
]
}
}
],
"directives": []
}
}
3 changes: 3 additions & 0 deletions packages/babel-parser/test/fixtures/typescript/dts/options.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"plugins": [["typescript", { "dts": true }], "classProperties"]
}
1 change: 1 addition & 0 deletions packages/babel-parser/test/fixtures/typescript/dts/valid-optional-pattern/input.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
function f([]?): any;
40 changes: 40 additions & 0 deletions packages/babel-parser/test/fixtures/typescript/dts/valid-optional-pattern/output.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
{
"type": "File",
"start":0,"end":21,"loc":{"start":{"line":1,"column":0},"end":{"line":1,"column":21}},
"program": {
"type": "Program",
"start":0,"end":21,"loc":{"start":{"line":1,"column":0},"end":{"line":1,"column":21}},
"sourceType": "script",
"interpreter": null,
"body": [
{
"type": "TSDeclareFunction",
"start":0,"end":21,"loc":{"start":{"line":1,"column":0},"end":{"line":1,"column":21}},
"id": {
"type": "Identifier",
"start":9,"end":10,"loc":{"start":{"line":1,"column":9},"end":{"line":1,"column":10},"identifierName":"f"},
"name": "f"
},
"generator": false,
"async": false,
"params": [
{
"type": "ArrayPattern",
"start":11,"end":14,"loc":{"start":{"line":1,"column":11},"end":{"line":1,"column":14}},
"elements": [],
"optional": true
}
],
"returnType": {
"type": "TSTypeAnnotation",
"start":15,"end":20,"loc":{"start":{"line":1,"column":15},"end":{"line":1,"column":20}},
"typeAnnotation": {
"type": "TSAnyKeyword",
"start":17,"end":20,"loc":{"start":{"line":1,"column":17},"end":{"line":1,"column":20}}
}
}
}
],
"directives": []
}
}
1 change: 1 addition & 0 deletions packages/babel-parser/test/fixtures/typescript/dts/valid-trailing-comma-for-rest/input.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
function foo(...args: any[], );
47 changes: 47 additions & 0 deletions packages/babel-parser/test/fixtures/typescript/dts/valid-trailing-comma-for-rest/output.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
{
"type": "File",
"start":0,"end":31,"loc":{"start":{"line":1,"column":0},"end":{"line":1,"column":31}},
"program": {
"type": "Program",
"start":0,"end":31,"loc":{"start":{"line":1,"column":0},"end":{"line":1,"column":31}},
"sourceType": "script",
"interpreter": null,
"body": [
{
"type": "TSDeclareFunction",
"start":0,"end":31,"loc":{"start":{"line":1,"column":0},"end":{"line":1,"column":31}},
"id": {
"type": "Identifier",
"start":9,"end":12,"loc":{"start":{"line":1,"column":9},"end":{"line":1,"column":12},"identifierName":"foo"},
"name": "foo"
},
"generator": false,
"async": false,
"params": [
{
"type": "RestElement",
"start":13,"end":27,"loc":{"start":{"line":1,"column":13},"end":{"line":1,"column":27}},
"argument": {
"type": "Identifier",
"start":16,"end":20,"loc":{"start":{"line":1,"column":16},"end":{"line":1,"column":20},"identifierName":"args"},
"name": "args"
},
"typeAnnotation": {
"type": "TSTypeAnnotation",
"start":20,"end":27,"loc":{"start":{"line":1,"column":20},"end":{"line":1,"column":27}},
"typeAnnotation": {
"type": "TSArrayType",
"start":22,"end":27,"loc":{"start":{"line":1,"column":22},"end":{"line":1,"column":27}},
"elementType": {
"type": "TSAnyKeyword",
"start":22,"end":25,"loc":{"start":{"line":1,"column":22},"end":{"line":1,"column":25}}
}
}
}
}
]
}
],
"directives": []
}
}