Rule linter

[armijnhemel]

Short Description

There are inconsistencies in scancode rules: sometimes YAML indentation is four spaces, sometimes two spaces. Having a linter that does some simple checks of the YAML frontmatter.

See also #5070 (comment)

Possible Labels

• new feature

Select Category

• Enhancement
• Add License/Copyright
• Scan Feature
• Packaging
• Documentation
• Expand Support
• Other

Possible Solution/Implementation Details

Example/Links if Any

Can you help with this Feature

[SahilSonar-04]

I would like to work on this

[hello-ryuzaki]

Hi @armijnhemel , I’d like to work on this issue if it’s still available. Would it be possible for you to assign it to me? I’d be happy to contribute and work on it. Thank you!

[Saumyajaiswal9794]

Hi @armijnhemel, I’d like to contribute to this! If it is still open for assignment, I can start working on the rule linter implementation and submit a draft PR. Please let me know if I can take this up

[RAUNAK2108]

Hi @armijnhemel, I’d also be interested in contributing to this issue if it is still available.

My initial approach would be to add a linter for the YAML frontmatter of ScanCode rule files, starting with basic validation such as consistent indentation/formatting and checking for common YAML/frontmatter issues. I’d first look through the existing rule structure and related tooling/tests to understand the expected format, then add the linter with appropriate tests.

I noticed a few contributors have already expressed interest, so I completely understand if this issue has already been assigned. If it is still open for contribution, I’d be happy to work on it. Thanks!