Add the 5 modifier jsdoc tags #927
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -105,39 +105,43 @@ func (p *Parser) reparseTags(parent *ast.Node, jsDoc []*ast.Node) { | |||||
| } | ||||||
| switch tag.Kind { | ||||||
| case ast.KindJSDocTypeTag: | ||||||
| switch parent.Kind { | ||||||
| case ast.KindVariableStatement: | ||||||
| if parent.AsVariableStatement().DeclarationList != nil { | ||||||
| for _, declaration := range parent.AsVariableStatement().DeclarationList.AsVariableDeclarationList().Declarations.Nodes { | ||||||
| if declaration.AsVariableDeclaration().Type == nil { | ||||||
| declaration.AsVariableDeclaration().Type = p.makeNewType(tag.AsJSDocTypeTag().TypeExpression, declaration) | ||||||
| break | ||||||
| } | ||||||
| } | ||||||
| } | ||||||
| case ast.KindVariableDeclaration: | ||||||
| if parent.AsVariableDeclaration().Type == nil { | ||||||
| parent.AsVariableDeclaration().Type = p.makeNewType(tag.AsJSDocTypeTag().TypeExpression, parent) | ||||||
| } | ||||||
| case ast.KindPropertyDeclaration: | ||||||
| declaration := parent.AsPropertyDeclaration() | ||||||
| if declaration.Type == nil { | ||||||
| declaration.Type = p.makeNewType(tag.AsJSDocTypeTag().TypeExpression, parent) | ||||||
| } | ||||||
| case ast.KindPropertyAssignment: | ||||||
| prop := parent.AsPropertyAssignment() | ||||||
| prop.Initializer = p.makeNewTypeAssertion(p.makeNewType(tag.AsJSDocTypeTag().TypeExpression, nil), prop.Initializer) | ||||||
| case ast.KindExportAssignment: | ||||||
| export := parent.AsExportAssignment() | ||||||
| export.Expression = p.makeNewTypeAssertion(p.makeNewType(tag.AsJSDocTypeTag().TypeExpression, nil), export.Expression) | ||||||
| case ast.KindReturnStatement: | ||||||
| ret := parent.AsReturnStatement() | ||||||
| ret.Expression = p.makeNewTypeAssertion(p.makeNewType(tag.AsJSDocTypeTag().TypeExpression, nil), ret.Expression) | ||||||
| case ast.KindParenthesizedExpression: | ||||||
| paren := parent.AsParenthesizedExpression() | ||||||
| paren.Expression = p.makeNewTypeAssertion(p.makeNewType(tag.AsJSDocTypeTag().TypeExpression, nil), paren.Expression) | ||||||
| case ast.KindExpressionStatement: | ||||||
| if parent.AsExpressionStatement().Expression.Kind == ast.KindBinaryExpression { | ||||||
| bin := parent.AsExpressionStatement().Expression.AsBinaryExpression() | ||||||
| if ast.GetAssignmentDeclarationKind(bin) != ast.JSDeclarationKindNone { | ||||||
| bin.Right = p.makeNewTypeAssertion(p.makeNewType(tag.AsJSDocTypeTag().TypeExpression, nil), bin.Right) | ||||||
| } | ||||||
| } | ||||||
| } | ||||||
| case ast.KindJSDocTemplateTag: | ||||||
|
|
@@ -178,6 +182,39 @@ func (p *Parser) reparseTags(parent *ast.Node, jsDoc []*ast.Node) { | |||||
| fun.FunctionLikeData().Type = p.makeNewType(tag.AsJSDocReturnTag().TypeExpression, fun) | ||||||
| } | ||||||
| } | ||||||
| case ast.KindJSDocReadonlyTag, ast.KindJSDocPrivateTag, ast.KindJSDocPublicTag, ast.KindJSDocProtectedTag, ast.KindJSDocOverrideTag: | ||||||
| switch parent.Kind { | ||||||
| case ast.KindPropertyDeclaration, ast.KindMethodDeclaration, ast.KindGetAccessor, ast.KindSetAccessor: | ||||||
| // !!! BinaryExpression (this.p assignments) | ||||||
|
There was a problem hiding this comment. [nitpick] Consider implementing handling for BinaryExpression parent nodes (e.g.
Suggested change
Copilot uses AI. Check for mistakes. There was a problem hiding this comment. I can't implement handling until I decide how to store modifiers for |
||||||
| var keyword ast.Kind | ||||||
| switch tag.Kind { | ||||||
| case ast.KindJSDocReadonlyTag: | ||||||
| keyword = ast.KindReadonlyKeyword | ||||||
| case ast.KindJSDocPrivateTag: | ||||||
| keyword = ast.KindPrivateKeyword | ||||||
| case ast.KindJSDocPublicTag: | ||||||
| keyword = ast.KindPublicKeyword | ||||||
| case ast.KindJSDocProtectedTag: | ||||||
| keyword = ast.KindProtectedKeyword | ||||||
| case ast.KindJSDocOverrideTag: | ||||||
| keyword = ast.KindOverrideKeyword | ||||||
| } | ||||||
| modifier := p.factory.NewModifier(keyword) | ||||||
| modifier.Loc = tag.Loc | ||||||
| modifier.Flags = p.contextFlags | ast.NodeFlagsReparsed | ||||||
| var nodes []*ast.Node | ||||||
| var loc core.TextRange | ||||||
| if parent.Modifiers() == nil { | ||||||
| nodes = p.nodeSlicePool.NewSlice(1) | ||||||
| nodes[0] = modifier | ||||||
| loc = tag.Loc | ||||||
| } else { | ||||||
| nodes = append(parent.Modifiers().Nodes, modifier) | ||||||
| loc = parent.Modifiers().Loc | ||||||
| } | ||||||
| parent.AsMutable().SetModifiers(p.newModifierList(loc, nodes)) | ||||||
|
There was a problem hiding this comment. Does this ever happen on any parent kind, or is there a specific subset of nodes that do this? I'm not entirely certain how I feel about the There was a problem hiding this comment. It is the 5 node kinds you see here (including BinaryExpression), unless I missed 1 or 2. Would you prefer a specific SetModifiers on those types? There was a problem hiding this comment. In a way I think it'd be fine to just have a top level ast package function with a switch case in it; just wasn't sure if it was that simple or if the method dispatch here was simplifying things. There was a problem hiding this comment. It is the 5 you see here: class members and expando class members. Based on experience, I predict were going to need this to generalise someday, but definitely not today. |
||||||
| } | ||||||
| // !!! @extends, @implements, @this, @satisfies | ||||||
| } | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| jsdocAccessibilityTag.js(50,14): error TS2341: Property 'priv' is private and only accessible within class 'A'. | ||
| jsdocAccessibilityTag.js(58,9): error TS2341: Property 'priv' is private and only accessible within class 'A'. | ||
| jsdocAccessibilityTag.js(58,24): error TS2445: Property 'prot' is protected and only accessible within class 'A' and its subclasses. | ||
| jsdocAccessibilityTag.js(59,9): error TS2341: Property 'priv' is private and only accessible within class 'A'. | ||
| jsdocAccessibilityTag.js(59,24): error TS2445: Property 'prot' is protected and only accessible within class 'A' and its subclasses. | ||
|
|
||
|
|
||
| ==== jsdocAccessibilityTag.js (5 errors) ==== | ||
| class A { | ||
| /** | ||
| * Ap docs | ||
| * | ||
| * @private | ||
| */ | ||
| priv = 4; | ||
| /** | ||
| * Aq docs | ||
| * | ||
| * @protected | ||
| */ | ||
| prot = 5; | ||
| /** | ||
| * Ar docs | ||
| * | ||
| * @public | ||
| */ | ||
| pub = 6; | ||
| /** @public */ | ||
| get ack() { return this.priv } | ||
| /** @private */ | ||
| set ack(value) { } | ||
| } | ||
| class C { | ||
| constructor() { | ||
| /** | ||
| * Cp docs | ||
| * | ||
| * @private | ||
| */ | ||
| this.priv2 = 1; | ||
| /** | ||
| * Cq docs | ||
| * | ||
| * @protected | ||
| */ | ||
| this.prot2 = 2; | ||
| /** | ||
| * Cr docs | ||
| * | ||
| * @public | ||
| */ | ||
| this.pub2 = 3; | ||
| } | ||
| h() { return this.priv2 } | ||
| } | ||
| class B extends A { | ||
| m() { | ||
| this.priv + this.prot + this.pub | ||
| ~~~~ | ||
| !!! error TS2341: Property 'priv' is private and only accessible within class 'A'. | ||
| } | ||
| } | ||
| class D extends C { | ||
| n() { | ||
| this.priv2 + this.prot2 + this.pub2 | ||
| } | ||
| } | ||
| new A().priv + new A().prot + new A().pub | ||
| ~~~~ | ||
| !!! error TS2341: Property 'priv' is private and only accessible within class 'A'. | ||
| ~~~~ | ||
| !!! error TS2445: Property 'prot' is protected and only accessible within class 'A' and its subclasses. | ||
| new B().priv + new B().prot + new B().pub | ||
| ~~~~ | ||
| !!! error TS2341: Property 'priv' is private and only accessible within class 'A'. | ||
| ~~~~ | ||
| !!! error TS2445: Property 'prot' is protected and only accessible within class 'A' and its subclasses. | ||
| new C().priv2 + new C().prot2 + new C().pub2 | ||
| new D().priv2 + new D().prot2 + new D().pub2 | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is a drive-by reformat. As usual, best reviewed ignoring whitespace.