What do folks think about adding a `.vscode/extens...
# team-maintainers
p
What do folks think about adding a
.vscode/extensions.json
file into the pipeline template? It can include recommendations for VSCode extensions. See for example this repo. We could include the Nextflow extension and others (basically the nf-core VSCode extension pack list). Downside is a
.vscode
folder in the root πŸ˜•
πŸ‘ŽπŸ» 2
πŸ‘Ž 2
😐 1
πŸ‘ŽπŸ½ 1
πŸ‘ 1
j
Personally not in favour - not everyone uses VSCode (I don't!), and it would add clutter for anyone not using it... plus it promotes using a semi-proprietary text editor, which I'm iffy about. Not opposed to highlighting/documenting the extension pack somewhere in the template in the docs section though, maybe part of
CONTRIBUTING.md
?
this 3
p
Yes that's kind of my feeling too - I've pushed back against having a
.vscode
folder in the past with
settings.json
files etc that tend to try to creep in.
The nice thing about this is that it gives you a pop up in VSCode as soon as you open the editor. I suspect 90% of people never RTFM so it's a nice win for that reason.
I wish everyone could agree to have a single shared
.config
folder or similar, then nest their proprietary folders within that. They would bother me much less then. Like the
XDG_CONFIG
equivalent of home dirs.
m
Isn’t there some sort of
.editorconfig
that’s supported by multiple editors?
I think vscode and the jetbrains stuff support that one, although not sure what the scope of the file is
maybe
zed
too
and the
vim
users will figure it out themselves πŸ˜…
🀣 3
p
The popup looks like this
.editorconfig
is for stuff like line-ending types, line width etc. We used to use that but it's superseded by Prettier and other auto-formatters now.
j
Just include an nf-core
emacs
distribution in the template
magic 1
p
Here I'm talking about VSCode extensions, so it's kind of not-generalisable by definition.
m
Here I’m talking about VSCode extensions, so it’s kind of not-generalisable by definition.
half the editors out there are vscode forks and use the same marketplace πŸ˜†
tru 1
πŸ‘ 1
so 50% generalisable?
s
I would guess that VSCode is the most common editor for Nextflow out there
But maybe we could poll more widely πŸ˜‰
j
Of that I have no doubt, but even if 99% of people used it I would have an issue with bundling an extension pack file.
this 1
p
I'm not particularly bothered about adding it. I agree about clutter, I don't really follow the promotion thing because it is silent for anyone not using vscode, so by the time it does anything the person is already using vscode (aside from seeing the filename in the repo I guess?).
I just thought it was neat when it did its stuff in another repo I was opening
Looks like some repos (cough #CE8SSJV3N cough) have this file already: github.com/nf-core/rnaseq/blob/…/settings.json Not quite sure how that got there.. Looks like it was copied from #CE7DN1U7M? That file works but it won't do anything in #CE8SSJV3N because
"public/vscode_markdown.css"
doesn't exist in that folder confused dog
m
#CJRH30T6V also has it
p
hah, looks like it was me
website repo history rewrite means that git blame on github.com no longer links to PRs sad cowboy
But it was this anyway
I guess I adopted it in the template and meant to use nf-co.re/vscode_markdown.css but accidentally did
public/vscode_markdown.css
instead and just never noticed that it didn't actually work πŸ™ˆ
ok, given that we already had this file and apparently no-one on this thread had noticed or cared until now 🀣 ... does anyone mind if I add some recommendations into the existing file? πŸ˜† And can fix the markdown rendering thing whilst I'm at it
πŸ‘ 1
s
That sounds perfectly reasonable to me
p