Rule Proposal: lines-around-commonjs-default-exports

From requirePaddingNewLinesBeforeExport and disallowPaddingNewLinesBeforeExport.

This rule will require/disallow blank lines before/after the assignment of module.exports.

{
    "lines-around-commonjs-default-exports": ["error", "always" or "never"],
    // or
    "lines-around-commonjs-default-exports": ["error", {
        "after": "always" or "never",
        "before": "always" or "never"
    }]
}

Valid:

/*eslint lines-around-commonjs-default-exports: ["error", "always"]*/
var a = 2;

module.exports = a;

if (cond) {
   module.exports = a;  // ignore at the first/last of a block. this is warned by padded-blocks
}

/*eslint lines-around-commonjs-default-exports: ["error", "never"]*/
var a = 2;
module.exports = a;
if (cond) {

   module.exports = a;  // ignore at the first/last of a block. this is warned by padded-blocks

}

Invalid:

/*eslint lines-around-commonjs-default-exports: ["error", "always"]*/
var a = 2;
module.exports = a;
foo();

/*eslint lines-around-commonjs-default-exports: ["error", "never"]*/
var a = 2;

module.exports = a;

foo();

[TheSavior]

imo, it’s fine to ship without it being fixable. Adding that in the future should be a reasonable thing to do.

[mysticatea]

If it handles exports, I remove -default from the rule name and imagine options:

{
    "lines-around-commonjs-exports": ["error", "always" or "never"],
    // or
    "lines-around-commonjs-exports": ["error", {
        "module.exports": "always" or "never" or "ignore",
        "exports": "always" or "never" or "ignore"
    }]
    // or
    "lines-around-commonjs-exports": ["error", {
        "module.exports": {
            "after": "always" or "never" or "ignore",
            "before": "always" or "never" or "ignore"
        },
        "exports": {
            "after": "always" or "never" or "ignore",
            "before": "always" or "never" or "ignore"
        }
    }]
}

// Schema
{
    "definitions": {
        "optionValue": {
            "anyOf": [
                {"enum": ["always", "never", "ignore"]},
                {
                    "type": "object",
                    "properties": {
                        "after": {"enum": ["always", "never", "ignore"]},
                        "before": {"enum": ["always", "never", "ignore"]}
                    },
                    "additionalProperties": false
                }
            ]
        }
    },
    "anyOf": [
        {"enum": ["always", "never"]},
        {
            "type": "object",
            "properties": {
                "module.exports": {"$ref": "#/definitions/optionValue"},
                "exports": {"$ref": "#/definitions/optionValue"}
            },
            "additionalProperties": false
        }
    ]
}

// Examples
{
    "lines-around-commonjs-exports": "error",

    "lines-around-commonjs-exports": ["error", "never"],

    "lines-around-commonjs-exports": ["error", {
        "module.exports": {"before": "always"},
        "exports": "ignore"
    }],
}