Introducing license-report-config.json

[pubmikeb]

In includes:

• the license-report-config.json schema
• the catalog.json update
• the test JSON-file

[BePo65]

A few comments / questions:

src/schemas/json/license-report-config.json

• definition of output: perhaps you could add "type": "string", to be consistent with the definition of "fields"
• definition of delimiter: shouldn't the first property be "delimiter": ",", (instead of "delimiter": ",",)?
• definition of comment: the property "type": "object" is missing
• definition of comment: the property label is dynamic too, so that perhaps "label": { "type": "string", "default": "comment" } is more appropriate?
• I didn't find the definitions for the properties department, relatedTo, licensePeriod, material, name, licenseType, link, remoteVersion, installedVersion, author. The definition follows the definition of comment.
• and then there is an undocumented property called "package" with a default value of "./package.json"

src/test/license-report-config/basic-license-report-config.json
I think it would be great, if the test config.json contained all fields, just to test all schema definitions.

But anyway: thanks for entering this definition in this site.

[pubmikeb]

• definition of delimiter: shouldn't the first property be "delimiter": ",", (instead of "delimiter": ",",)?

Perhaps, copy & paste issue, in both cases "delimiter": ",", is proposed.

[pubmikeb]

• I didn't find the definitions for the properties department, relatedTo, licensePeriod, material, name, licenseType, link, remoteVersion, installedVersion, author. The definition follows the definition of comment.

I've done the schema based on the ESLint schema, there the enum items are without the type definition, e.g.:

"enum": [
    "readonly", "writable", "off"
]

It's just initial version, there is still an issue with auto-suggestion, I need to figure out how to do that.

[pubmikeb]

I think it would be great, if the test config.json contained all fields, just to test all schema definitions.

Firstly I need to figure out how to deploy the initial version of the schema, then we can adjust the schema itself and the tests as well.

[pubmikeb]

@BePo65, btw it looks like there is a typo in escapeCsvFilelds — is it really Filelds or Fields in https://github.com/ironSource/license-report/blob/master/lib/config.js?

/*
escape fields containing delimiter character if output is csv
*/
escapeCsvFilelds: false,

I've proposed a PR kessler/license-report#64 to address escapeCsvFilelds vs. escapeCsvFields.

[BePo65]

• definition of delimiter: shouldn't the first property be "delimiter": ",", (instead of "delimiter": ",",)?

Perhaps, copy & paste issue, in both cases "delimiter": ",", is proposed.

Of course I wanted to say that this is probably a copy and paste problem (and should say "default": ","), but then I had a copy and paste error myself ;-))

[pubmikeb]

• definition of delimiter: shouldn't the first property be "delimiter": ",", (instead of "delimiter": ",",)?

Perhaps, copy & paste issue, in both cases "delimiter": ",", is proposed.

Of course I wanted to say that this is probably a copy and paste problem (and should say "default": ","), but then I had a copy and paste error myself ;-))

Fixed.

[pubmikeb]

Finally, all tests are passed!

[BePo65]

I would just keep the original spelling as it seems to be acceptable too (I am no native speaker so my "wisdom" comes from mdn

[BePo65]

I would just keep the original spelling as it seems to be acceptable too (I am no native speaker so my "wisdom" comes from mdn

[pubmikeb]

Rollbacked to falsey.

[madskristensen]

@pubmikeb let me know when this is ready to merge

[pubmikeb]

@pubmikeb let me know when this is ready to merge

It's ready!

[madskristensen]

Thanks

[pubmikeb]

Thanks for merging the schema.

@madskristensen, how can I get this schema on https://www.schemastore.org/json?

[GerryFerdinandus]

@pubmikeb It is auto generated. It is already on the site.