Improve Chapel highlight tools · chapel-lang/chapel#5908

(9 comments) (1 reaction) (4 assignees)Chapel (446 forks)auto 404

Epicarea: Toolsgood first issuestat: Needs Design Reviewtype: Feature Request

Repository metrics

Below is a list of syntax highlighters Chapel supports or aims to support. Many live in the repository under chapel/highlight/.

pygments
- used in documentation via sphinx
tmlanguage
- used by GitHub via linguist
highlight.js
- Stack Overflow uses highlight.js but not yet the Chapel highlighter. However the above is used in the Chapel discourse.
sublimetext
atom
vim
emacs
tex
GNU source-highlight
highlight
codemirror

[good first issue]: Document and/or fix any errors in our current syntax files
- This is a great way for new contributors to get started contributing to the project, e.g. (#6899)
Test our maintained syntax files against the compiler and/or against each other
Find ways to minimize maintenance overhead / rely on fewer syntax highlighters
- e.g. we could remove our tex syntax highlighting and use the minted package, which relies on pygments, for highlighting in LaTeX
Document and employ stricter policies for syntax changes
- e.g. If adding a new keyword, update all highlight files

Research direction: Choose one syntax highlighter file (e.g., vim, emacs) and compare its keyword list with the Chapel compiler's keywords to find missing or incorrect entries. Then submit a pull request with the fix.
Tech stack: None
Domain: developer experience
Issue type: Documentation
Difficulty: 2
Estimated time: 1-3 hours
Activity status: Active
Clarity: Clear
Prerequisites: Chapel
Newbie friendliness: 80