Add syntax highlighting for .nanorc files and Git-related dotfiles

[Alhadis]

Fixes #4335 by adding a bespoke highlighting grammar for .nanorc files, as well as several extra config formats:

• .gitignore (and ignore-type manifests based on its syntax; e.g., .npmignore, .dockerignore, etc)
• .gitconfig, .gitmodules
• .gitattributes

Description

Since we're adding support for a language solely on aesthetic grounds, I thought to add highlighting for a few other widespread (and obvious) config formats: those used by Git itself.

Even if this addition is strictly superficial, I expect it'll be noticed (and welcomed) by many.

You'll notice .gitignore has been listed as "Ignore List". There are so many analogous formats based upon the gitignore(5) syntax, or are similar enough that they're practically interchangeable (e.g., .bzrignore, .cvsignore).

There are probably countless other ignore-like formats with enough adoption to qualify for registration, but I've only added those I'm aware of (...which was exhausting enough already).

Checklist:

• I am adding a new language.

  • The extension of the new language is used in hundreds of repositories on GitHub.com:

    • .atomignore: 399 files / 378 repos / 243 users
    • .babelignore: 211 files / 178 repos / 139 users
    • .bzrignore: ~4,504 files
    • .coffeelintignore: 1,283 files, 998 repos, 850 users
    • .cvsignore: ~364,972 results
    • .dockerignore: ~219,938 results
    • .eslintignore: ~1,877,266 results
    • .gitattributes: ~5,658,784 results
    • .gitconfig filename: ~99,163 results
    • .gitconfig extension: 1,452 files / 1,211 repos / 1,170 users
    • .gitmodules filename: ~1,328,213 files
    • .gitignore extension: ~120,877 results
    • .gitignore filename: ~30,930,758 results
    • .nanorc filename: ~56,021 results
    • .nanorc extension: ~47,713 results
    • .nodemonignore: ~6,366 results
    • .npmignore: ~57,496,063 results
    • .prettierignore: ~24,822 results
    • .stylelintignore: ~10,198 results
    • .vscodeignore: ~11,323 results
    • gitignore-global: ~14,552 results

  • I have included a real-world usage sample for all extensions added in this PR:

    • .atomignore: MIT
    • .babelignore: Improvised
    • .bzrignore: Python license
    • .coffeelintignore: Improvised
    • .cvsignore: Artistic license
    • .dockerignore: Apache 2.0
    • .eslintignore: MIT
    • .gitattributes: One of my dotfiles, ISC-licensed
    • .gitconfig: MIT
    • .gitignore: One of my dotfiles, ISC-licensed
    • .gitmodules: MIT (First ~20 lines of Linguist's .gitmodules)
    • .nanorc: MIT
    • .nodemonignore: MIT
    • .npmignore: ISC, improvised based on a .gitignore file from Alhadis/Utils
    • .prettierignore: MIT
    • .stylelintignore: ISC
    • .vscodeignore: MIT
    • aliases.gitconfig: ISC
    • Finale.gitignore: Creative Commons
    • gitignore_global: MIT
    • gitignore-global: MIT
    • gitignore: Creative Commons
    • nanorc.nanorc: MIT
    • nanorc: Improvised, based on documented defaults

  • I have included written several syntax highlighting grammars: https://github-lightshow.herokuapp.com/

    • .gitattributes: [ 1  |  2  |  3 ]
    • .gitconfig: [ 1  |  2  |  3 ]
    • .gitignore: [ 1  |  2  |  3 ]
    • .nanorc: [ 1  |  2  |  3 ]

[Alhadis]

@vmg, @lildude Would one of you care to test this with the grammar-compiler, please? 😬 I, erm, had to fudge docker with a blank executable in my $PATH because there's no Docker port for OpenBSD, and RubyGems hates each and every single MacBook I touch. 😥 That is, I can never get Linguist setup locally because I'm a r00b (Ruby n00b).

[lildude]

@Alhadis

$ script/grammar-compiler add vendor/grammars/language-etc
  > latest: Pulling from linguist/grammar-compiler
  > Digest: sha256:159ff655c832de0e3ab3ea1366992606b5f604bcb64f8757b6c575d4a7628bc6
  > Status: Image is up to date for linguist/grammar-compiler:latest
  > The new grammar repository `vendor/grammars/language-etc` (from https://github.com/Alhadis/language-etc) contains 1 errors:
  >     - Unknown keys in grammar: `source.nanorc` (in `grammars/nanorc.cson`) contains invalid keys (`maxTokensPerLine`)
  >
  > failed to compile the given grammar
$

[Alhadis]

That should be whitelisted. The field is supported by Atom, although it doesn't appear to have any impact on Lightshow when I tried it... 😞

[pchaigno]

That should be whitelisted.

@Alhadis You can add it to data.go then.

[pchaigno]

That's great! We should make a bit of noise to let peeps know you did this!

I have a couple comments on usage below.

[Alhadis]

@Alhadis You can add it to data.go then.

Done and done! 😀 I'll make it a part of this PR, since there's no point slowing everything down by submitting a separate pull-request...

[vmg]

Sensible addition! Let's see what @lildude says.

[lildude]

@Alhadis You can add it to data.go then.

Done and done! 😀 I'll make it a part of this PR, since there's no point slowing everything down by submitting a separate pull-request...

I'm clearly doing something wrong (complete Docker and Go noob) but I can't get this change to be picked up. 😞

[Alhadis]

Did you rm -rf the contents of the tmp/ directory? (Relative to your linguist checkout, I mean, not the /tmp folder!)

[lildude]

Did you rm -rf the contents of the tmp/ directory?

Yup. Whipped out the big docker image rm hammer too, and still no luck.

[Alhadis]

😨 Okay, erm, I'll leave this up to @vmg to figure out. 😰

[lildude]

Woohooo!!! Worked it out.

This bad boy is to blame 🤦‍♂️ :

https://github.com/github/linguist/blob/fa493000a594f5fbd457bbd473ce791d95b227cc/script/grammar-compiler#L9

Comment it out and 🎉

$ script/grammar-compiler add vendor/grammars/language-etc
OK! added grammar source 'vendor/grammars/language-etc'
	new scope: source.curlrc
	new scope: source.gitattributes
	new scope: source.gitconfig
	new scope: source.gitignore
	new scope: source.hgignore
	new scope: source.m4
	new scope: source.nanorc
$

Oh yes, I needed to rebuild the image too.

[lildude]

I've got no objections with this if @pchaigno doesn't.

[Alhadis]

I feel like I'm to blame with my hacky docker spoofing. 😅 Apologies for the mess and confusion.

[Alhadis]

I've got no objections with this if @pchaigno doesn't.

Ahem. @pchaigno, that would be your cue for the final response. 😉

[pchaigno]

@Alhadis There's one unresolved discussion above: I think we should remove the gitignore filename.

[Alhadis]

Burnt it.

[Alhadis]

More dotfile highlighting to come in future the next time I'm stabbed by an impulsive urge to work on some random grammar at 4:45 am. =)

[perlun]

@Alhadis 😄 Any idea of when this will be deployed to GitHub?

[Alhadis]

@perlun Updates to Linguist become live on GitHub once a new release of Linguist has been cut. The release cycle isn't set in stone, but it generally happens roughly once per month.

[perlun]

@Alhadis Alright, I see. I assumed it was being continuously delivered. 😉

[Alhadis]

Well, it is in a way — every change made to the repository's master branch triggers a new job in CI, which alerts contributors to unexpected build failures. But that's a different affair to actually deploying code live on GitHub.

[perlun]

But that's a different affair to actually deploying code live on GitHub.

Yeah, I know. I was just trying to be funny. 😄

Anyway, thanks for the change and have a Merry Christmas soon there in the "land down under"! 🐊 🏄 etc. 😃