RSeidelsohn / license-checker-rseidelsohn

Extract NPM package licenses. Enhanced and updated fork of Dav Glass' original (but abandoned) license-checker.
https://www.npmjs.com/package/license-checker-rseidelsohn
Other
130 stars 34 forks source link

Custom format options #11

Open k-sai-kiranmayee opened 3 years ago

k-sai-kiranmayee commented 3 years ago

Hello, I just found out about this project today

Regarding the customPath and custom options, even though, I give only four options all the rest options are also displayed

Similar issue - https://github.com/davglass/license-checker/issues/140

Tried this project - Seems the same, Am I missing anything? Please help

Thanks in advance :)

RSeidelsohn commented 3 years ago

Oh damn, I have to figure out why I do not see any messages in my inbox when someone opens an issue here. Sorry for replying that late, @k-sai-kiranmayee, I just saw your issue right now. I'll have a look and respond to is asap. Please be aware that I do not spend a lot of time with this module, as I in the first place have family with kids and a full time job and other hobbies besides coding. So please kick me in the ass from time to time if my actions take too long for you. I am happy to help everyone with their issues.

k-sai-kiranmayee commented 3 years ago

Hey @RSeidelsohn, Thank you for the response! And yeah, I understand, however, hoping that you will get to look at this one :octocat: and stay safe!

TomaszWegrzyn commented 2 years ago

I just found this repo because original one is abandoned. Hoped to see this problem fixed in this fork :(

Well, maybe I will try to solve it myself during hacktoberfest :thinking:

RSeidelsohn commented 2 years ago

Hi @TomaszWegrzyn ,

thanks for the bumper! I'll hopefully have a look at this issue finally now this weekend! Sorry for the loooong delay.

RSeidelsohn commented 2 years ago

One more - and for now good news:

It seems to work, but in the customFormat.json you need to set those keys to false that you do NOT want in the output:

{
    "name": false,
    "version": true,
    "repository": false,
    "path": false,
    "licenseFile": false,
    "email": false,
    "licenseText": false,
    "copyright": false,
    "licenses": false,
    "publisher": false,
    "url": false
}

Only the "licenses" key can not be removed - using the above snippet will still output the licenses. Anyway this calls for refactoring and improvement!

HighKo commented 2 years ago

Using ": true" serves as the default value, so you will end up with true in your json which my tools were not able to parse. I suggest using the empty string "" instead of true

k-sai-kiranmayee commented 2 years ago

Hello @RSeidelsohn, been a while, thank you for the input, it works! However, found another issue, I'm trying to give includePackages as a String ('package@version;so on;'), but still it is considering all the internal packages when the start string is './'. Any idea as to why? I'm trying with the script below

const checker = require('license-checker-rseidelsohn');

checker.init({ start: './', includePackages: ${packagesList}, customPath: './customFormat.json', }, (err, packages) => {})

Thank you :)

RSeidelsohn commented 1 year ago

Dear @k-sai-kiranmayee ,

It's been a long time now, I know. I just tried to reproduce the issue, but for me (with version 4.2.2), everything seems to work fine. Should you depend on the pre-4-version, please tell me so, otherwise it would be cool if you could double check and tell me if the issue is resolved now for you as well.

Best, Roman.

k-sai-kiranmayee commented 1 year ago

Hello @RSeidelsohn, hope you are doing well :)

I gave a try with version 4.2.2 and I'm facing this error, not sure if this is related to compatibility with my machine. I have seen the notes mentioned here and tried with version 3.3.0 too, but no luck :(

image

My machine has Node - 10.23.1 Npm - 6.14.10

As mentioned here the internal packages are being considered for the older version (1.2.2)

Please let me know anything further!

RSeidelsohn commented 1 year ago

Dear @k-sai-kiranmayee,

I find this issue now a bit confusing, but I really would love to help you now that I find the time to work on the project for one day every two weeks. Regarding your syntax error from above: Please note that node v10 is really old - this project currently relies on node v18.13.0 - even security support for node v10 ended two years ago. But anyways, I am using "optional chaining here (?.) and this is supported in node from version 14.0.0 on only (of which security support will end in two days). But other than that, I do currently not understand which other issue you still have with the license checker. It would be great if you could find the time to bring me up to speed with it, so I can find a solution for your issue.

Cheers, Roman.

k-sai-kiranmayee commented 1 year ago

Hello @RSeidelsohn, Thank you for the reply. I do understand that you have used optional chaining, however, my current project seems to be a bit coupled with Node v10.23.1 :(

The issue for which this has been logged has been fixed, however, I was facing this one - internal packages are shown. And as you have said here, I trust you that this might have been fixed in the latest versions, but for my project, I can't upgrade to Node v18 :(, is there any workaround to get to hide the internal packages into the version1.2.2.

I know I'm asking a bit much, but please let me know further. Also, I'm happy to close this one as the original one has been resolved and raise a new one if you decide to work on 🙏

Thank you, Sai Kiranmayee