jashkenas / jashkenas/coffee-script-tmbundle
Issue with CoffeeScript block comment syntax on Github viewer
- Dominant language
- JavaScript
- Stars
- 826
- Forks
- 232
- PR merge metrics
- No merged PRs in 30d
Description
I noticed an issue when viewing a CoffeeScript file on Github. Here:
https://github.com/perroned/bigbluebutton/blob/99e0b75997f58796b74e3e9df3b7f2de0aa2ee5c/bigbluebutton-html5/app/client/globals.coffee#L158-L162
In CoffeeScript triple pound signs '###' are used to show the beginning and ending of a block comment. This is how my code looks in Atom editor:
(Correct)
The code between the tags is recognized as a comment, and everything surrounding is displayed correctly. However here on the Github viewer everything after the code comment tag is not displayed properly https://github.com/perroned/bigbluebutton/blob/99e0b75997f58796b74e3e9df3b7f2de0aa2ee5c/bigbluebutton-html5/app/client/globals.coffee#L164-L165
It is displayed as a comment. Some lines still show some form of syntax highlighting like here on line number 196 https://github.com/perroned/bigbluebutton/blob/99e0b75997f58796b74e3e9df3b7f2de0aa2ee5c/bigbluebutton-html5/app/client/globals.coffee#L196
Contributor guide
No contributing guide indexed for this repository
Research direction
Reproduce the rendering using the linked globals.coffee example, focusing on lines 158-165 and 196. Inspect the CoffeeScript syntax-highlighting grammar used by this TextMate bundle and compare how triple-pound block comments are parsed; done means code after the closing marker is displayed and highlighted correctly on GitHub.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- coffeescript
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100