wix-storybook-utils/dist/src/Sections/create-default-sections.test.js

Utilities for automated component documentation within Storybook

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
var deep_assign_1 = require("../../test/utils/deep-assign");
var story_section_1 = require("../typings/story-section");
var create_default_sections_1 = require("./create-default-sections");
var _1 = require(".");
var storyConfig = function (config) {
    if (config === void 0) { config = {}; }
    return (0, deep_assign_1.deepAssign)({
        config: {},
        metadata: {},
        exampleImport: {},
        examples: {},
    }, config);
};
describe('createDefaultSection', function () {
    describe('header section', function () {
        it('should be first one', function () {
            var firstSection = (0, create_default_sections_1.createDefaultSections)(storyConfig())[0];
            expect(firstSection.type).toEqual(story_section_1.SectionType.Header);
        });
        it('should merge config from sections', function () {
            var headerConfig = {
                issueUrl: 'hello',
                sourceUrl: 'from',
                component: 'test',
            };
            var firstSection = (0, create_default_sections_1.createDefaultSections)(storyConfig({ sections: [(0, _1.header)(headerConfig)] }))[0];
            expect(firstSection).toEqual(expect.objectContaining(headerConfig));
        });
        it('should display sourceUrl for component stories', function () {
            var config = storyConfig({
                metadata: {
                    displayName: 'name',
                },
                config: {
                    repoBaseURL: 'base/',
                },
            });
            var firstSection = (0, create_default_sections_1.createDefaultSections)(config)[0];
            expect(firstSection.sourceUrl).toEqual('base/name');
        });
        describe('title', function () {
            it('should be taken from displayName', function () {
                var displayName = 'best name';
                var config = storyConfig({
                    metadata: {
                        displayName: displayName,
                    },
                });
                var firstSection = (0, create_default_sections_1.createDefaultSections)(config)[0];
                expect(firstSection.title).toEqual(displayName);
            });
            it('should prioritize storyName', function () {
                var storyName = 'besterer name';
                var config = storyConfig({
                    storyName: storyName,
                    metadata: {
                        displayName: 'i should be ignored',
                    },
                });
                var firstSection = (0, create_default_sections_1.createDefaultSections)(config)[0];
                expect(firstSection.title).toEqual(storyName);
            });
        });
    });
});
//# sourceMappingURL=create-default-sections.test.js.map