JS File Size Changes (gzipped)

A total of 1 files have changed, with a combined diff of +11 B (+1.3%).

Generated by 🚫 dangerJS against bf45116

Could you please explain the motivation for this? The current highlighting seems to be quite good.

Code snippets for here and here.

@RunDevelopment those two examples don't capture the extents of this change. I've put together a couple of examples to exemplify these changes.

Take for example this codepen and this gist - both have 3 examples, the codepen being the prismjs rendered one and the gist the one that github uses.

Prismjs does not parse @doc/@module doc as its own type, it currently returns string, which can't be syntax highlighted as a comment (see example of github).
This change also adds tokenization of modules and function calls, see in the gist example 3 line 25 and 26. Github tokenize Application and put_all_env separately, OTOH prismjs does not tokenize them, this PR tokenizes them.

This PR also adds the raise keyword.

The goal of the new doc rule is to enable GitHub-like highlighting, right? If that's the case, then you could also change the attribute rule to give @doc and @moduledoc a special alias. With that alias you could do GitHub-like highlighting in CSS like this:

This makes a lot of sense, and it works with @doc one single line but when we have multiline docs .attribute + .string doesn't work as they're separated in different token lines. How do you propose to solve it?

@moduledoc """
multiline
documentation
"""

I'll push the changes you requested

doesn't work as they're separated in different token lines

I forgot that some libraries that use Prism under the hood do that. Prism doesn't split code into lines by itself, so I didn't account for this. Yes, my proposed alternative solution doesn't work.

@RunDevelopment I've updated it with your requests and with a suggested direction on how to deal with @doc/moduledoc.

Here's what I think is the right approach with the right compromise

• Everything that's after @attr <...> is an elixir statement, so it should be tokenized as such. Case in point: @doc since: "1.3.0"
• The elixir guide on writing documentation points out that it should be @(doc|moduledoc) "string" so I suggest we only tokenize those as docs and the remainder as normal attributes. (see included doc_feature.test)

Let me know what you think.

Sounds good! Let's go with that.

@RunDevelopment I've addressed all your comments and it's ready for review.

@RunDevelopment I've updated it, should be ready to go 🤞

Thank you for contributing @gordalina!