Skip to content

Consume leading docblock *s #740

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Consume leading docblock *s #740

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions TypeScript.YAML-tmLanguage
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2671,7 +2671,11 @@ repository:
endCaptures:
'0': { name: punctuation.definition.comment.ts }
patterns:
- include: '#docblock'
- contentName: comment.block.documentation.body.ts
begin: (?<=/\*\*)([^*]|\*(?!/))*$
while: (^|\G)\s*\*(?!/)(?=([^*]|[*](?!/))*$)
Copy link
Member

Choose a reason for hiding this comment

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

The while pattern does not work in sublime and results in error and hence cannot be applied in this repo as it sublime typescript package also uses this grammar.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Unfortunately is no way to implement this without begin/while. I can keep this grammar modification VS Code but it means that other consumers of this grammar (like VS) will not benefit

patterns:
- include: '#docblock'
- name: comment.block.ts
begin: (/\*)(?:\s*((@)internal)(?=\s|(\*/)))?
beginCaptures:
Expand Down Expand Up @@ -3078,9 +3082,6 @@ repository:
jsdoctype:
# {type}
patterns:
# {unclosed
- name: invalid.illegal.type.jsdoc
match: \G{(?:[^}*]|\*[^/}])+$
- contentName: entity.name.type.instance.jsdoc
begin: \G({)
beginCaptures:
Expand Down
21 changes: 13 additions & 8 deletions TypeScript.tmLanguage
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8106,8 +8106,19 @@
<key>patterns</key>
<array>
<dict>
<key>include</key>
<string>#docblock</string>
<key>contentName</key>
<string>comment.block.documentation.body.ts</string>
<key>begin</key>
<string>(?&lt;=/\*\*)([^*]|\*(?!/))*$</string>
<key>while</key>
<string>(^|\G)\s*\*(?!/)(?=([^*]|[*](?!/))*$)</string>
<key>patterns</key>
<array>
<dict>
<key>include</key>
<string>#docblock</string>
</dict>
</array>
</dict>
</array>
</dict>
Expand Down Expand Up @@ -9046,12 +9057,6 @@
<dict>
<key>patterns</key>
<array>
<dict>
<key>name</key>
<string>invalid.illegal.type.jsdoc</string>
<key>match</key>
<string>\G{(?:[^}*]|\*[^/}])+$</string>
</dict>
<dict>
<key>contentName</key>
<string>entity.name.type.instance.jsdoc</string>
Expand Down
21 changes: 13 additions & 8 deletions TypeScriptReact.tmLanguage
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8028,8 +8028,19 @@
<key>patterns</key>
<array>
<dict>
<key>include</key>
<string>#docblock</string>
<key>contentName</key>
<string>comment.block.documentation.body.tsx</string>
<key>begin</key>
<string>(?&lt;=/\*\*)([^*]|\*(?!/))*$</string>
<key>while</key>
<string>(^|\G)\s*\*(?!/)(?=([^*]|[*](?!/))*$)</string>
<key>patterns</key>
<array>
<dict>
<key>include</key>
<string>#docblock</string>
</dict>
</array>
</dict>
</array>
</dict>
Expand Down Expand Up @@ -8968,12 +8979,6 @@
<dict>
<key>patterns</key>
<array>
<dict>
<key>name</key>
<string>invalid.illegal.type.jsdoc</string>
<key>match</key>
<string>\G{(?:[^}*]|\*[^/}])+$</string>
</dict>
<dict>
<key>contentName</key>
<string>entity.name.type.instance.jsdoc</string>
Expand Down
154 changes: 89 additions & 65 deletions tests/baselines/Issue153.baseline.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,27 +99,35 @@ Grammar: TypeScript.tmLanguage
^^^
source.ts comment.block.documentation.ts punctuation.definition.comment.ts
> * A simple 3x3 matrix structure.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
source.ts comment.block.documentation.ts
^^
source.ts comment.block.documentation.ts comment.block.documentation.body.ts
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
source.ts comment.block.documentation.ts comment.block.documentation.body.ts
> *
^^^^
source.ts comment.block.documentation.ts
^^
source.ts comment.block.documentation.ts comment.block.documentation.body.ts
^^
source.ts comment.block.documentation.ts comment.block.documentation.body.ts
> * @export
^^^
source.ts comment.block.documentation.ts
^^
source.ts comment.block.documentation.ts comment.block.documentation.body.ts
^
source.ts comment.block.documentation.ts comment.block.documentation.body.ts
^
source.ts comment.block.documentation.ts storage.type.class.jsdoc punctuation.definition.block.tag.jsdoc
source.ts comment.block.documentation.ts comment.block.documentation.body.ts storage.type.class.jsdoc punctuation.definition.block.tag.jsdoc
^^^^^^
source.ts comment.block.documentation.ts storage.type.class.jsdoc
source.ts comment.block.documentation.ts comment.block.documentation.body.ts storage.type.class.jsdoc
> * @class Matrix3x3
^^^
source.ts comment.block.documentation.ts
^^
source.ts comment.block.documentation.ts comment.block.documentation.body.ts
^
source.ts comment.block.documentation.ts comment.block.documentation.body.ts
^
source.ts comment.block.documentation.ts storage.type.class.jsdoc punctuation.definition.block.tag.jsdoc
source.ts comment.block.documentation.ts comment.block.documentation.body.ts storage.type.class.jsdoc punctuation.definition.block.tag.jsdoc
^^^^^
source.ts comment.block.documentation.ts storage.type.class.jsdoc
source.ts comment.block.documentation.ts comment.block.documentation.body.ts storage.type.class.jsdoc
^^^^^^^^^^^
source.ts comment.block.documentation.ts
source.ts comment.block.documentation.ts comment.block.documentation.body.ts
> */
^
source.ts comment.block.documentation.ts
Expand Down Expand Up @@ -319,53 +327,61 @@ Grammar: TypeScript.tmLanguage
^^^
source.ts meta.class.ts comment.block.documentation.ts punctuation.definition.comment.ts
> * Gets a column as a new vector.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
source.ts meta.class.ts comment.block.documentation.ts
^^^^^^
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts
> *
^^^^^^^^
source.ts meta.class.ts comment.block.documentation.ts
^^^^^^
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts
^^
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts
> * @param {number} index The index of the column (0 .. 2).
^^^^^^^
source.ts meta.class.ts comment.block.documentation.ts
^^^^^^
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts
^
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts
^
source.ts meta.class.ts comment.block.documentation.ts storage.type.class.jsdoc punctuation.definition.block.tag.jsdoc
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts storage.type.class.jsdoc punctuation.definition.block.tag.jsdoc
^^^^^
source.ts meta.class.ts comment.block.documentation.ts storage.type.class.jsdoc
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts storage.type.class.jsdoc
^
source.ts meta.class.ts comment.block.documentation.ts
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts
^
source.ts meta.class.ts comment.block.documentation.ts entity.name.type.instance.jsdoc punctuation.definition.bracket.curly.begin.jsdoc
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts entity.name.type.instance.jsdoc punctuation.definition.bracket.curly.begin.jsdoc
^^^^^^
source.ts meta.class.ts comment.block.documentation.ts entity.name.type.instance.jsdoc
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts entity.name.type.instance.jsdoc
^
source.ts meta.class.ts comment.block.documentation.ts entity.name.type.instance.jsdoc punctuation.definition.bracket.curly.end.jsdoc
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts entity.name.type.instance.jsdoc punctuation.definition.bracket.curly.end.jsdoc
^
source.ts meta.class.ts comment.block.documentation.ts
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts
^^^^^
source.ts meta.class.ts comment.block.documentation.ts variable.other.jsdoc
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts variable.other.jsdoc
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
source.ts meta.class.ts comment.block.documentation.ts
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts
> * @returns {Vector3} A vector representing the column.
^^^^^^^
source.ts meta.class.ts comment.block.documentation.ts
^^^^^^
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts
^
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts
^
source.ts meta.class.ts comment.block.documentation.ts storage.type.class.jsdoc punctuation.definition.block.tag.jsdoc
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts storage.type.class.jsdoc punctuation.definition.block.tag.jsdoc
^^^^^^^
source.ts meta.class.ts comment.block.documentation.ts storage.type.class.jsdoc
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts storage.type.class.jsdoc
^
source.ts meta.class.ts comment.block.documentation.ts
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts
^
source.ts meta.class.ts comment.block.documentation.ts entity.name.type.instance.jsdoc punctuation.definition.bracket.curly.begin.jsdoc
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts entity.name.type.instance.jsdoc punctuation.definition.bracket.curly.begin.jsdoc
^^^^^^^
source.ts meta.class.ts comment.block.documentation.ts entity.name.type.instance.jsdoc
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts entity.name.type.instance.jsdoc
^
source.ts meta.class.ts comment.block.documentation.ts entity.name.type.instance.jsdoc punctuation.definition.bracket.curly.end.jsdoc
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts entity.name.type.instance.jsdoc punctuation.definition.bracket.curly.end.jsdoc
^
source.ts meta.class.ts comment.block.documentation.ts
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts
^
source.ts meta.class.ts comment.block.documentation.ts
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
source.ts meta.class.ts comment.block.documentation.ts
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts
> */
^^^^^
source.ts meta.class.ts comment.block.documentation.ts
Expand Down Expand Up @@ -697,53 +713,61 @@ Grammar: TypeScript.tmLanguage
^^^
source.ts meta.class.ts comment.block.documentation.ts punctuation.definition.comment.ts
> * Gets a column as a new vector.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
source.ts meta.class.ts comment.block.documentation.ts
^^^^^^
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts
> *
^^^^^^^^
source.ts meta.class.ts comment.block.documentation.ts
^^^^^^
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts
^^
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts
> * @param {number} index The index of the column (0 .. 2).
^^^^^^^
source.ts meta.class.ts comment.block.documentation.ts
^^^^^^
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts
^
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts
^
source.ts meta.class.ts comment.block.documentation.ts storage.type.class.jsdoc punctuation.definition.block.tag.jsdoc
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts storage.type.class.jsdoc punctuation.definition.block.tag.jsdoc
^^^^^
source.ts meta.class.ts comment.block.documentation.ts storage.type.class.jsdoc
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts storage.type.class.jsdoc
^
source.ts meta.class.ts comment.block.documentation.ts
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts
^
source.ts meta.class.ts comment.block.documentation.ts entity.name.type.instance.jsdoc punctuation.definition.bracket.curly.begin.jsdoc
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts entity.name.type.instance.jsdoc punctuation.definition.bracket.curly.begin.jsdoc
^^^^^^
source.ts meta.class.ts comment.block.documentation.ts entity.name.type.instance.jsdoc
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts entity.name.type.instance.jsdoc
^
source.ts meta.class.ts comment.block.documentation.ts entity.name.type.instance.jsdoc punctuation.definition.bracket.curly.end.jsdoc
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts entity.name.type.instance.jsdoc punctuation.definition.bracket.curly.end.jsdoc
^
source.ts meta.class.ts comment.block.documentation.ts
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts
^^^^^
source.ts meta.class.ts comment.block.documentation.ts variable.other.jsdoc
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts variable.other.jsdoc
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
source.ts meta.class.ts comment.block.documentation.ts
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts
> * @returns {Vector3} A vector representing the column.
^^^^^^^
source.ts meta.class.ts comment.block.documentation.ts
^^^^^^
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts
^
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts
^
source.ts meta.class.ts comment.block.documentation.ts storage.type.class.jsdoc punctuation.definition.block.tag.jsdoc
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts storage.type.class.jsdoc punctuation.definition.block.tag.jsdoc
^^^^^^^
source.ts meta.class.ts comment.block.documentation.ts storage.type.class.jsdoc
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts storage.type.class.jsdoc
^
source.ts meta.class.ts comment.block.documentation.ts
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts
^
source.ts meta.class.ts comment.block.documentation.ts entity.name.type.instance.jsdoc punctuation.definition.bracket.curly.begin.jsdoc
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts entity.name.type.instance.jsdoc punctuation.definition.bracket.curly.begin.jsdoc
^^^^^^^
source.ts meta.class.ts comment.block.documentation.ts entity.name.type.instance.jsdoc
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts entity.name.type.instance.jsdoc
^
source.ts meta.class.ts comment.block.documentation.ts entity.name.type.instance.jsdoc punctuation.definition.bracket.curly.end.jsdoc
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts entity.name.type.instance.jsdoc punctuation.definition.bracket.curly.end.jsdoc
^
source.ts meta.class.ts comment.block.documentation.ts
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts
^
source.ts meta.class.ts comment.block.documentation.ts
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
source.ts meta.class.ts comment.block.documentation.ts
source.ts meta.class.ts comment.block.documentation.ts comment.block.documentation.body.ts
> */
^^^^^
source.ts meta.class.ts comment.block.documentation.ts
Expand Down
8 changes: 1 addition & 7 deletions tests/baselines/Issue250.baseline.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,14 +64,8 @@ Grammar: TypeScript.tmLanguage
source.ts meta.class.ts
^^^
source.ts meta.class.ts comment.block.documentation.ts punctuation.definition.comment.ts
^
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
source.ts meta.class.ts comment.block.documentation.ts
^
source.ts meta.class.ts comment.block.documentation.ts storage.type.class.jsdoc punctuation.definition.block.tag.jsdoc
^^^^^^^^
source.ts meta.class.ts comment.block.documentation.ts storage.type.class.jsdoc
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
source.ts meta.class.ts comment.block.documentation.ts
^^
source.ts meta.class.ts comment.block.documentation.ts punctuation.definition.comment.ts
> static Original = function () {
Expand Down
Loading