[Markdown] add syntax highlighting in code fences for a few languages #1274

keith-hall · 2017-11-02T09:10:49Z

This PR uses the new embed action to add syntax highlighting inside Markdown code fences for XML, SQL, Python and Graphviz.

FichteFoll

What about other frequently used languages like Java, JavaScript, C (and variants) etc.?

FichteFoll · 2017-11-03T10:20:41Z

Markdown/Markdown.sublime-syntax

+    - match: |-
+         (?x)
+          {{fenced_code_block_start}}
+          ((?i:python))


Also add the 'py' variant, which I use all the time
😉

FichteFoll · 2017-11-03T10:21:57Z

Markdown/Markdown.sublime-syntax

+      embed_scope: markup.raw.code-fence.xml.markdown
+      escape: '^[ ]{,3}\1\s*$'
+      escape_captures:
+        0: markup.raw.code-fence.xml.markdown punctuation.definition.raw.code-fence.end.markdown


Only the fences should get the punctuation scope, not any whitespace surrounding it.

keith-hall · 2017-11-03T10:50:17Z

Adjustments made - I deliberately didn't add too many languages to start with in case tweaks were needed, as unfortunately variables are not supported in the escape pattern, and I was lazy to make lots of syntax tests... About things like C, C++, Obj-C - I wonder if there is some canonical reference somewhere of what the "language identifier" in the info string should be?

FichteFoll · 2017-11-03T16:16:16Z

Markdown/Markdown.sublime-syntax

+    - match: |-
+         (?x)
+          {{fenced_code_block_start}}
+          ((?i:javascript))


~~js also~~

Disregard, github was only showing me one of the two commits.

FichteFoll · 2017-11-03T16:20:39Z

Following github's GFM docs I found this: https://github.com/github/linguist/blob/master/lib/linguist/languages.yml. Looks like it's a case-insensitive match of the name and also supports aliases, although Python doesn't have a py alias 🤔

wbond · 2017-11-06T22:30:21Z

I would expect shell is probably one of the most popular fenced syntaxes. According Tiobe, things like C, PHP, Ruby, Obj-C, and Go would probably be higher on the priority list than Rust.

randy3k · 2017-11-30T19:24:12Z

I vote for the R syntax. (According Tiobe, R scores higher than GO)

keith-hall · 2017-11-30T19:30:09Z

I vote for embed to be changed to work more like include in that missing syntaxes are just warnings, so I can keep languages I will never use in my ignored_packages list without a load of errors appearing and the syntax highlighting not working at all, that's the main thing stopping me from adding more languages atm, apart from the extra syntax test and maintenance headache

wbond · 2017-11-30T20:18:36Z

@keith-hall That is an interesting idea. Make embedding sort of optional. The escape would still work, but if the embedded syntax isn't present, just print a warning saying it couldn't be found.

keith-hall · 2017-11-30T21:05:36Z

It would then potentially be possible (though I'm not sure if we want to) to add code fence support for some popular third party syntaxes too :)

wbond · 2017-11-30T21:11:26Z

Well, if it printed a warning when they were missing, that would cause the CI tests to fail

keith-hall · 2017-12-02T20:47:12Z

Added C, C++, Go, ObjC, ObjC++, R, Ruby

michaelblyons · 2017-12-13T15:11:52Z

Crosslinking to #266, where code fences and strikethrough are the last two issues.

rwols · 2018-01-13T14:52:01Z

This won't work correctly until sublimehq/sublime_text#1062 is fixed. For example, comments, line-continuations and character escapes are not rendered for Bash.

wbond · 2018-02-09T19:46:03Z

I spent a bit of time on sublimehq/sublime_text#1062 before 3157 went out, but wasn't able to come up with an implementation that didn't break existing default syntaxes in funny ways.

I think this is largely due to implementation details, but also this would end up being a change in behavior, so I may just end up documenting the edge case.

FichteFoll · 2018-03-21T21:13:36Z

Markdown/Markdown.sublime-syntax

+          ((?i:xml))
+          \s*$          # any whitespace until EOL
+      captures:
+        2: markup.raw.code-fence.xml.markdown-gfm punctuation.definition.raw.code-fence.begin.markdown


I don't think these captures should be getting the markup.raw scope. They aren't part of the "raw" segment since they are not rendered verbatim. (Also, I have dimmed background for markup.raw and it would be nice if that started on the first line of the raw block.)

And the escape_captures for 0 should be removed.

FichteFoll · 2018-03-21T21:14:57Z

Markdown/Markdown.sublime-syntax

-        1: punctuation.definition.raw.code-fence.begin.markdown
-        2: constant.other.language-name.markdown
+        2: punctuation.definition.raw.code-fence.begin.markdown
+        3: constant.other.language-name.markdown
      push:
        - meta_scope: markup.raw.code-fence.markdown-gfm


For the same reason, this should be meta_content_scope. And if it would otherwise match on the newline, the match probably needs to include \n also, but I'm not sure about that.

deathaxe · 2018-03-30T17:02:56Z

How about code fence highlighting for JSON as a subset of JavaScript?

keith-hall · 2018-04-10T10:02:43Z

@rwols can you give some examples of some Bash code that doesn't highlight correctly in the Markdown code fence please - I've added some test assertions for comments and character escapes and it seems to be working in build 3161, but maybe I'm missing something?

rwols · 2018-04-10T19:46:11Z

I checked out the STealthy-and-haSTy:markdown_codefences locally and it indeed seems to work fine on 3161. So I take back what I said :)

keith-hall · 2018-04-11T05:30:21Z

maybe let's get this merged then 😃 🎆

randy3k · 2018-09-08T15:14:43Z

@keith-hall
I just noticed that this PR broke the regex compatibility because of the use of backreference.
https://github.com/sublimehq/Packages/pull/1274/files#diff-bc7dff9190deda9f015e7ef8a4f3ceebR108

FichteFoll · 2018-09-08T15:21:46Z

Is this variable perhaps only used in a pop pattern? If it is, it's not a problem, but checking from mobile isn't worthwhile.

keith-hall · 2018-09-08T18:02:35Z

It is indeed only used from pop and escape, but ST is indeed marking it as incompatible for some reason. It's referring directly to the variable so I'd guess its a bug / overzealous warning in ST.

Packages/Markdown/Markdown.sublime-syntax:123:11: Back references are unsupported
FAILED: 1 pattern in "Packages/Markdown/Markdown.sublime-syntax" are incompatible with the new regex engine
[Finished]

(at the current state of the master branch, this is

Packages/Markdown/Markdown.sublime-syntax

Line 123 in 289782f

\2 # the backtick/tilde combination that opened the code fence

)

EDIT 2018-10-29: I have logged this minor problem with the incorrect warning here: sublimehq/sublime_text#2465

randy3k · 2018-09-08T19:37:28Z

R Markdown is based on the built in Markdown syntax and I recently received an issue and that seems to be related to this bug. Particular, that is resolved by reverting this PR.

…sublimehq#1274)

FichteFoll reviewed Nov 3, 2017

View reviewed changes

keith-hall added 9 commits February 10, 2018 15:05

[Markdown] add syntax highlighting in code fences for a few languages

e8c4848

[Markdown] tweaks to code fence support

c82a614

[Markdown] allow highlighting "js" code fences as JavaScript

48201e5

[Markdown] add Rust code fence

3eef4c1

[Markdown] add code fence highlighting for bash shell

a86b8bc

[Markdown] add code fence highlighting for PHP

2d08eda

[Markdown] add codefence support for more languages

4b2868d

[Markdown] add regexp code block highlighting

6eb9494

[Markdown] scope code fences with GFM suffix

1382bc4

keith-hall force-pushed the markdown_codefences branch from 56db252 to 1382bc4 Compare February 10, 2018 13:12

FichteFoll reviewed Mar 21, 2018

View reviewed changes

keith-hall added 2 commits March 22, 2018 13:28

Merge branch 'master' into markdown_codefences

fb2266d

[Markdown] don't scope the code fence punctuation as markup.raw

b75bdd7

[Markdown] add json to syntax highlighted code fence support

a1771a4

keith-hall mentioned this pull request Apr 9, 2018

[C#] Expression-bodied methods are not parsed correctly #1496

Closed

keith-hall added 2 commits April 10, 2018 12:03

Merge branch 'master' into markdown_codefences

e90ee37

[Markdown] add syntax tests for bash (prototype context in) code fences

2816db2

wbond merged commit 1d5ea32 into sublimehq:master Apr 15, 2018

deathaxe pushed a commit to deathaxe/sublime-packages that referenced this pull request Jun 9, 2019

[Markdown] add syntax highlighting in code fences for a few languages (…

05f8b71

…sublimehq#1274)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Markdown] add syntax highlighting in code fences for a few languages #1274

[Markdown] add syntax highlighting in code fences for a few languages #1274

keith-hall commented Nov 2, 2017

FichteFoll left a comment

FichteFoll Nov 3, 2017

FichteFoll Nov 3, 2017

keith-hall commented Nov 3, 2017

FichteFoll Nov 3, 2017 •

edited

Loading

FichteFoll commented Nov 3, 2017

wbond commented Nov 6, 2017

randy3k commented Nov 30, 2017 •

edited

Loading

keith-hall commented Nov 30, 2017

wbond commented Nov 30, 2017

keith-hall commented Nov 30, 2017

wbond commented Nov 30, 2017

keith-hall commented Dec 2, 2017

michaelblyons commented Dec 13, 2017

rwols commented Jan 13, 2018

wbond commented Feb 9, 2018

FichteFoll Mar 21, 2018

FichteFoll Mar 21, 2018

FichteFoll Mar 21, 2018 •

edited

Loading

deathaxe commented Mar 30, 2018

keith-hall commented Apr 10, 2018

rwols commented Apr 10, 2018 •

edited

Loading

keith-hall commented Apr 11, 2018

randy3k commented Sep 8, 2018 •

edited

Loading

FichteFoll commented Sep 8, 2018

keith-hall commented Sep 8, 2018 •

edited

Loading

randy3k commented Sep 8, 2018

[Markdown] add syntax highlighting in code fences for a few languages #1274

[Markdown] add syntax highlighting in code fences for a few languages #1274

Conversation

keith-hall commented Nov 2, 2017

FichteFoll left a comment

Choose a reason for hiding this comment

FichteFoll Nov 3, 2017

Choose a reason for hiding this comment

FichteFoll Nov 3, 2017

Choose a reason for hiding this comment

keith-hall commented Nov 3, 2017

FichteFoll Nov 3, 2017 • edited Loading

Choose a reason for hiding this comment

FichteFoll commented Nov 3, 2017

wbond commented Nov 6, 2017

randy3k commented Nov 30, 2017 • edited Loading

keith-hall commented Nov 30, 2017

wbond commented Nov 30, 2017

keith-hall commented Nov 30, 2017

wbond commented Nov 30, 2017

keith-hall commented Dec 2, 2017

michaelblyons commented Dec 13, 2017

rwols commented Jan 13, 2018

wbond commented Feb 9, 2018

FichteFoll Mar 21, 2018

Choose a reason for hiding this comment

FichteFoll Mar 21, 2018

Choose a reason for hiding this comment

FichteFoll Mar 21, 2018 • edited Loading

Choose a reason for hiding this comment

deathaxe commented Mar 30, 2018

keith-hall commented Apr 10, 2018

rwols commented Apr 10, 2018 • edited Loading

keith-hall commented Apr 11, 2018

randy3k commented Sep 8, 2018 • edited Loading

FichteFoll commented Sep 8, 2018

keith-hall commented Sep 8, 2018 • edited Loading

randy3k commented Sep 8, 2018

FichteFoll Nov 3, 2017 •

edited

Loading

randy3k commented Nov 30, 2017 •

edited

Loading

FichteFoll Mar 21, 2018 •

edited

Loading

rwols commented Apr 10, 2018 •

edited

Loading

randy3k commented Sep 8, 2018 •

edited

Loading

keith-hall commented Sep 8, 2018 •

edited

Loading