spdx / LicenseListPublisher

Tool that generates license data found in the license-list-data repository from the license-list-XML source
Apache License 2.0
11 stars 18 forks source link

Remove word wrapping for text file generation if test text is used #90

Closed goneall closed 3 years ago

goneall commented 3 years ago

This will allow the canonical text to be used as long as the License-List-XML repo has canonical text as the test text. Signed-off-by: Gary O'Neall gary@sourceauditor.com

goneall commented 3 years ago

@sschuberth @mxmehl This will resolve the issue raised as a comment in PR #83 It does, however, create a new issue if the test text in the License-List-XML repo does not have line feeds inserted to "word-wrap" the text. Some may view this as an issue independent of whether the upstream text word wraps.

There is a separate issue where the text in the License-List-XML repo is really the upstream text. From a quick look, this is very likely the case.

To make this work for Apache-2.0, we would need to merge this PR AND create a PR to replace the text at https://github.com/spdx/license-list-XML/blob/master/test/simpleTestForGenerator/Apache-2.0.txt

I would like your opinions on whether this PR should be merged or if we should leave the word wrapping as is.

sschuberth commented 3 years ago

Just curious, can't we remove the word-wrapping code altogether? If license texts were from upstream, they likely already are wrapped / formatted correctly. and even if not, we should still not tamper with them. So what do we need the word-wrapping for after all?

goneall commented 3 years ago

Just curious, can't we remove the word-wrapping code altogether? If license texts were from upstream, they likely already are wrapped / formatted correctly. and even if not, we should still not tamper with them. So what do we need the word-wrapping for after all?

Yes - that makes sense. This PR removes the word wrapping if the text comes from the text files stored in the list-list-XML test file directory. The only problem is it looks like most of the files in this directory are not directly from the upstream and do not have any line breaks.

I'm thinking that we should go ahead and merge this. We can then do PR's against the list-list-XML test file directory to replace any of the incorrect text files.