Add syntax highlighting to Yarn lockfiles

[arcanis]

Description

Yarn 1 uses a Yaml-like format which is good enough with the YAML highlighting, and Yarn 2 will switch to the good old regular YAML. Adding syntax highlighting to this file will help JS developers to review the changes, potentially preventing security issues.

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?q=filename%3Ayarn.lock&type=Code
  • I have included a real-world usage sample for all extensions added in this PR:
    • Sample source(s):
      • https://gist.github.com/arcanis/899cdb2ed30eeba45a0730d9af0f36bc
      • https://github.com/yarnpkg/berry/blob/master/yarn.lock (truncated sample included).
  • Sample license(s): BSD 2-clause

[Alhadis]

FYI: you can use Lightshow to show how files would be rendered with syntax highlighting. 😉

[pchaigno]

Thanks for taking the time to contribute to Linguist!

Could you please add one of the two sample files you pointed to to samples/YAML/?

From the few examples I've looked at on GitHub, these files appear to be generated (?). Maybe we should add them to generated.rb?

[Alhadis]

Maybe we should add them to generated.rb?

#4459, #4445

[pchaigno]

Ah, thanks @Alhadis!

[stale]

This pull request has been automatically marked as stale because it has not had recent activity, and will be closed if no further activity occurs. If this pull request was overlooked, forgotten, or should remain open for any other reason, please reply here to call attention to it and remove the stale status. Thank you for your contributions.

[stale]

This pull request has been automatically closed because it has not had activity in a long time. Please feel free to reopen it or create a new issue.

[arcanis]

Samples are here, sorry for the wait 🙂

[arcanis]

Hm keeping both versions seems to make the tests unhappy - how should I fix it? Add a single version?

Also, should I add yarn.lock to vendor.yml?

[Alhadis]

Hm keeping both versions seems to make the tests unhappy - how should I fix it?

Move the contents of samples/YAML/yarn/* to just samples/YAML/*. The exact error is here:

Errno::EISDIR: Is a directory @ io_fread - /home/runner/work/linguist/linguist/samples/YAML/yarn

Also, should I add yarn.lock to vendor.yml?

That shouldn't be necessary as YAML is a data-type language, so it won't skew or show up in a repository's language stats.

[arcanis]

Move the contents of samples/YAML/yarn/* to just samples/YAML/*. The exact error is here:

The problem is that the detection for both yarn formats has the same filename, so I can't have both in the same directory.

[Alhadis]

Then omit whichever one has the conflicting filename; only one is needed.

Which reminds me; this should be going in samples/YAML/filenames if it's an entry being added to the filenames array (instead of extensions).

[Alhadis]

Ouch. I just saw the size of the file you're adding... a 26,114-line sample is probably a bit overkill. 😉

Could you add a much more minimal sample, please? Something around the ~1-5 KBs range will do. Otherwise, it's going to nuke our classifier.

(I should have checked this first, knowing the size of Yarn lockfiles…)

[lildude]

Can you please update the OP to link to the source of the sample file and the license it is covered by as the file in the PR isn't the one you linked to in the OP.

[arcanis]

@lildude the sample is in the OP, it's the lockfile from the Yarn project, licensed BSD 2-clause.

[lildude]

@lildude the sample is in the OP, it's the lockfile from the Yarn project, licensed BSD 2-clause.

That's not the same file. https://github.com/yarnpkg/berry/blob/master/yarn.lock is 14757 lines long. The sample you've included is only 30 lines long.

[arcanis]

Yes, because

Could you add a much more minimal sample, please? Something around the ~1-5 KBs range will do. Otherwise, it's going to nuke our classifier.

I trimmed the file to a more reasonable size. Check the start of the file, it's the same content.

[lildude]

I trimmed the file to a more reasonable size. Check the start of the file, it's the same content.

Ah, that explains it and isn't clear. I've updated the OP to reflect this and the license. Thanks.