Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Circom language support #6204

Merged
merged 6 commits into from
Feb 17, 2023
Merged

Conversation

cryptopapi997
Copy link
Contributor

@cryptopapi997 cryptopapi997 commented Dec 1, 2022

Added the Circom 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: >17k uses
    • I have included a real-world usage sample for all extensions added in this PR:

    • I have included a syntax highlighting grammar: Only available grammar I could find was this one by the developers of circom, but it is currently unlicensed.

    • I have updated the heuristics to distinguish my language from others using the same extension.

@cryptopapi997
Copy link
Contributor Author

cryptopapi997 commented Dec 1, 2022

Update: Thanks to @krlosMata 's super fast response , the syntax repo now has a license. It is GPL3, however. Let me know if this works @linguist and I'll happily add the syntax to my PR

@Alhadis
Copy link
Collaborator

Alhadis commented Dec 1, 2022

It is GPL3, however

That's a deal-breaker. We only accept grammars released under permissive licenses, which rules out copyleft licenses like GPL completely.

@cryptopapi997
Copy link
Contributor Author

Feared this unfortunately - can we still merge this PR without a grammar for now nonetheless?

@Alhadis
Copy link
Collaborator

Alhadis commented Dec 2, 2022

Can we still merge this PR without a grammar for now nonetheless?

Yes. You can even reappropriate another language's grammar if it happens to provide decent-enough highlighting.

@krlosMata
Copy link

I will check other licenses that fits the requirements

@krlosMata
Copy link

It is GPL3, however

That's a deal-breaker. We only accept grammars released under permissive licenses, which rules out copyleft licenses like GPL completely.

I have change the license to MIT in https://github.com/iden3/circom-highlighting-vscode, so it fulfills the specification

@cryptopapi997
Copy link
Contributor Author

Awesome! Currently out, but will add the grammar when I'm back 👍

@cryptopapi997
Copy link
Contributor Author

Added the circom grammar, feel free to have a look again @Alhadis

lib/linguist/languages.yml Outdated Show resolved Hide resolved
lib/linguist/languages.yml Outdated Show resolved Hide resolved
Co-authored-by: Colin Seymour <colin@github.com>
@cryptopapi997
Copy link
Contributor Author

cryptopapi997 commented Dec 12, 2022

Thanks for the review, added your changes @lildude

Copy link
Member

@lildude lildude left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks.

Note: this PR will not be merged until close to when the next release is made. See here for more details.

@lildude lildude merged commit 2e9ce8b into github-linguist:master Feb 17, 2023
@github-linguist github-linguist locked as resolved and limited conversation to collaborators Jun 17, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants