hesa / scarfer

Source Code scan report file reporter

Hi there 👋

📫 How to reach me:

• LinkedIn: henrik-sandklef

scarfer's Issues

Make reuse compliant

Description

Code lacks (c) and license. Add this and use reuse (tool) to verify correctness.

Steps for reproduction

reuse lint

Expected behavior

exit code 0

Actual behavior

Environment

all

add additional tools you used and their versions here

Additional logs

Usual excludes

Feature request

Add support for:

• files containing list of files and folders that can be excluded when calculating the license (e.g. README, LICENSE, docs/)
• add option to use the file to exclude, e.g. --common-excludes, -ce

Is your feature request related to a problem? Please describe.

When determining the license for a project one usually adds exclude expressions such as -ef COPYING LICENSE README tests. Would be nice to provide a list of common such expressions to ease up use.

Add scan instructions for Scancode

Feature request

To get the most out of scancode (and scarfer) some command line options are needed. Specify these in some kind of doc.

Add files for exclusion (while identifying license summary)

More files that need not be taken into concern when it comes to licenses (and thus can be excluded):

• THANKS
• /.dir-locals.el
• /.git-log-fix
• /.prev-version
• /.x-update-copyright

List filter and curation rule with: output fixes

Feature request

When listing filtered and curated files, using --output-fixes it would be nice to see what expression matched those.

Example data that can be used for tests

Something like:

# File filters

## README* COPYING*

./README.md
./COPYING


## tests/

./tests/donkey.c
./tests/kong.c

# License curations

## Missing license

./src/monkey.c

## MPL-2.0

./src/dong.c

Add version option

Feature request

Add --version (-V) to output version information

Is your feature request related to a problem? Please describe.

Useful for obvious reasons

Describe a tool that might help here

Example data that can be used for tests

Add filter to include files matching a (c) expression

Feature request

Add filter to include/exclude files matching a (c) expression.

This would be similar to:

• -if src/runtime - that includes only files with name matching src/runtime
• -il mit - that includes only files with license matching mit

Proposed syntax:

• -ic EXPRESSION, --include-copyright EXPRESSION
• -ec EXPRESSION, --exclude-copyright EXPRESSION

Add version option and version in help output

Feature request

Sometime it is important to see which version you're using, add:

--version

as well as adding the version somewhere in the help output.

exclude file from config output

Description

Do not output the variable "file" from the configuration output sine it interfers with command line option when using a config file for a new version of a software