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

--clarificationsFile is ignored in --plainVertical output #115

Open
chkpnt opened this issue Jul 19, 2024 · 0 comments
Open

--clarificationsFile is ignored in --plainVertical output #115

chkpnt opened this issue Jul 19, 2024 · 0 comments

Comments

@chkpnt
Copy link

chkpnt commented Jul 19, 2024

With @jsep-plugin/assignment I've a package, which has a valid license (MIT) in it's package.json, but a missing license file. Therefore, license-checker-rseidelsohn is using the package's README file as described in the documentation.

├─ @jsep-plugin/assignment@1.2.1
│  ├─ licenses: MIT
│  ├─ repository: https://github.com/EricSmekens/jsep
│  ├─ publisher: Shelly
│  ├─ path: /path/to/project/node_modules/@jsep-plugin/assignment
│  └─ licenseFile: /path/to/project/node_modules/@jsep-plugin/assignment/README.md

As I'm using the --plainVertical output, the package's README file is now included in the output. So I've thought it's a good idea to use the --clarificationsFile-option:

{
    "@jsep-plugin/assignment@1.2.1": {
        "licenses": "BLA",
        "licenseText": "Copyright (c) 2013 Stephen Oney, https://ericsmekens.github.io/jsep/\n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n\"Software\"), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\nNONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE\nLIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION\nOF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION\nWITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE."
    }
}

Unfortunately, this licenseText isn't used for the --plainVertical output. Oddly, even the licenses isn't overwritten, but only suffixed with an asterisk:

├─ @jsep-plugin/assignment@1.2.1
│  ├─ licenses: MIT*
│  ├─ repository: https://github.com/EricSmekens/jsep
│  ├─ publisher: Shelly
│  ├─ path: /path/to/project/node_modules/@jsep-plugin/assignment
│  └─ licenseFile: /path/to/project/node_modules/@jsep-plugin/assignment/README.md

I've tried to set the licenseFile via the clarificationsFile, but I failed: neither with absolute paths nor with relative paths I wasn't able to set licenseFile to a path outside of node_modules/@jsep-plugin/assignment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant