Initial feedback

[kemitchell]

I would very much appreciate feedback on a rough draft of a dotfile format for license-compliance rules. The draft borrows heavily from EditorConfig's structure and approach.

This might an ideal way to address davglass/license-checker#32

Of potential interest to @othiym23, @sindresorhus, @davglass, @anseljh, @shinnn, @hughsk

If you'd like to be part of the GitHub org, just holler.

Trying to act fast while the spirit moves me and I have a little time)))

[davidtheclark]

Could this be flexible in the format of the config? People have their configuration preferences, and some will probably like this style, while others will want to put in their package.json (so has to be JSON), while others will want it in YAML, etc.

Allowing a flexible format for the key-value pairs could also allow tools like rc and cosmiconfig to find and parse the config.

I have no idea if this is a good idea in this kind of spec or not — just something I thought of.

[kemitchell]

@davidtheclark, thanks for the feedback.

I suppose implementation of license checking, like licenserc.js could as easily take structured input describing license constraints as config file text. That may very well be a worthwhile paring-down of that package as it is now, with a built-in config file parser.

But I'm reluctant to distract myself too much from the purpose of licenserc with support for widely varying configuration preferences. The file format described in the spec is dead simple in part so it's easy to generate:

{ "devDependencies": {
    "licenserc": "^1.0.0" },
  "licenserc": {
    "link": "(MIT OR BSD-2-Clause OR Apache-2.0)" },
  "scripts": {
    "preaudit": "node prepare-licenserc-config.js > .licenserc",
    "audit": "licenserc",
    "postaudit": "rm .licenserc" } }

console.log("# Generated by prepare-licenserc-config.js")
var config = require('./package.json').licenserc
Object.keys(config).forEach(function(key) {
  console.log(key + ': ' + config[key]) })

The above were typed out freehand. I haven't tested them.

[davidtheclark]

Yes, I agree that this is a peripheral concern.

Sent from my iPhone

On Jan 25, 2016, at 12:31 AM, Kyle Mitchell [email protected] wrote:

@davidtheclark, thanks for the feedback.

I suppose implementation of license checking, like licenserc.js could as easily take structured input describing license constraints as config file text. That may very well be a worthwhile paring-down of that package as it is now, with a built-in config file parser.

But I'm reluctant to distract myself too much from the purpose of licenserc with support for widely varying configuration preferences. The file format described in the spec is dead simple in part so it's easy to generate:

{ "devDependencies": {
"licenserc": "^1.0.0" },
"licenserc": {
"link": "(MIT OR BSD-2-Clause OR Apache-2.0)" },
"scripts": {
"preaudit": "node prepare-licenserc-config.js > .licenserc",
"audit": "licenserc",
"postaudit": "rm .licenserc" } }
console.log("# Generated by prepare-licenserc-config.js")
var config = require('./package.json').licenserc
Object.keys(config).forEach(function(key) {
console.log(key + ': ' + config[key]) })
The above were typed out freehand. I haven't tested them.

—
Reply to this email directly or view it on GitHub.

[kgryte]

@kemitchell What is the status of the specification? Was it exploratory, or actually being used in the wild?