getConfig will assign default options to generated config

[PalleZingmark]

Fix for #409

[SimenB]

Needs a test.

(thanks for sending a PR!)

[SimenB]

var group = this.config.groupOutputByFile != null ? this.config.groupOutputByFile : true

[PalleZingmark]

Looking into writing tests for this, I actually get some weird output (on master) which to me looks a bit unintended within the test. Is this a bug or intended behaviour?

[PalleZingmark]

I need to update tests.

[SimenB]

@PalleZingmark not so much intended as known 🙂 Fixed in v2, FWIW

[PalleZingmark]

Updated tests according to the approach discussed in #409.
Here's my thoughts on the tests:

describe( 'Set Config should:', function() {
    process.argv[2] = '-c'
    process.argv[3] = '.stylintrc'
    var testMethod = app.setConfig( '.stylintrc' )
    var testConfig = app.setConfig( process.cwd() + '/.stylintrc' )

    it( 'return complete config when not complete config is passed in', function() {
        assert.ok( testConfig.reporter )
    } )

    it( 'update config state if passed a valid path', function() {
        assert.equal( Object.keys( testConfig ).length, Object.keys( testMethod ).length )
    } )

    it( 'throw if passed invalid path', function() {
        assert.throws(
            app.setConfig,
            TypeError,
            'setConfig err. Expected string, but received: ' + typeof dir
        )
    } )
} )

testMethod: Contains a config generated based on the default config options.
testConfig: Contains a config for test, generated on a .stylintrc that doesn't contain a full set of options.

Test 1

it( 'return complete config when not complete config is passed in', function() {
    assert.ok( testConfig.reporter )
} )

setConfig() should return a config with the reporter-option included even though it's not part of the actual .stylintrc file passed to the function.

Test 2

it( 'update config state if passed a valid path', function() {
    assert.equal( Object.keys( testConfig ).length, Object.keys( testMethod ).length )
} )

Make sure setConfig returns just as many options as testMethod even though the actual .stylintrc file passed to the function contains fever options.

[justiceenunciate]

Thanks for your PR, @PalleZingmark ! Just a few, belated comments on this PR for your tests.

[justiceenunciate]

Nice test! Can we paraphrase a bit to avoid ambiguity with what complete means here?

Perhaps something like:

it( 'return config with all properties when passed config with missing properties', function() {

What do you think?

[PalleZingmark]

Sounds good, I'll update the PR. Thnx.

[justiceenunciate]

Why are we changing this test? If we must change this, we should still check for deep equality between two objects since doing key comparisons can lead to false positives.

[PalleZingmark]

Trying to remember this one.. 😣

I think I changed it since the important part is that they should contain the same amount of options now, not the exact same values since they may vary. I'll try to dig out my old notes.