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

License boilerplate remover plugin #833

Open
pombredanne opened this issue Nov 2, 2017 · 0 comments
Open

License boilerplate remover plugin #833

pombredanne opened this issue Nov 2, 2017 · 0 comments

Comments

@pombredanne
Copy link
Contributor

This idea of this plugin is to help remove license boilerplate from source code and replace it with an SPDX-License-Identifer expression tag.

This could be called espeedixfy or some better name.
It would be a postscan plugin requiring license detection. Then if there is a clear, 100% match license all matched to SPDX ids (for now), it would remove the matched text from the file and replaces it smartly with an SPDX-License-Identifier handling (by lexing the code) the proper comment style to inject this.
Anyone could run it on their code, and submit patches to clean up the boilerplate e.g something that makes it easy on maintainers to clean the stuff at their own pace. Linux kernel maintainers have expressed interest for this:

a tool/script like that would be wonderful.

As an option it could also normalize the copyright statements and create a license text file for the doc if it does not exists there.

There is not much left to get there as scancode spits the exact matched text and lines. So from that we can remove the lines from the scanned source code and determine the comment style then inject the license id , possibly using Pygments to determine and preserve the comment style

pombredanne added a commit that referenced this issue Nov 2, 2017
 * and replace it with an SPDX-License-Identifier

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
pombredanne added a commit that referenced this issue Nov 2, 2017
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
pombredanne added a commit that referenced this issue Mar 10, 2018
 * and replace it with an SPDX-License-Identifier

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
pombredanne added a commit that referenced this issue Mar 10, 2018
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
pombredanne added a commit that referenced this issue Apr 11, 2018
 * and replace it with an SPDX-License-Identifier

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
pombredanne added a commit that referenced this issue Apr 20, 2018
 * and replace it with an SPDX-License-Identifier

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
pombredanne added a commit that referenced this issue Apr 20, 2018
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
pombredanne added a commit that referenced this issue Apr 27, 2018
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
pombredanne added a commit that referenced this issue Apr 30, 2018
Most of these are old and new exceptions

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
pombredanne added a commit that referenced this issue Apr 30, 2018
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
pombredanne added a commit that referenced this issue Apr 30, 2018
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant