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

Provide licensing information according to REUSE Specification version 3.3 for generated editor SDK files #6637

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

kalrish
Copy link

@kalrish kalrish commented Dec 18, 2024

What's the problem this PR addresses?

The REUSE Specification requires licensing information for each and every file in a repository; as their FAQ states, "you cannot exclude files from REUSE compliance testing". Files generated by the editor SDK tool in the directory .yarn/sdks are meant to be committed, but they lack the licensing information required by the REUSE Specification. To adhere to the REUSE Specification, repositories that include Yarn editor SDKs must therefore associate licensing information with the editor SDK files with a separately maintained REUSE.toml file, as I've done for my blog.

How did you fix it?

I made the editor SDK tool:

I based the licensing information on the file LICENSE.md.

Checklist

  • I have set the packages that need to be released for my changes to be effective.
  • I will check that all automated PR checks pass before the PR gets reviewed.

Copy link
Member

@arcanis arcanis left a comment

Choose a reason for hiding this comment

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

I don't know this REUSE spec, and I'm not very comfortable adding to a core library dependencies to a third-party file parser we don't use elsewhere just for the sake of it.

@kalrish
Copy link
Author

kalrish commented Dec 18, 2024

Thank you for reviewing my proposal so quickly :).

I don't know this REUSE spec, and I'm not very comfortable adding to a core library dependencies to a third-party file parser we don't use elsewhere just for the sake of it.

I specifically chose @iarna/toml because it is listed as a dependency of the root package, although it doesn't seem to be used anywhere, as you say.

Do you want me to:

  • search for a more reputable and currently maintained TOML parser,
  • rework the code to generate REUSE.toml files from a simple string template without any parser or
  • withdraw the pull request altogether?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants