Skip to content

Markdown comments #18

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

Merged
robertoaloi merged 5 commits into from
Jun 30, 2025
Merged

Markdown comments #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4cc872a
Add link to regex editor
robertoaloi May 23, 2025
128f452
Add instructions on how to update the test snapshots
robertoaloi May 23, 2025
8f53a99
Fix matching group index for meta.directive.doc.erlang
robertoaloi May 23, 2025
e69770b
Simplify meta.directive.doc.erlang
robertoaloi May 23, 2025
fe898be
Mark the content of doc attributes as Markdown
robertoaloi May 23, 2025
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
10 changes: 4 additions & 6 deletions Erlang.plist
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -604,15 +604,13 @@
</dict>
<key>name</key>
<string>meta.directive.doc.erlang</string>
<key>contentName</key>
<string>meta.embedded.block.markdown</string>
<key>patterns</key>
<array>
<dict>
<key>begin</key>
<string>\G</string>
<key>contentName</key>
<string>comment.block.documentation.erlang</string>
<key>while</key>
<string>(^)(?!\s*(\5))</string>
<key>include</key>
<string>text.html.markdown</string>
</dict>
</array>
</dict>
Expand Down
9 changes: 8 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,16 @@ PowerShell) and all tests will be run. To add more tests you can either add
annotated files to `./tests/` or use the snapshot facility and then tests should
be added to `./test/snap`.

To update the snapshot tests, simply:

```
npx vscode-tmgrammar-snap --updateSnapshot ./tests/snap/*.erl
```

See more:

1. Visual Studio Code [Syntax Highlight Guide](https://code.visualstudio.com/api/language-extensions/syntax-highlight-guide)
2. TextMate [Language Grammars](https://macromates.com/manual/en/language_grammars)
3. [Writing a TextMate Grammar: Some Lessons Learned](https://www.apeth.com/nonblog/stories/textmatebundle.html)
4. [Building a syntax highlighting extension for VS Code](https://dev.to/borama/building-a-syntax-highlighting-extension-for-vs-code-594)
4. [Building a syntax highlighting extension for VS Code](https://dev.to/borama/building-a-syntax-highlighting-extension-for-vs-code-594)
5. [Regular expression editor](https://rubular.com/) to quickly experiment with matches and captures
88 changes: 45 additions & 43 deletions tests/snap/docstring.erl.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@
# ^ source.erlang meta.directive.module.erlang punctuation.definition.parameters.end.erlang
# ^ source.erlang meta.directive.module.erlang punctuation.section.directive.end.erlang
>-moduledoc """
#^ source.erlang meta.directive.doc.erlang punctuation.section.directive.begin.erlang
# ^^^^^^^^^ source.erlang meta.directive.doc.erlang keyword.control.directive.doc.erlang
# ^ source.erlang meta.directive.doc.erlang
# ^^^ source.erlang meta.directive.doc.erlang comment.block.documentation.erlang punctuation.definition.string.begin.erlang
#^ source.erlang meta.directive.erlang punctuation.section.directive.begin.erlang
# ^^^^^^^^^ source.erlang meta.directive.erlang keyword.control.directive.erlang
# ^ source.erlang meta.directive.erlang
# ^^^ source.erlang meta.directive.erlang string.quoted.triple.erlang meta.string.quoted.triple.begin.erlang punctuation.definition.string.begin.erlang
>Triple quoted strings examples
#^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ source.erlang meta.directive.doc.erlang comment.block.documentation.erlang
#^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ source.erlang meta.directive.erlang string.quoted.triple.erlang
>""".
#^^^ source.erlang meta.directive.doc.erlang comment.block.documentation.erlang punctuation.definition.string.end.erlang
# ^ source.erlang meta.directive.doc.erlang
#^^^ source.erlang meta.directive.erlang string.quoted.triple.erlang meta.string.quoted.triple.end.erlang punctuation.definition.string.end.erlang
# ^ source.erlang meta.directive.erlang punctuation.section.directive.end.erlang
>
>-export([f1/0, f2/0, f3/0, f4/0, f5/0,
#^ source.erlang meta.directive.export.erlang punctuation.section.directive.begin.erlang
Expand Down Expand Up @@ -79,16 +79,16 @@
# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ source.erlang comment.line.percentage.erlang
>
>-doc """
#^ source.erlang meta.directive.doc.erlang punctuation.section.directive.begin.erlang
# ^^^ source.erlang meta.directive.doc.erlang keyword.control.directive.doc.erlang
# ^ source.erlang meta.directive.doc.erlang
# ^^^ source.erlang meta.directive.doc.erlang comment.block.documentation.erlang punctuation.definition.string.begin.erlang
#^ source.erlang meta.directive.erlang punctuation.section.directive.begin.erlang
# ^^^ source.erlang meta.directive.erlang keyword.control.directive.erlang
# ^ source.erlang meta.directive.erlang
# ^^^ source.erlang meta.directive.erlang string.quoted.triple.erlang meta.string.quoted.triple.begin.erlang punctuation.definition.string.begin.erlang
> Docstring examples
#^^^^^^^^^^^^^^^^^^^^^^^^ source.erlang meta.directive.doc.erlang comment.block.documentation.erlang
#^^^^^^^^^^^^^^^^^^^^^^^^ source.erlang meta.directive.erlang string.quoted.triple.erlang
> """.
#^^^^^ source.erlang meta.directive.doc.erlang comment.block.documentation.erlang
# ^^^ source.erlang meta.directive.doc.erlang comment.block.documentation.erlang punctuation.definition.string.end.erlang
# ^ source.erlang meta.directive.doc.erlang
#^^^^^ source.erlang meta.directive.erlang string.quoted.triple.erlang meta.string.quoted.triple.end.erlang
# ^^^ source.erlang meta.directive.erlang string.quoted.triple.erlang meta.string.quoted.triple.end.erlang punctuation.definition.string.end.erlang
# ^ source.erlang meta.directive.erlang punctuation.section.directive.end.erlang
>f1() ->
#^^ source.erlang meta.function.erlang entity.name.function.definition.erlang
# ^ source.erlang meta.function.erlang meta.expression.parenthesized punctuation.section.expression.begin.erlang
Expand Down Expand Up @@ -252,17 +252,19 @@
# ^ source.erlang meta.function.erlang punctuation.terminator.function.erlang
>
>-doc ~s"""""
#^ source.erlang meta.directive.doc.erlang punctuation.section.directive.begin.erlang
# ^^^ source.erlang meta.directive.doc.erlang keyword.control.directive.doc.erlang
# ^ source.erlang meta.directive.doc.erlang
# ^^ source.erlang meta.directive.doc.erlang storage.type.string.erlang
# ^^^^^ source.erlang meta.directive.doc.erlang comment.block.documentation.erlang punctuation.definition.string.begin.erlang
#^ source.erlang meta.directive.erlang punctuation.section.directive.begin.erlang
# ^^^ source.erlang meta.directive.erlang keyword.control.directive.erlang
# ^ source.erlang meta.directive.erlang
# ^^ source.erlang meta.directive.erlang string.quoted.tripple.sigil.erlang storage.type.string.erlang
# ^^^^^ source.erlang meta.directive.erlang string.quoted.tripple.sigil.erlang meta.string.quoted.triple.begin.erlang punctuation.definition.string.begin.erlang
> Hello\n
#^^^^^^^^^^^^^^ source.erlang meta.directive.doc.erlang comment.block.documentation.erlang
#^^^^^^^^^^^ source.erlang meta.directive.erlang string.quoted.tripple.sigil.erlang
# ^ source.erlang meta.directive.erlang string.quoted.tripple.sigil.erlang constant.character.escape.erlang punctuation.definition.escape.erlang
# ^ source.erlang meta.directive.erlang string.quoted.tripple.sigil.erlang constant.character.escape.erlang
> """"".
#^^^^^^ source.erlang meta.directive.doc.erlang comment.block.documentation.erlang
# ^^^^^ source.erlang meta.directive.doc.erlang comment.block.documentation.erlang punctuation.definition.string.end.erlang
# ^ source.erlang meta.directive.doc.erlang
#^^^^^^ source.erlang meta.directive.erlang string.quoted.tripple.sigil.erlang meta.string.quoted.triple.end.erlang
# ^^^^^ source.erlang meta.directive.erlang string.quoted.tripple.sigil.erlang meta.string.quoted.triple.end.erlang punctuation.definition.string.end.erlang
# ^ source.erlang meta.directive.erlang punctuation.section.directive.end.erlang
>f2() -> ok.
#^^ source.erlang meta.function.erlang entity.name.function.definition.erlang
# ^ source.erlang meta.function.erlang meta.expression.parenthesized punctuation.section.expression.begin.erlang
Expand Down Expand Up @@ -347,17 +349,17 @@
# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ source.erlang comment.line.percentage.erlang
>
>-doc("""
#^ source.erlang meta.directive.doc.erlang punctuation.section.directive.begin.erlang
# ^^^ source.erlang meta.directive.doc.erlang keyword.control.directive.doc.erlang
# ^ source.erlang meta.directive.doc.erlang punctuation.definition.parameters.begin.erlang
# ^^^ source.erlang meta.directive.doc.erlang comment.block.documentation.erlang punctuation.definition.string.begin.erlang
#^ source.erlang meta.directive.erlang punctuation.section.directive.begin.erlang
# ^^^ source.erlang meta.directive.erlang keyword.control.directive.erlang
# ^ source.erlang meta.directive.erlang punctuation.definition.parameters.begin.erlang
# ^^^ source.erlang meta.directive.erlang string.quoted.triple.erlang meta.string.quoted.triple.begin.erlang punctuation.definition.string.begin.erlang
> Hello\n
#^^^^^^^^^^^^^ source.erlang meta.directive.doc.erlang comment.block.documentation.erlang
#^^^^^^^^^^^^^ source.erlang meta.directive.erlang string.quoted.triple.erlang
> """).
#^^^^^ source.erlang meta.directive.doc.erlang comment.block.documentation.erlang
# ^^^ source.erlang meta.directive.doc.erlang comment.block.documentation.erlang punctuation.definition.string.end.erlang
# ^ source.erlang meta.directive.doc.erlang punctuation.section.directive.end.Erlang
# ^ source.erlang meta.directive.doc.erlang
#^^^^^ source.erlang meta.directive.erlang string.quoted.triple.erlang meta.string.quoted.triple.end.erlang
# ^^^ source.erlang meta.directive.erlang string.quoted.triple.erlang meta.string.quoted.triple.end.erlang punctuation.definition.string.end.erlang
# ^ source.erlang meta.directive.erlang punctuation.definition.parameters.end.erlang
# ^ source.erlang meta.directive.erlang punctuation.section.directive.end.erlang
>g1() -> ok.
#^^ source.erlang meta.function.erlang entity.name.function.definition.erlang
# ^ source.erlang meta.function.erlang meta.expression.parenthesized punctuation.section.expression.begin.erlang
Expand All @@ -370,18 +372,18 @@
# ^ source.erlang meta.function.erlang punctuation.terminator.function.erlang
>
>-doc(~B"""""
#^ source.erlang meta.directive.doc.erlang punctuation.section.directive.begin.erlang
# ^^^ source.erlang meta.directive.doc.erlang keyword.control.directive.doc.erlang
# ^ source.erlang meta.directive.doc.erlang punctuation.definition.parameters.begin.erlang
# ^^ source.erlang meta.directive.doc.erlang storage.type.string.erlang
# ^^^^^ source.erlang meta.directive.doc.erlang comment.block.documentation.erlang punctuation.definition.string.begin.erlang
#^ source.erlang meta.directive.erlang punctuation.section.directive.begin.erlang
# ^^^ source.erlang meta.directive.erlang keyword.control.directive.erlang
# ^ source.erlang meta.directive.erlang punctuation.definition.parameters.begin.erlang
# ^^ source.erlang meta.directive.erlang string.quoted.tripple.sigil.erlang storage.type.string.erlang
# ^^^^^ source.erlang meta.directive.erlang string.quoted.tripple.sigil.erlang meta.string.quoted.triple.begin.erlang punctuation.definition.string.begin.erlang
> Hello\n
#^^^^^^^^^^^^^^ source.erlang meta.directive.doc.erlang comment.block.documentation.erlang
#^^^^^^^^^^^^^^ source.erlang meta.directive.erlang string.quoted.tripple.sigil.erlang
> """"").
#^^^^^^ source.erlang meta.directive.doc.erlang comment.block.documentation.erlang
# ^^^^^ source.erlang meta.directive.doc.erlang comment.block.documentation.erlang punctuation.definition.string.end.erlang
# ^ source.erlang meta.directive.doc.erlang punctuation.section.directive.end.Erlang
# ^ source.erlang meta.directive.doc.erlang
#^^^^^^ source.erlang meta.directive.erlang string.quoted.tripple.sigil.erlang meta.string.quoted.triple.end.erlang
# ^^^^^ source.erlang meta.directive.erlang string.quoted.tripple.sigil.erlang meta.string.quoted.triple.end.erlang punctuation.definition.string.end.erlang
# ^ source.erlang meta.directive.erlang punctuation.definition.parameters.end.erlang
# ^ source.erlang meta.directive.erlang punctuation.section.directive.end.erlang
>g2() -> ok.
#^^ source.erlang meta.function.erlang entity.name.function.definition.erlang
# ^ source.erlang meta.function.erlang meta.expression.parenthesized punctuation.section.expression.begin.erlang
Expand Down
16 changes: 8 additions & 8 deletions tests/snap/sigil.erl.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,16 @@
# ^ source.erlang meta.directive.export.erlang punctuation.section.directive.end.erlang
>
>-doc """
#^ source.erlang meta.directive.doc.erlang punctuation.section.directive.begin.erlang
# ^^^ source.erlang meta.directive.doc.erlang keyword.control.directive.doc.erlang
# ^ source.erlang meta.directive.doc.erlang
# ^^^ source.erlang meta.directive.doc.erlang comment.block.documentation.erlang punctuation.definition.string.begin.erlang
#^ source.erlang meta.directive.erlang punctuation.section.directive.begin.erlang
# ^^^ source.erlang meta.directive.erlang keyword.control.directive.erlang
# ^ source.erlang meta.directive.erlang
# ^^^ source.erlang meta.directive.erlang string.quoted.triple.erlang meta.string.quoted.triple.begin.erlang punctuation.definition.string.begin.erlang
> Sigil examples
#^^^^^^^^^^^^^^^^^^^^ source.erlang meta.directive.doc.erlang comment.block.documentation.erlang
#^^^^^^^^^^^^^^^^^^^^ source.erlang meta.directive.erlang string.quoted.triple.erlang
> """.
#^^^^^ source.erlang meta.directive.doc.erlang comment.block.documentation.erlang
# ^^^ source.erlang meta.directive.doc.erlang comment.block.documentation.erlang punctuation.definition.string.end.erlang
# ^ source.erlang meta.directive.doc.erlang
#^^^^^ source.erlang meta.directive.erlang string.quoted.triple.erlang meta.string.quoted.triple.end.erlang
# ^^^ source.erlang meta.directive.erlang string.quoted.triple.erlang meta.string.quoted.triple.end.erlang punctuation.definition.string.end.erlang
# ^ source.erlang meta.directive.erlang punctuation.section.directive.end.erlang
>-spec f() -> ok.
#^ source.erlang meta.directive.erlang punctuation.section.directive.begin.erlang
# ^^^^ source.erlang meta.directive.erlang keyword.control.directive.erlang
Expand Down