Configuring comment syntax for more languages

[crabmusket]

I'm trying Skepsis out with a PHP/Vue codebase, but review comments don't work due to missing entries in SYNTAX_GROUPS. Would a contribution to add more recognised comment syntaxes be welcomed?

[david-crespo]

Absolutely! I did not try very hard to be comprehensive.

[crabmusket]

Vue is a tricky one as, like HTML, Vue files contain <script> blocks of JS or TS syntax, as well as <style> blocks of CSS syntax, and <template> tags of regular HTML syntax.

Supporting multiple syntaxes per file would be a whole discussion.

A quick option for me would be to always use slash comments in Vue files, as they are supported in JS/TS, in SCSS (though not plain CSS), and will not cause syntax errors in HTML parts - so despite being "wrong", they don't cause Vue to throw syntax errors.

But as that was messy I decided to just leave it alone for now!

[david-crespo]

Yeah, that is tough. Parsing the file to figure out which comment syntax is appropriate would be a whole thing. I like the slash comments option if it's better than whatever the status quo is. I'd put a comment on it saying more or less what you said about why it's the least bad option.

[crabmusket]

Ok, I'll submit that.

Thanks for working on this, and for open-sourcing it! I'm enjoying it so far :)

[tfreiberg-fastly]

i would like to have the option to supply my own comment syntax inline (or simply have an override button that just dumps the comment without any comment syntax in the file so i don't have to leave skepsis to write the comment)

[david-crespo]

#51 (released as 0.2.2) makes it so we don't error out on unrecognized files, instead putting the comment in without any comment marker. User syntax configuration would be a bigger lift and I'd prefer to avoid it if possible — I'm hoping this will be enough for most people.