lakitna / mocha-bundle-ui Goto Github PK

Is your feature request related to a problem? Please describe.
README.md has become a big file making it difficult to find certain stuff. The level of detail is also not great.

Describe the solution you'd like
Split up the documentation into manageable chunks, improve the level of detail.

Files:

• README
• BDD-bundle
• TDD-bundle
• (Using bundle in your UI)

While working on this a file structure overhaul might be a good idea.

Is your feature request related to a problem? Please describe.
Right now bundle.beforeEach requires done. It would be nice if this would also the Mocha sync way.

Describe the solution you'd like
Allow both situations below to work

bundle('foo', function(done) {
    // ...
    done();
});

bundle('foo', function() {
    // ...
});

• General improvements in stability and readability | PR: #14
• Bundle on strings | Issue: #10 PR: #11
• Allow bundles to work in a then block | Issue: #12 PR: #17
• Default bundle values for object-based bundles. | Issue: #20 (requires investigation, removes limitation)
• Make done() optional for bundle.beforeEach and before.afterEach. | Issue: #18 PR: #21
• Split up and improve documentation for every supported UIs. | Issue: #19 PR: #22

Is your feature request related to a problem? Please describe.
It would be nice if you could use default values when bundling. This could simplify some implementations greatly.

Describe the solution you'd like
Add support for the following

bundle.defaultParameters = {
    foo: 'bar',
};

or possibly

bundle.defaultParameters({
    foo: 'bar',
});

Additional context
Due to the order of operations setting the default parameters might happen after some bundles have been created. This will make things very annoying and might require the parameters to be set somewhere before mocha starts gathering files.

Is your feature request related to a problem? Please describe.
The way a bundle description is structured doesn't work for every project.

Describe the solution you'd like
I want to be able to change the bundle description in bundle.beforeEach

Is your feature request related to a problem? Please describe.
By default a describe block inside a then block works, but bundle does not at the moment. It would be nice to be able to do this to more flexibly create programmatic tests.

Describe the solution you'd like

asyncFoo()
    .then((val) => {
        bundle({foo: 'bar'}, function() {
            it(`does a thing with ${val}`);
        });
    });

Describe alternatives you've considered
None at the moment

Is your feature request related to a problem? Please describe.
In simple situations, it would be nice if instead of an object a short string could be provided.

Describe the solution you'd like
Instead of requiring bundle parameters to be an object, also allow a string.

Describe alternatives you've considered
A default parameters key, but that's not a very clean solution.