jsdoc/test/specs/documentation/objectlit.js

/* global jsdoc */
describe('object literals', () => {
    describe('When a child of an objlit has no @name or @memberof tags', () => {
        const docSet = jsdoc.getDocSetFromFile('test/fixtures/objectlit.js');
        const found = docSet.getByLongname('tools.serialiser.value');

        it('should have a doclet with the correct longname', () => {
            expect(found.length).toBe(1);
        });

        it('should have a doclet with the correct name', () => {
            expect(found[0].name).toBe('value');
        });

        it('should have the correct memberof', () => {
            expect(found[0].memberof).toBe('tools.serialiser');
        });

        it('should have a static scope', () => {
            expect(found[0].scope).toBe('static');
        });
    });

    describe('When a parent of an objlit has no documentation', () => {
        const docSet = jsdoc.getDocSetFromFile('test/fixtures/objectlit2.js');
        const found = docSet.getByLongname('position.axis.x');

        it('should have a doclet with the correct longname', () => {
            expect(found.length).toBe(1);
        });

        it('should have a doclet with the correct name', () => {
            expect(found[0].name).toBe('x');
        });

        it('should have the correct memberof', () => {
            expect(found[0].memberof).toBe('position.axis');
        });

        it('should have a static scope', () => {
            expect(found[0].scope).toBe('static');
        });
    });

    describe('When an object literal\'s property names must be escaped in a regexp', () => {
        function loadDocSet() {
            /* eslint-disable no-unused-vars */
            const docSet = jsdoc.getDocSetFromFile('test/fixtures/objectlit3.js');
            /* eslint-enable no-unused-vars */
        }

        it('should not throw an error when creating a doclet', () => {
            expect(loadDocSet).not.toThrow();
        });

        it('should have a doclet with the correct name', () => {
            const docSet = jsdoc.getDocSetFromFile('test/fixtures/objectlit3.js');
            const found = docSet.getByLongname('tokens."(".before');

            expect(found[0].name).toBe('before');
        });

        it('should have a doclet with the correct memberof', () => {
            const docSet = jsdoc.getDocSetFromFile('test/fixtures/objectlit3.js');
            const found = docSet.getByLongname('tokens."(".before');

            expect(found[0].memberof).toBe('tokens."("');
        });
    });
});