Add syntax for Zig

[jfo]

Hi! I'd like to add syntax support for the Zig programming Language.

Checklist:

• I am adding a new language.
  • The extension of the new language is used in hundreds of repositories on GitHub.com.
    • Search results for each extension:
      • https://github.com/search?utf8=%E2%9C%93&q=import+extension%3Azig&type=Code
  • I have included a real-world usage sample for all extensions added in this PR:
    • Sample source(s): from the Zig source tree
    • Sample license(s): MIT
  • I have included a syntax highlighting grammar.
  • I have included a change to the heuristics to distinguish my language from others using the same extension.

Closes ziglang/zig#138
Closes ziglang/sublime-zig-language#1

Please let me know and thank you!

[andrewrk]

LGTM

[jfo]

@andrewrk is Zig's original author and not a fly by rando LGTM'ing FWIW 😃

[andrewrk]

what's the timeline for merges?

[lildude]

what's the timeline for merges?

From a quick look at the search results, I'm afraid it's going to be dependent on the growth of the use of Zig on GitHub.com and not based on anyone within the Linguist community.

Your search results show 517 files. If I remove the import keyword, this goes up to 635. If I then look into how the files of the more generous results are distributed across repos, I see they're spread across only 52 repos... which is a long way off our "used in hundreds of repositories on GitHub.com" requirement.

In short, Zig is not popular enough for this PR to be merged just yet and I've tagged this PR accordingly.

[jfo]

@lildude ok, thanks! I will update this PR with new search results as Zig grows. Is the changeset otherwise well-formed?

[lildude]

Yup, LGTM.

[ice1000]

The funnest post I've ever seen in GitHub issue comments, I saw this comment and laughed for an hour

[andrewrk]

I see they're spread across only 52 repos

How do you perform this search? I was unable to find this in the GitHub web interface.

[lildude]

How do you perform this search? I was unable to find this in the GitHub web interface.

I have a script that queries the search API. Unfortunately, I can't share it at the moment as it abuses the API and will result in rate limiting and blocking for other peeps.

@Alhadis has a written Harvester which does something similar, but within the browser so isn't subject to API abuse rate limiting.

[pchaigno]

but within the browser so isn't subject to API abuse rate limiting.

As far as I know, it is constrained by the rate-limit as well, but there's a timer to slow down requests. I'm expecting this is okay according to the terms of service since:

Researchers may scrape public, non-personal information from GitHub for research purposes, only if any publications resulting from that research are open access.

[Alhadis]

As far as I know, it is constrained by the rate-limit as well

It is. I had to slow it down on purpose:

// Throttle the next request so GitHub doesn't bite our head off
return wait(2000).then(() => next());

[pchaigno]

Closing in favor of #4219. We'll monitor the popularity of the extension there.

If you have an improved search query compared to the one used in #4219, please post it here and I'll update #4219.

[andrewrk]

It's time to re-open this issue. See #4219 (comment)

[andrewrk]

@lildude could you please re-open this issue?

[andrewrk]

cc @vmg

[daurnimator]

Any blockers here? @pchaigno could you open this PR again?

[ice1000]

Any deprecation in the syntax/example file? I suppose Zig's design is changing during this time.

[jfo]

I'll update this soon. Thanks for reopening!

[andrewrk]

  1) Failure:
TestGrammars#test_readme_file_is_in_sync [/home/travis/build/github/linguist/test/test_grammars.rb:42]:
Grammar list is out-of-date. Run `script/list-grammars`.
--- expected
+++ actual
@@ -428,5 +428,5 @@
 - **YARA:** [blacktop/language-yara](https://github.com/blacktop/language-yara)
 - **YASnippet:** [Alhadis/language-emacs-lisp](https://github.com/Alhadis/language-emacs-lisp)
 - **Zephir:** [phalcon/zephir-sublime](https://github.com/phalcon/zephir-sublime)
-- **Zig:** [ziglang/sublime-zig-language](https://github.com/ziglang/sublime-zig-language)
+- **Zig:** [zig-lang/sublime-zig-language](https://github.com/zig-lang/sublime-zig-language)
 "

Looks like an easy fix. github.com/zig-lang was renamed to github.com/ziglang.

[Alhadis]

github.com/zig-lang was renamed to github.com/ziglang

Hyphenation™: Disrupting technology since 1958! :thumb-up:

Technically, redirects should be handled by the add-grammar script... but they're uncommon enough to warrant manual updates, instead of adding extra complexity to the script. Plus, it discourages authors from wanton hyphenation changes. 😉

[Alhadis]

LGTM, regarding both changes and language popularity.

[ice1000]

Wow! We're going to have syntax-highlighted Zig files on GitHub!

[ararslan]

Is there anything else that needs to happen before this can be merged?

[Alhadis]

Yes, a final word of approval from GitHub staff.

/cc @lildude

[andrewrk]

/home/travis/build/github/linguist/vendor/licenses/grammar/sublime-zig-language.txt:
  - cached license data out of date

what does this mean?

[jfo]

@andrewrk The submodule commit didn't match the cached license hash.

[ararslan]

🎉 🎉 🎉

When will this go live? The next time Linguist is tagged?

[lildude]

When will this go live? The next time Linguist is tagged?

Yup. I aim to make a release approximately once a month, though couldn't in December due to a deploy freeze over the Christmas break and because I took some time off 😄