jule icon indicating copy to clipboard operation
jule copied to clipboard

[PROPOSAL] Add Jule to Github Linguist

Open therabug opened this issue 1 year ago • 8 comments

Detailed description

Right now, GitHub doesn’t recognize Jule files, which means there’s no syntax highlighting for Jule code.

Adding Jule to GitHub Linguist will allow GitHub to properly highlight Jule code, making it easier to read and work with. This will help developers see the code clearly and improve collaboration. It will also make Jule more visible, helping it gain popularity and attract more contributors.

Context

Currently, Jule isn’t supported for syntax highlighting on GitHub, which makes it harder to read and work with Jule code in repositories. It will help Jule gain more visibility, encouraging more people to try it out and contribute, which could help grow the Jule community.

Possible implementation

We can:

  1. Add the .jule file extension to the languages.yml file in the Linguist repository.
  2. Set up syntax highlighting rules for Jule to match its basic syntax, similar to how other languages are handled.
  3. Test the changes using some Jule code samples to ensure the highlighting works properly.
  4. Submit a pull request to the Linguist repository so the changes can be reviewed and merged.

This process should help GitHub recognize and highlight Jule code correctly.

Additional information

No response

therabug avatar Nov 24 '24 10:11 therabug

This is not a proposal that the Jule team will directly accept or reject, because it about an independent repository, but there is no harm in adding it. Therefore I mark it as "Accepted".

It is not currently possible or not a priority for official Jule developers to do it. Linguist has a development environment and ​technologies​ I'm not familiar with, so community support is needed for the necessary PR. I'll do my best to support.

Some guesses for any community member looking to implement this;

  • When adding support for Jule, it might be helpful to look at what Jule-like languages ​​do. For example, Go and Rust ​​are good candidates.
  • For keywords and similar things, Jule's vscode extension may help; especially this file

mertcandav avatar Nov 24 '24 17:11 mertcandav

This is not a proposal that the Jule team will directly accept or reject, because it about an independent repository, but there is no harm in adding it. Therefore I mark it as "Accepted".

It is not currently possible or not a priority for official Jule developers to do it. Linguist has a development environment and ​technologies​ I'm not familiar with, so community support is needed for the necessary PR. I'll do my best to support.

Some guesses for any community member looking to implement this;

  • When adding support for Jule, it might be helpful to look at what Jule-like languages ​​do. For example, Go and Rust ​​are good candidates.
  • For keywords and similar things, Jule's vscode extension may help; especially this file

Exactly, I opened it here just to keep it as an idea.

therabug avatar Nov 24 '24 19:11 therabug

Adding support in chroma might be a good idea as well. A lot of projects use it (including WakaTime).

adamperkowski avatar Dec 15 '24 21:12 adamperkowski

Adding support in chroma might be a good idea as well. A lot of projects use it (including WakaTime).

I agree. It would be good.

mertcandav avatar Dec 15 '24 21:12 mertcandav

https://github.com/github-linguist/linguist/blob/main/CONTRIBUTING.md#adding-a-language

2024-12-17_12-12 2024-12-17_12-13

adamperkowski avatar Dec 17 '24 11:12 adamperkowski

@adamperkowski Should we work on a PR for this? Do you think Jule can pass the popularity assessment by #5756?

mertcandav avatar Dec 17 '24 13:12 mertcandav

@mertcandav we could start working on that. i'm sure it'll take a lot of time though as i think we need an ace and codemirror modes done. about the requirements, i'm not sure we have 100% of what's needed but i don't think it's a big deal.

adamperkowski avatar Dec 19 '24 10:12 adamperkowski

The PR is up: https://github.com/github-linguist/linguist/pull/7175

adamperkowski avatar Dec 20 '24 04:12 adamperkowski