Add TSQL to linguist

[beau-witter]

Description

Adding the TSQL language as identifiable through linguist.

Checklist:

• I am associating a language with a new file extension.

  • The new extension is used in hundreds of repositories on GitHub.com
    • Search results for each extension:
      • https://github.com/search?utf8=%E2%9C%93&type=Code&ref=searchresults&q=extension%3AFOOBAR+KEYWORDS+NOT+nothack
  • I have included a real-world usage sample for all extensions added in this PR:
    • Sample source(s):
      • [URL to each sample source, if applicable]
    • Sample license(s):
  • I have included a change to the heuristics to distinguish my language from others using the same extension.

• 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&type=Code&ref=searchresults&q=extension%3Asql+GO
  • I have included a real-world usage sample for all extensions added in this PR:
    • Sample source(s):
      • [URL to each sample source, if applicable]
    • Sample license(s):
  • I have included a syntax highlighting grammar: https://github-lightshow.herokuapp.com/
  • I have updated the heuristics to distinguish my language from others using the same extension.

• I am fixing a misclassified language

  • I have included a new sample for the misclassified language:
    • Sample source(s):
      • [URL to each sample source, if applicable]
    • Sample license(s):
  • I have included a change to the heuristics to distinguish my language from others using the same extension.

• I am changing the source of a syntax highlighting grammar

  • Old: https://github-lightshow.herokuapp.com/
  • New: https://github-lightshow.herokuapp.com/

• I am updating a grammar submodule

• I am adding new or changing current functionality

  • I have added or updated the tests for the new or changed functionality.

[beau-witter]

@lildude Updated the draft PR with some changes, all tests now pass. I think the major issue now is the grammar problem.

[ghost]

Is this something you are looking for?

[beau-witter]

@nanoquanta Yes, but I am not sure how to look. Do you know of something that may be able to help?

[acdevick]

@nanoquanta Thanks for working on this our company just started using Flyway and moved all of our TSQL to github. I came across this looking for a solution to fix temp tables where github is rendering #tempTable as a commented line vs actual TSQL Code. Would that be able to be fixed as a feature to TSQL?

[beau-witter]

@acdevick If we are able to get the right grammar file included as part of adding the TSQL language to Linguist, then yes, that should be rendered correctly assuming the file is correctly detected as TSQL.

[beau-witter]

@lildude If I were to make a separate repo to be the TSQL grammar repo, have the scope be source.tsql, and have it setup in such a way that linguist can read/understand the path, would that be ok?

[lildude]

@beau-witter yeah, I think so. You'd become the maintainer of that grammar going forward and can't delete it as long as Linguist continues to use it.

@Alhadis has more experience with maintaining grammars so should know if simply changing the scope is sufficient for our needs.

[beau-witter]

@lildude I added the TSQL grammar repo I created as the grammar for the TSQL language I added to linguist. All the tests appear to pass. Let me know if there is anything else that needs to be done to move forward.

@Alhadis When I added https://github.com/beau-witter/language-tsql as a grammar using script/add-grammar it auto added the scope as source.sql when the tsql.json file I have in the grammars folder specifies the scope to be source.tsql. I changed it manually (observable in the most recent commit). I just want to check if that is ok, and if not, why it happened?

[beau-witter]

I am turning this into a real PR as I believe it is ready to be fully reviewed.

[lildude]

TIL... Travis doesn't support draft PRs yet so CI wasn't triggered when you flipped this PR to be a real PR. I'm going to see if I can trigger a build by closing and reopening the PR. If I hit problems, I may need you to do it @beau-witter.

[lildude]

🎉 it worked!!!

[beau-witter]

@lildude Alright! Thanks for Travis CI working! I think I got everything corrected on my side, and Travis seems to agree! Should be good to review now.

[Alhadis]

Hey guys, sorry for the silence. Been out of action for the last couple of weeks. 👋

@Alhadis has more experience with maintaining grammars so should know if simply changing the scope is sufficient for our needs.

Yes, that's fine. A grammar's scope-name is mainly important to Atom (and other TextMate-derived text editors) for styling and syntax-level command scoping; e.g., an author might use source.sql.tsql to maximise compatibility with a user's customisations: a snippet that targets source.sql will also work for source.sql.tsql, but not source.tsql.

However, all of this is moot as far as Linguist is concerned, because a scope only has to be unique (in the sense of acting as a global identifier). I recommend using source.tsql because it's much clearer and obvious to future contributors.

[beau-witter]

@Alhadis Thanks for that info! That is really neat. I did end up doing the source.tsql way, so thanks for confirming that way will work!

[beau-witter]

@lildude Is there anything else I can do to help this PR move along?

[lildude]

Nope. It's up to @pchaigno and/or @Alhadis to review next.

[beau-witter]

@lildude I see the changes have been approved. Yay!

Just curious, is there a known update date when this might be merged by?

[lildude]

Just curious, is there a known update date when this might be merged by?

There's never a known date for merging as it's not really important. I merge whenever I get around to reviewing, if I approve, but it won't take effect on GitHub.com until I make a release, which once against doesn't have a known date beyond "I aim for approximately once a month, based on my own load and the GitHub.com deploy queue and locks etc" 😄

[esauser]

Any idea when this will be included in GitHub and/or GitHub Enterprise?

[lildude]

I'm aiming to do a release this week. If I succeed, this will make it into GitHub Enterprise Server 2.17.1. If I can't get this on GitHub.com this week, it'll be in 2.17.2.