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

lint-file: Add flags to operate correctly outside of projects #1068

Open
carmenbianca opened this issue Sep 10, 2024 · 0 comments
Open

lint-file: Add flags to operate correctly outside of projects #1068

carmenbianca opened this issue Sep 10, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@carmenbianca
Copy link
Member

#1055 adds the reuse lint-file command, but it only works inside of the context of a Project as defined by the REUSE Specification. This means:

  • You can't lint files ignored by REUSE/VCS.
  • REUSE.toml is checked for information.
  • .license files are checked for information.
  • Used licenses must appear in the project's LICENSES/ directory (linter checks for missing licenses).

Any of these may be a dealbreaker for using lint-file in scripts, particularly the missing licenses check and the inability to lint ignored files. However, because the intended use-case of lint-file is pre-commit, this is not a dealbreaker for the intended audience. We can release without this.

In order to fix this issue, the following things should be added:

  • Flags for reuse lint-file to disable each of the above behaviours separately.
  • A --no-project (or some such) flag that disables several/all behaviours. Certainly the ignored files and missing licences check. For .license and REUSE.toml, I'm not certain.
@carmenbianca carmenbianca added the enhancement New feature or request label Sep 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant