cerxes/babel
3
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Implement support for declare on class fields with Flow (#11178)

Browse Source 
* Add parser support for Flow declare fields

* Add generator test

* Add "allowDeclareFields" option to flow-strip-types

* Add test

* Update error messages

* More tests
This commit is contained in:
Nicolò Ribaudo 2020-03-16 23:08:26 +01:00 committed by GitHub
parent 286aaeadd9
commit 5c1a8210da
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
51 changed files with 2439 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
packages/babel-generator/test/fixtures/flow/declare-field/input.js vendored Normal file
View File

@ -0,0 +1,4 @@
class A {
declare x
declare static y
}

3
packages/babel-generator/test/fixtures/flow/declare-field/options.json vendored Normal file
View File

@ -0,0 +1,3 @@
{
"plugins": ["flow", "classProperties"]
}

4
packages/babel-generator/test/fixtures/flow/declare-field/output.js vendored Normal file
View File

@ -0,0 +1,4 @@
class A {
declare x;
declare static y;
}

37
packages/babel-parser/src/parser/statement.js
View File

@ -1240,22 +1240,19 @@ export default class StatementParser extends ExpressionParser {
return this.finishNode(classBody, "ClassBody"); return this.finishNode(classBody, "ClassBody");
} }
parseClassMember( // returns true if the current identifier is a method/field name,
// false if it is a modifier
parseClassMemberFromModifier(
classBody: N.ClassBody, classBody: N.ClassBody,
member: N.ClassMember, member: N.ClassMember,
state: { hadConstructor: boolean }, ): boolean {
constructorAllowsSuper: boolean,
): void {
let isStatic = false;
const containsEsc = this.state.containsEsc; const containsEsc = this.state.containsEsc;
const key = this.parseIdentifier(true); // eats the modifier
if (this.match(tt.name) && this.state.value === "static") {
const key = this.parseIdentifier(true); // eats 'static'
if (this.isClassMethod()) { if (this.isClassMethod()) {
const method: N.ClassMethod = (member: any); const method: N.ClassMethod = (member: any);
// a method named 'static' // a method named like the modifier
method.kind = "method"; method.kind = "method";
method.computed = false; method.computed = false;
method.key = key; method.key = key;
@ -1268,22 +1265,34 @@ export default class StatementParser extends ExpressionParser {
/* isConstructor */ false, /* isConstructor */ false,
false, false,
); );
return; return true;
} else if (this.isClassProperty()) { } else if (this.isClassProperty()) {
const prop: N.ClassProperty = (member: any); const prop: N.ClassProperty = (member: any);
// a property named 'static' // a property named like the modifier
prop.computed = false; prop.computed = false;
prop.key = key; prop.key = key;
prop.static = false; prop.static = false;
classBody.body.push(this.parseClassProperty(prop)); classBody.body.push(this.parseClassProperty(prop));
return; return true;
} else if (containsEsc) { } else if (containsEsc) {
throw this.unexpected(); throw this.unexpected();
} }
// otherwise something static return false;
isStatic = true; }
parseClassMember(
classBody: N.ClassBody,
member: N.ClassMember,
state: { hadConstructor: boolean },
constructorAllowsSuper: boolean,
): void {
const isStatic = this.isContextual("static");
if (isStatic && this.parseClassMemberFromModifier(classBody, member)) {
// a class element named 'static'
return;
} }
this.parseClassMemberWithIsStatic( this.parseClassMemberWithIsStatic(

37
packages/babel-parser/src/plugins/flow.js
View File

@ -51,6 +51,10 @@ const FlowErrors = Object.freeze({
AmbiguousDeclareModuleKind: AmbiguousDeclareModuleKind:
"Found both `declare module.exports` and `declare export` in the same module. Modules can only have 1 since they are either an ES module or they are a CommonJS module", "Found both `declare module.exports` and `declare export` in the same module. Modules can only have 1 since they are either an ES module or they are a CommonJS module",
AssignReservedType: "Cannot overwrite reserved type %0", AssignReservedType: "Cannot overwrite reserved type %0",
DeclareClassElement:
"The `declare` modifier can only appear on class fields.",
DeclareClassFieldInitializer:
"Initializers are not allowed in fields with the `declare` modifier.",
DuplicateDeclareModuleExports: "Duplicate `declare module.exports` statement", DuplicateDeclareModuleExports: "Duplicate `declare module.exports` statement",
EnumBooleanMemberNotInitialized: EnumBooleanMemberNotInitialized:
"Boolean enum members need to be initialized. Use either `%0 = true,` or `%0 = false,` in enum `%1`.", "Boolean enum members need to be initialized. Use either `%0 = true,` or `%0 = false,` in enum `%1`.",
@ -2085,6 +2089,39 @@ export default (superClass: Class<Parser>): Class<Parser> =>
} }
} }
parseClassMember(
classBody: N.ClassBody,
member: any,
state: { hadConstructor: boolean },
constructorAllowsSuper: boolean,
): void {
const pos = this.state.start;
if (this.isContextual("declare")) {
if (this.parseClassMemberFromModifier(classBody, member)) {
// 'declare' is a class element name
return;
}
member.declare = true;
}
super.parseClassMember(classBody, member, state, constructorAllowsSuper);
if (member.declare) {
if (
member.type !== "ClassProperty" &&
member.type !== "ClassPrivateProperty"
) {
this.raise(pos, FlowErrors.DeclareClassElement);
} else if (member.value) {
this.raise(
member.value.start,
FlowErrors.DeclareClassFieldInitializer,
);
}
}
}
// ensure that inside flow types, we bypass the jsx parser plugin // ensure that inside flow types, we bypass the jsx parser plugin
getTokenFromCode(code: number): void { getTokenFromCode(code: number): void {
const next = this.input.charCodeAt(this.state.pos + 1); const next = this.input.charCodeAt(this.state.pos + 1);

3
packages/babel-parser/test/fixtures/flow/class-private-property/declare-field-initializer/input.js vendored Normal file
View File

@ -0,0 +1,3 @@
class A {
declare #foo = 2
}

158
packages/babel-parser/test/fixtures/flow/class-private-property/declare-field-initializer/output.json vendored Normal file
View File

@ -0,0 +1,158 @@
{
"type": "File",
"start": 0,
"end": 30,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"errors": [
"SyntaxError: Initializers are not allowed in fields with the `declare` modifier. (2:17)"
],
"program": {
"type": "Program",
"start": 0,
"end": 30,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"sourceType": "module",
"interpreter": null,
"body": [
{
"type": "ClassDeclaration",
"start": 0,
"end": 30,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"id": {
"type": "Identifier",
"start": 6,
"end": 7,
"loc": {
"start": {
"line": 1,
"column": 6
},
"end": {
"line": 1,
"column": 7
},
"identifierName": "A"
},
"name": "A"
},
"superClass": null,
"body": {
"type": "ClassBody",
"start": 8,
"end": 30,
"loc": {
"start": {
"line": 1,
"column": 8
},
"end": {
"line": 3,
"column": 1
}
},
"body": [
{
"type": "ClassPrivateProperty",
"start": 12,
"end": 28,
"loc": {
"start": {
"line": 2,
"column": 2
},
"end": {
"line": 2,
"column": 18
}
},
"declare": true,
"static": false,
"key": {
"type": "PrivateName",
"start": 20,
"end": 24,
"loc": {
"start": {
"line": 2,
"column": 10
},
"end": {
"line": 2,
"column": 14
}
},
"id": {
"type": "Identifier",
"start": 21,
"end": 24,
"loc": {
"start": {
"line": 2,
"column": 11
},
"end": {
"line": 2,
"column": 14
},
"identifierName": "foo"
},
"name": "foo"
}
},
"variance": null,
"value": {
"type": "NumericLiteral",
"start": 27,
"end": 28,
"loc": {
"start": {
"line": 2,
"column": 17
},
"end": {
"line": 2,
"column": 18
}
},
"extra": {
"rawValue": 2,
"raw": "2"
},
"value": 2
}
}
]
}
}
],
"directives": []
}
}

3
packages/babel-parser/test/fixtures/flow/class-private-property/declare-field/input.js vendored Normal file
View File

@ -0,0 +1,3 @@
class A {
declare #foo
}

136
packages/babel-parser/test/fixtures/flow/class-private-property/declare-field/output.json vendored Normal file
View File

@ -0,0 +1,136 @@
{
"type": "File",
"start": 0,
"end": 26,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"program": {
"type": "Program",
"start": 0,
"end": 26,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"sourceType": "module",
"interpreter": null,
"body": [
{
"type": "ClassDeclaration",
"start": 0,
"end": 26,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"id": {
"type": "Identifier",
"start": 6,
"end": 7,
"loc": {
"start": {
"line": 1,
"column": 6
},
"end": {
"line": 1,
"column": 7
},
"identifierName": "A"
},
"name": "A"
},
"superClass": null,
"body": {
"type": "ClassBody",
"start": 8,
"end": 26,
"loc": {
"start": {
"line": 1,
"column": 8
},
"end": {
"line": 3,
"column": 1
}
},
"body": [
{
"type": "ClassPrivateProperty",
"start": 12,
"end": 24,
"loc": {
"start": {
"line": 2,
"column": 2
},
"end": {
"line": 2,
"column": 14
}
},
"declare": true,
"static": false,
"key": {
"type": "PrivateName",
"start": 20,
"end": 24,
"loc": {
"start": {
"line": 2,
"column": 10
},
"end": {
"line": 2,
"column": 14
}
},
"id": {
"type": "Identifier",
"start": 21,
"end": 24,
"loc": {
"start": {
"line": 2,
"column": 11
},
"end": {
"line": 2,
"column": 14
},
"identifierName": "foo"
},
"name": "foo"
}
},
"variance": null,
"value": null
}
]
}
}
],
"directives": []
}
}

3
packages/babel-parser/test/fixtures/flow/class-private-property/declare-method/input.js vendored Normal file
View File

@ -0,0 +1,3 @@
class A {
declare #foo() {}
}

8
packages/babel-parser/test/fixtures/flow/class-private-property/declare-method/options.json vendored Normal file
View File

@ -0,0 +1,8 @@
{
"sourceType": "module",
"plugins": [
"flow",
"classPrivateProperties",
"classPrivateMethods"
]
}

159
packages/babel-parser/test/fixtures/flow/class-private-property/declare-method/output.json vendored Normal file
View File

@ -0,0 +1,159 @@
{
"type": "File",
"start": 0,
"end": 31,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"errors": [
"SyntaxError: The `declare` modifier can only appear on class fields. (2:2)"
],
"program": {
"type": "Program",
"start": 0,
"end": 31,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"sourceType": "module",
"interpreter": null,
"body": [
{
"type": "ClassDeclaration",
"start": 0,
"end": 31,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"id": {
"type": "Identifier",
"start": 6,
"end": 7,
"loc": {
"start": {
"line": 1,
"column": 6
},
"end": {
"line": 1,
"column": 7
},
"identifierName": "A"
},
"name": "A"
},
"superClass": null,
"body": {
"type": "ClassBody",
"start": 8,
"end": 31,
"loc": {
"start": {
"line": 1,
"column": 8
},
"end": {
"line": 3,
"column": 1
}
},
"body": [
{
"type": "ClassPrivateMethod",
"start": 12,
"end": 29,
"loc": {
"start": {
"line": 2,
"column": 2
},
"end": {
"line": 2,
"column": 19
}
},
"declare": true,
"static": false,
"key": {
"type": "PrivateName",
"start": 20,
"end": 24,
"loc": {
"start": {
"line": 2,
"column": 10
},
"end": {
"line": 2,
"column": 14
}
},
"id": {
"type": "Identifier",
"start": 21,
"end": 24,
"loc": {
"start": {
"line": 2,
"column": 11
},
"end": {
"line": 2,
"column": 14
},
"identifierName": "foo"
},
"name": "foo"
}
},
"kind": "method",
"id": null,
"generator": false,
"async": false,
"params": [],
"body": {
"type": "BlockStatement",
"start": 27,
"end": 29,
"loc": {
"start": {
"line": 2,
"column": 17
},
"end": {
"line": 2,
"column": 19
}
},
"body": [],
"directives": []
}
}
]
}
}
],
"directives": []
}
}

3
packages/babel-parser/test/fixtures/flow/class-properties/declare-after-decorators/input.js vendored Normal file
View File

@ -0,0 +1,3 @@
class A {
@dec declare foo
}

8
packages/babel-parser/test/fixtures/flow/class-properties/declare-after-decorators/options.json vendored Normal file
View File

@ -0,0 +1,8 @@
{
"sourceType": "module",
"plugins": [
"flow",
"classProperties",
["decorators", { "decoratorsBeforeExport": false }]
]
}

156
packages/babel-parser/test/fixtures/flow/class-properties/declare-after-decorators/output.json vendored Normal file
View File

@ -0,0 +1,156 @@
{
"type": "File",
"start": 0,
"end": 30,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"program": {
"type": "Program",
"start": 0,
"end": 30,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"sourceType": "module",
"interpreter": null,
"body": [
{
"type": "ClassDeclaration",
"start": 0,
"end": 30,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"id": {
"type": "Identifier",
"start": 6,
"end": 7,
"loc": {
"start": {
"line": 1,
"column": 6
},
"end": {
"line": 1,
"column": 7
},
"identifierName": "A"
},
"name": "A"
},
"superClass": null,
"body": {
"type": "ClassBody",
"start": 8,
"end": 30,
"loc": {
"start": {
"line": 1,
"column": 8
},
"end": {
"line": 3,
"column": 1
}
},
"body": [
{
"type": "ClassProperty",
"start": 12,
"end": 28,
"loc": {
"start": {
"line": 2,
"column": 2
},
"end": {
"line": 2,
"column": 18
}
},
"decorators": [
{
"type": "Decorator",
"start": 12,
"end": 16,
"loc": {
"start": {
"line": 2,
"column": 2
},
"end": {
"line": 2,
"column": 6
}
},
"expression": {
"type": "Identifier",
"start": 13,
"end": 16,
"loc": {
"start": {
"line": 2,
"column": 3
},
"end": {
"line": 2,
"column": 6
},
"identifierName": "dec"
},
"name": "dec"
}
}
],
"declare": true,
"static": false,
"key": {
"type": "Identifier",
"start": 25,
"end": 28,
"loc": {
"start": {
"line": 2,
"column": 15
},
"end": {
"line": 2,
"column": 18
},
"identifierName": "foo"
},
"name": "foo"
},
"computed": false,
"variance": null,
"value": null
}
]
}
}
],
"directives": []
}
}

3
packages/babel-parser/test/fixtures/flow/class-properties/declare-before-decorators/input.js vendored Normal file
View File

@ -0,0 +1,3 @@
class A {
declare @dec foo
}

9
packages/babel-parser/test/fixtures/flow/class-properties/declare-before-decorators/options.json vendored Normal file
View File

@ -0,0 +1,9 @@
{
"sourceType": "module",
"plugins": [
"flow",
"classProperties",
["decorators", { "decoratorsBeforeExport": false }]
],
"throws": "Unexpected token (2:10)"
}

3
packages/babel-parser/test/fixtures/flow/class-properties/declare-constructor/input.js vendored Normal file
View File

@ -0,0 +1,3 @@
class A {
declare constructor() {}
}

145
packages/babel-parser/test/fixtures/flow/class-properties/declare-constructor/output.json vendored Normal file
View File

@ -0,0 +1,145 @@
{
"type": "File",
"start": 0,
"end": 38,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"errors": [
"SyntaxError: The `declare` modifier can only appear on class fields. (2:2)"
],
"program": {
"type": "Program",
"start": 0,
"end": 38,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"sourceType": "module",
"interpreter": null,
"body": [
{
"type": "ClassDeclaration",
"start": 0,
"end": 38,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"id": {
"type": "Identifier",
"start": 6,
"end": 7,
"loc": {
"start": {
"line": 1,
"column": 6
},
"end": {
"line": 1,
"column": 7
},
"identifierName": "A"
},
"name": "A"
},
"superClass": null,
"body": {
"type": "ClassBody",
"start": 8,
"end": 38,
"loc": {
"start": {
"line": 1,
"column": 8
},
"end": {
"line": 3,
"column": 1
}
},
"body": [
{
"type": "ClassMethod",
"start": 12,
"end": 36,
"loc": {
"start": {
"line": 2,
"column": 2
},
"end": {
"line": 2,
"column": 26
}
},
"declare": true,
"static": false,
"key": {
"type": "Identifier",
"start": 20,
"end": 31,
"loc": {
"start": {
"line": 2,
"column": 10
},
"end": {
"line": 2,
"column": 21
},
"identifierName": "constructor"
},
"name": "constructor"
},
"computed": false,
"kind": "constructor",
"id": null,
"generator": false,
"async": false,
"params": [],
"body": {
"type": "BlockStatement",
"start": 34,
"end": 36,
"loc": {
"start": {
"line": 2,
"column": 24
},
"end": {
"line": 2,
"column": 26
}
},
"body": [],
"directives": []
}
}
]
}
}
],
"directives": []
}
}

3
packages/babel-parser/test/fixtures/flow/class-properties/declare-field-computed/input.js vendored Normal file
View File

@ -0,0 +1,3 @@
class A {
declare [foo]
}

122
packages/babel-parser/test/fixtures/flow/class-properties/declare-field-computed/output.json vendored Normal file
View File

@ -0,0 +1,122 @@
{
"type": "File",
"start": 0,
"end": 27,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"program": {
"type": "Program",
"start": 0,
"end": 27,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"sourceType": "module",
"interpreter": null,
"body": [
{
"type": "ClassDeclaration",
"start": 0,
"end": 27,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"id": {
"type": "Identifier",
"start": 6,
"end": 7,
"loc": {
"start": {
"line": 1,
"column": 6
},
"end": {
"line": 1,
"column": 7
},
"identifierName": "A"
},
"name": "A"
},
"superClass": null,
"body": {
"type": "ClassBody",
"start": 8,
"end": 27,
"loc": {
"start": {
"line": 1,
"column": 8
},
"end": {
"line": 3,
"column": 1
}
},
"body": [
{
"type": "ClassProperty",
"start": 12,
"end": 25,
"loc": {
"start": {
"line": 2,
"column": 2
},
"end": {
"line": 2,
"column": 15
}
},
"declare": true,
"static": false,
"computed": true,
"key": {
"type": "Identifier",
"start": 21,
"end": 24,
"loc": {
"start": {
"line": 2,
"column": 11
},
"end": {
"line": 2,
"column": 14
},
"identifierName": "foo"
},
"name": "foo"
},
"variance": null,
"value": null
}
]
}
}
],
"directives": []
}
}

3
packages/babel-parser/test/fixtures/flow/class-properties/declare-field-initializer/input.js vendored Normal file
View File

@ -0,0 +1,3 @@
class A {
declare foo = 2
}

144
packages/babel-parser/test/fixtures/flow/class-properties/declare-field-initializer/output.json vendored Normal file
View File

@ -0,0 +1,144 @@
{
"type": "File",
"start": 0,
"end": 29,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"errors": [
"SyntaxError: Initializers are not allowed in fields with the `declare` modifier. (2:16)"
],
"program": {
"type": "Program",
"start": 0,
"end": 29,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"sourceType": "module",
"interpreter": null,
"body": [
{
"type": "ClassDeclaration",
"start": 0,
"end": 29,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"id": {
"type": "Identifier",
"start": 6,
"end": 7,
"loc": {
"start": {
"line": 1,
"column": 6
},
"end": {
"line": 1,
"column": 7
},
"identifierName": "A"
},
"name": "A"
},
"superClass": null,
"body": {
"type": "ClassBody",
"start": 8,
"end": 29,
"loc": {
"start": {
"line": 1,
"column": 8
},
"end": {
"line": 3,
"column": 1
}
},
"body": [
{
"type": "ClassProperty",
"start": 12,
"end": 27,
"loc": {
"start": {
"line": 2,
"column": 2
},
"end": {
"line": 2,
"column": 17
}
},
"declare": true,
"static": false,
"key": {
"type": "Identifier",
"start": 20,
"end": 23,
"loc": {
"start": {
"line": 2,
"column": 10
},
"end": {
"line": 2,
"column": 13
},
"identifierName": "foo"
},
"name": "foo"
},
"computed": false,
"variance": null,
"value": {
"type": "NumericLiteral",
"start": 26,
"end": 27,
"loc": {
"start": {
"line": 2,
"column": 16
},
"end": {
"line": 2,
"column": 17
}
},
"extra": {
"rawValue": 2,
"raw": "2"
},
"value": 2
}
}
]
}
}
],
"directives": []
}
}

3
packages/babel-parser/test/fixtures/flow/class-properties/declare-field-named-static/input.js vendored Normal file
View File

@ -0,0 +1,3 @@
class A {
declare static
}

121
packages/babel-parser/test/fixtures/flow/class-properties/declare-field-named-static/output.json vendored Normal file
View File

@ -0,0 +1,121 @@
{
"type": "File",
"start": 0,
"end": 28,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"program": {
"type": "Program",
"start": 0,
"end": 28,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"sourceType": "module",
"interpreter": null,
"body": [
{
"type": "ClassDeclaration",
"start": 0,
"end": 28,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"id": {
"type": "Identifier",
"start": 6,
"end": 7,
"loc": {
"start": {
"line": 1,
"column": 6
},
"end": {
"line": 1,
"column": 7
},
"identifierName": "A"
},
"name": "A"
},
"superClass": null,
"body": {
"type": "ClassBody",
"start": 8,
"end": 28,
"loc": {
"start": {
"line": 1,
"column": 8
},
"end": {
"line": 3,
"column": 1
}
},
"body": [
{
"type": "ClassProperty",
"start": 12,
"end": 26,
"loc": {
"start": {
"line": 2,
"column": 2
},
"end": {
"line": 2,
"column": 16
}
},
"declare": true,
"computed": false,
"key": {
"type": "Identifier",
"start": 20,
"end": 26,
"loc": {
"start": {
"line": 2,
"column": 10
},
"end": {
"line": 2,
"column": 16
},
"identifierName": "static"
},
"name": "static"
},
"static": false,
"value": null
}
]
}
}
],
"directives": []
}
}

3
packages/babel-parser/test/fixtures/flow/class-properties/declare-field-with-type/input.js vendored Normal file
View File

@ -0,0 +1,3 @@
class A {
declare foo: string
}

152
packages/babel-parser/test/fixtures/flow/class-properties/declare-field-with-type/output.json vendored Normal file
View File

@ -0,0 +1,152 @@
{
"type": "File",
"start": 0,
"end": 33,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"program": {
"type": "Program",
"start": 0,
"end": 33,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"sourceType": "module",
"interpreter": null,
"body": [
{
"type": "ClassDeclaration",
"start": 0,
"end": 33,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"id": {
"type": "Identifier",
"start": 6,
"end": 7,
"loc": {
"start": {
"line": 1,
"column": 6
},
"end": {
"line": 1,
"column": 7
},
"identifierName": "A"
},
"name": "A"
},
"superClass": null,
"body": {
"type": "ClassBody",
"start": 8,
"end": 33,
"loc": {
"start": {
"line": 1,
"column": 8
},
"end": {
"line": 3,
"column": 1
}
},
"body": [
{
"type": "ClassProperty",
"start": 12,
"end": 31,
"loc": {
"start": {
"line": 2,
"column": 2
},
"end": {
"line": 2,
"column": 21
}
},
"declare": true,
"static": false,
"key": {
"type": "Identifier",
"start": 20,
"end": 23,
"loc": {
"start": {
"line": 2,
"column": 10
},
"end": {
"line": 2,
"column": 13
},
"identifierName": "foo"
},
"name": "foo"
},
"computed": false,
"variance": null,
"typeAnnotation": {
"type": "TypeAnnotation",
"start": 23,
"end": 31,
"loc": {
"start": {
"line": 2,
"column": 13
},
"end": {
"line": 2,
"column": 21
}
},
"typeAnnotation": {
"type": "StringTypeAnnotation",
"start": 25,
"end": 31,
"loc": {
"start": {
"line": 2,
"column": 15
},
"end": {
"line": 2,
"column": 21
}
}
}
},
"value": null
}
]
}
}
],
"directives": []
}
}

3
packages/babel-parser/test/fixtures/flow/class-properties/declare-field/input.js vendored Normal file
View File

@ -0,0 +1,3 @@
class A {
declare foo
}

122
packages/babel-parser/test/fixtures/flow/class-properties/declare-field/output.json vendored Normal file
View File

@ -0,0 +1,122 @@
{
"type": "File",
"start": 0,
"end": 25,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"program": {
"type": "Program",
"start": 0,
"end": 25,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"sourceType": "module",
"interpreter": null,
"body": [
{
"type": "ClassDeclaration",
"start": 0,
"end": 25,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"id": {
"type": "Identifier",
"start": 6,
"end": 7,
"loc": {
"start": {
"line": 1,
"column": 6
},
"end": {
"line": 1,
"column": 7
},
"identifierName": "A"
},
"name": "A"
},
"superClass": null,
"body": {
"type": "ClassBody",
"start": 8,
"end": 25,
"loc": {
"start": {
"line": 1,
"column": 8
},
"end": {
"line": 3,
"column": 1
}
},
"body": [
{
"type": "ClassProperty",
"start": 12,
"end": 23,
"loc": {
"start": {
"line": 2,
"column": 2
},
"end": {
"line": 2,
"column": 13
}
},
"declare": true,
"static": false,
"key": {
"type": "Identifier",
"start": 20,
"end": 23,
"loc": {
"start": {
"line": 2,
"column": 10
},
"end": {
"line": 2,
"column": 13
},
"identifierName": "foo"
},
"name": "foo"
},
"computed": false,
"variance": null,
"value": null
}
]
}
}
],
"directives": []
}
}

3
packages/babel-parser/test/fixtures/flow/class-properties/declare-method/input.js vendored Normal file
View File

@ -0,0 +1,3 @@
class A {
declare foo() {}
}

145
packages/babel-parser/test/fixtures/flow/class-properties/declare-method/output.json vendored Normal file
View File

@ -0,0 +1,145 @@
{
"type": "File",
"start": 0,
"end": 30,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"errors": [
"SyntaxError: The `declare` modifier can only appear on class fields. (2:2)"
],
"program": {
"type": "Program",
"start": 0,
"end": 30,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"sourceType": "module",
"interpreter": null,
"body": [
{
"type": "ClassDeclaration",
"start": 0,
"end": 30,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"id": {
"type": "Identifier",
"start": 6,
"end": 7,
"loc": {
"start": {
"line": 1,
"column": 6
},
"end": {
"line": 1,
"column": 7
},
"identifierName": "A"
},
"name": "A"
},
"superClass": null,
"body": {
"type": "ClassBody",
"start": 8,
"end": 30,
"loc": {
"start": {
"line": 1,
"column": 8
},
"end": {
"line": 3,
"column": 1
}
},
"body": [
{
"type": "ClassMethod",
"start": 12,
"end": 28,
"loc": {
"start": {
"line": 2,
"column": 2
},
"end": {
"line": 2,
"column": 18
}
},
"declare": true,
"static": false,
"key": {
"type": "Identifier",
"start": 20,
"end": 23,
"loc": {
"start": {
"line": 2,
"column": 10
},
"end": {
"line": 2,
"column": 13
},
"identifierName": "foo"
},
"name": "foo"
},
"computed": false,
"kind": "method",
"id": null,
"generator": false,
"async": false,
"params": [],
"body": {
"type": "BlockStatement",
"start": 26,
"end": 28,
"loc": {
"start": {
"line": 2,
"column": 16
},
"end": {
"line": 2,
"column": 18
}
},
"body": [],
"directives": []
}
}
]
}
}
],
"directives": []
}
}

3
packages/babel-parser/test/fixtures/flow/class-properties/declare-static-field/input.js vendored Normal file
View File

@ -0,0 +1,3 @@
class A {
declare static foo
}

122
packages/babel-parser/test/fixtures/flow/class-properties/declare-static-field/output.json vendored Normal file
View File

@ -0,0 +1,122 @@
{
"type": "File",
"start": 0,
"end": 32,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"program": {
"type": "Program",
"start": 0,
"end": 32,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"sourceType": "module",
"interpreter": null,
"body": [
{
"type": "ClassDeclaration",
"start": 0,
"end": 32,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"id": {
"type": "Identifier",
"start": 6,
"end": 7,
"loc": {
"start": {
"line": 1,
"column": 6
},
"end": {
"line": 1,
"column": 7
},
"identifierName": "A"
},
"name": "A"
},
"superClass": null,
"body": {
"type": "ClassBody",
"start": 8,
"end": 32,
"loc": {
"start": {
"line": 1,
"column": 8
},
"end": {
"line": 3,
"column": 1
}
},
"body": [
{
"type": "ClassProperty",
"start": 12,
"end": 30,
"loc": {
"start": {
"line": 2,
"column": 2
},
"end": {
"line": 2,
"column": 20
}
},
"declare": true,
"static": true,
"key": {
"type": "Identifier",
"start": 27,
"end": 30,
"loc": {
"start": {
"line": 2,
"column": 17
},
"end": {
"line": 2,
"column": 20
},
"identifierName": "foo"
},
"name": "foo"
},
"computed": false,
"variance": null,
"value": null
}
]
}
}
],
"directives": []
}
}

3
packages/babel-parser/test/fixtures/flow/class-properties/field-named-declare-with-type/input.js vendored Normal file
View File

@ -0,0 +1,3 @@
class A {
declare: string
}

150
packages/babel-parser/test/fixtures/flow/class-properties/field-named-declare-with-type/output.json vendored Normal file
View File

@ -0,0 +1,150 @@
{
"type": "File",
"start": 0,
"end": 29,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"program": {
"type": "Program",
"start": 0,
"end": 29,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"sourceType": "module",
"interpreter": null,
"body": [
{
"type": "ClassDeclaration",
"start": 0,
"end": 29,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"id": {
"type": "Identifier",
"start": 6,
"end": 7,
"loc": {
"start": {
"line": 1,
"column": 6
},
"end": {
"line": 1,
"column": 7
},
"identifierName": "A"
},
"name": "A"
},
"superClass": null,
"body": {
"type": "ClassBody",
"start": 8,
"end": 29,
"loc": {
"start": {
"line": 1,
"column": 8
},
"end": {
"line": 3,
"column": 1
}
},
"body": [
{
"type": "ClassProperty",
"start": 12,
"end": 27,
"loc": {
"start": {
"line": 2,
"column": 2
},
"end": {
"line": 2,
"column": 17
}
},
"computed": false,
"key": {
"type": "Identifier",
"start": 12,
"end": 19,
"loc": {
"start": {
"line": 2,
"column": 2
},
"end": {
"line": 2,
"column": 9
},
"identifierName": "declare"
},
"name": "declare"
},
"static": false,
"typeAnnotation": {
"type": "TypeAnnotation",
"start": 19,
"end": 27,
"loc": {
"start": {
"line": 2,
"column": 9
},
"end": {
"line": 2,
"column": 17
}
},
"typeAnnotation": {
"type": "StringTypeAnnotation",
"start": 21,
"end": 27,
"loc": {
"start": {
"line": 2,
"column": 11
},
"end": {
"line": 2,
"column": 17
}
}
}
},
"value": null
}
]
}
}
],
"directives": []
}
}

3
packages/babel-parser/test/fixtures/flow/class-properties/field-named-declare/input.js vendored Normal file
View File

@ -0,0 +1,3 @@
class A {
declare
}

120
packages/babel-parser/test/fixtures/flow/class-properties/field-named-declare/output.json vendored Normal file
View File

@ -0,0 +1,120 @@
{
"type": "File",
"start": 0,
"end": 21,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"program": {
"type": "Program",
"start": 0,
"end": 21,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"sourceType": "module",
"interpreter": null,
"body": [
{
"type": "ClassDeclaration",
"start": 0,
"end": 21,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"id": {
"type": "Identifier",
"start": 6,
"end": 7,
"loc": {
"start": {
"line": 1,
"column": 6
},
"end": {
"line": 1,
"column": 7
},
"identifierName": "A"
},
"name": "A"
},
"superClass": null,
"body": {
"type": "ClassBody",
"start": 8,
"end": 21,
"loc": {
"start": {
"line": 1,
"column": 8
},
"end": {
"line": 3,
"column": 1
}
},
"body": [
{
"type": "ClassProperty",
"start": 12,
"end": 19,
"loc": {
"start": {
"line": 2,
"column": 2
},
"end": {
"line": 2,
"column": 9
}
},
"computed": false,
"key": {
"type": "Identifier",
"start": 12,
"end": 19,
"loc": {
"start": {
"line": 2,
"column": 2
},
"end": {
"line": 2,
"column": 9
},
"identifierName": "declare"
},
"name": "declare"
},
"static": false,
"value": null
}
]
}
}
],
"directives": []
}
}

3
packages/babel-parser/test/fixtures/flow/class-properties/method-named-declare/input.js vendored Normal file
View File

@ -0,0 +1,3 @@
class A {
declare() {}
}

141
packages/babel-parser/test/fixtures/flow/class-properties/method-named-declare/output.json vendored Normal file
View File

@ -0,0 +1,141 @@
{
"type": "File",
"start": 0,
"end": 26,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"program": {
"type": "Program",
"start": 0,
"end": 26,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"sourceType": "module",
"interpreter": null,
"body": [
{
"type": "ClassDeclaration",
"start": 0,
"end": 26,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"id": {
"type": "Identifier",
"start": 6,
"end": 7,
"loc": {
"start": {
"line": 1,
"column": 6
},
"end": {
"line": 1,
"column": 7
},
"identifierName": "A"
},
"name": "A"
},
"superClass": null,
"body": {
"type": "ClassBody",
"start": 8,
"end": 26,
"loc": {
"start": {
"line": 1,
"column": 8
},
"end": {
"line": 3,
"column": 1
}
},
"body": [
{
"type": "ClassMethod",
"start": 12,
"end": 24,
"loc": {
"start": {
"line": 2,
"column": 2
},
"end": {
"line": 2,
"column": 14
}
},
"kind": "method",
"computed": false,
"key": {
"type": "Identifier",
"start": 12,
"end": 19,
"loc": {
"start": {
"line": 2,
"column": 2
},
"end": {
"line": 2,
"column": 9
},
"identifierName": "declare"
},
"name": "declare"
},
"static": false,
"id": null,
"generator": false,
"async": false,
"params": [],
"body": {
"type": "BlockStatement",
"start": 22,
"end": 24,
"loc": {
"start": {
"line": 2,
"column": 12
},
"end": {
"line": 2,
"column": 14
}
},
"body": [],
"directives": []
}
}
]
}
}
],
"directives": []
}
}

4
packages/babel-parser/test/fixtures/flow/class-properties/options.json vendored Normal file
View File

@ -0,0 +1,4 @@
{
"sourceType": "module",
"plugins": ["flow", "classProperties"]
}

3
packages/babel-parser/test/fixtures/flow/class-properties/static-declare-field/input.js vendored Normal file
View File

@ -0,0 +1,3 @@
class A {
static declare foo
}

3
packages/babel-parser/test/fixtures/flow/class-properties/static-declare-field/options.json vendored Normal file
View File

@ -0,0 +1,3 @@
{
"throws": "Unexpected token (2:17)"
}

3
packages/babel-parser/test/fixtures/flow/class-properties/static-field-named-declare/input.js vendored Normal file
View File

@ -0,0 +1,3 @@
class A {
static declare
}

121
packages/babel-parser/test/fixtures/flow/class-properties/static-field-named-declare/output.json vendored Normal file
View File

@ -0,0 +1,121 @@
{
"type": "File",
"start": 0,
"end": 28,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"program": {
"type": "Program",
"start": 0,
"end": 28,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"sourceType": "module",
"interpreter": null,
"body": [
{
"type": "ClassDeclaration",
"start": 0,
"end": 28,
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 3,
"column": 1
}
},
"id": {
"type": "Identifier",
"start": 6,
"end": 7,
"loc": {
"start": {
"line": 1,
"column": 6
},
"end": {
"line": 1,
"column": 7
},
"identifierName": "A"
},
"name": "A"
},
"superClass": null,
"body": {
"type": "ClassBody",
"start": 8,
"end": 28,
"loc": {
"start": {
"line": 1,
"column": 8
},
"end": {
"line": 3,
"column": 1
}
},
"body": [
{
"type": "ClassProperty",
"start": 12,
"end": 26,
"loc": {
"start": {
"line": 2,
"column": 2
},
"end": {
"line": 2,
"column": 16
}
},
"static": true,
"key": {
"type": "Identifier",
"start": 19,
"end": 26,
"loc": {
"start": {
"line": 2,
"column": 9
},
"end": {
"line": 2,
"column": 16
},
"identifierName": "declare"
},
"name": "declare"
},
"computed": false,
"variance": null,
"value": null
}
]
}
}
],
"directives": []
}
}

35
packages/babel-plugin-transform-flow-strip-types/src/index.js
View File

@ -2,13 +2,15 @@ import { declare } from "@babel/helper-plugin-utils";
import syntaxFlow from "@babel/plugin-syntax-flow"; import syntaxFlow from "@babel/plugin-syntax-flow";
import { types as t } from "@babel/core"; import { types as t } from "@babel/core";
export default declare(api => { export default declare((api, opts) => {
api.assertVersion(7); api.assertVersion(7);
const FLOW_DIRECTIVE = /(@flow(\s+(strict(-local)?|weak))?|@noflow)/; const FLOW_DIRECTIVE = /(@flow(\s+(strict(-local)?|weak))?|@noflow)/;
let skipStrip = false; let skipStrip = false;
const { requireDirective = false, allowDeclareFields = false } = opts;
return { return {
name: "transform-flow-strip-types", name: "transform-flow-strip-types",
inherits: syntaxFlow, inherits: syntaxFlow,
@ -20,7 +22,6 @@ export default declare(api => {
file: { file: {
ast: { comments }, ast: { comments },
}, },
opts,
}, },
) { ) {
skipStrip = false; skipStrip = false;
@ -42,7 +43,7 @@ export default declare(api => {
} }
} }
if (!directiveFound && opts.requireDirective) { if (!directiveFound && requireDirective) {
skipStrip = true; skipStrip = true;
} }
}, },
@ -74,13 +75,6 @@ export default declare(api => {
path.remove(); path.remove();
}, },
ClassProperty(path) {
if (skipStrip) return;
path.node.variance = null;
path.node.typeAnnotation = null;
if (!path.node.value) path.remove();
},
ClassPrivateProperty(path) { ClassPrivateProperty(path) {
if (skipStrip) return; if (skipStrip) return;
path.node.typeAnnotation = null; path.node.typeAnnotation = null;
@ -94,8 +88,25 @@ export default declare(api => {
// would transform the class before we reached the class property. // would transform the class before we reached the class property.
path.get("body.body").forEach(child => { path.get("body.body").forEach(child => {
if (child.isClassProperty()) { if (child.isClassProperty()) {
child.node.typeAnnotation = null; const { node } = child;
if (!child.node.value) child.remove();
if (!allowDeclareFields && node.declare) {
throw child.buildCodeFrameError(
`The 'declare' modifier is only allowed when the ` +
`'allowDeclareFields' option of ` +
`@babel/plugin-transform-flow-strip-types or ` +
`@babel/preset-flow is enabled.`,
);
}
if (node.declare) {
child.remove();
} else if (!allowDeclareFields && !node.value && !node.decorators) {
child.remove();
} else {
node.variance = null;
node.typeAnnotation = null;
}
} }
}); });
}, },

3
packages/babel-plugin-transform-flow-strip-types/test/fixtures/class/declare-not-enabled/input.js vendored Normal file
View File

@ -0,0 +1,3 @@
class A {
declare x;
}

7
packages/babel-plugin-transform-flow-strip-types/test/fixtures/class/declare-not-enabled/options.json vendored Normal file
View File

@ -0,0 +1,7 @@
{
"plugins": [
"transform-flow-strip-types",
"syntax-class-properties"
],
"throws": "The 'declare' modifier is only allowed when the 'allowDeclareFields' option of @babel/plugin-transform-flow-strip-types or @babel/preset-flow is enabled."
}

3
packages/babel-plugin-transform-flow-strip-types/test/fixtures/class/declare/input.js vendored Normal file
View File

@ -0,0 +1,3 @@
class A {
declare x;
}

6
packages/babel-plugin-transform-flow-strip-types/test/fixtures/class/declare/options.json vendored Normal file
View File

@ -0,0 +1,6 @@
{
"plugins": [
["transform-flow-strip-types", { "allowDeclareFields": true }],
"syntax-class-properties"
]
}

1
packages/babel-plugin-transform-flow-strip-types/test/fixtures/class/declare/output.js vendored Normal file
View File

@ -0,0 +1 @@
class A {}

4
packages/babel-preset-flow/src/index.js
View File

@ -1,10 +1,10 @@
import { declare } from "@babel/helper-plugin-utils"; import { declare } from "@babel/helper-plugin-utils";
import transformFlowStripTypes from "@babel/plugin-transform-flow-strip-types"; import transformFlowStripTypes from "@babel/plugin-transform-flow-strip-types";
export default declare((api, { all }) => { export default declare((api, { all, allowDeclareFields }) => {
api.assertVersion(7); api.assertVersion(7);
return { return {
plugins: [[transformFlowStripTypes, { all }]], plugins: [[transformFlowStripTypes, { all, allowDeclareFields }]],
}; };
}); });