fbredius/storybook

File jsdocParser.test.ts has 254 lines of code (exceeds 250 allowed). Consider refactoring.

Open

import { parseJsDoc } from './jsdocParser';

describe('parseJsDoc', () => {
  it('should set includesJsDoc to false when the value is null', () => {
    const { includesJsDoc, description, extractedTags } = parseJsDoc(null);

Similar blocks of code found in 2 locations. Consider refactoring.

Open

    it('should support multiline @returns description', () => {
      const { extractedTags } = parseJsDoc(
        '@returns {string} - This is\na multiline\ndescription\n'
      );

• Read up
  Read up

Similar blocks of code found in 2 locations. Consider refactoring.

Open

    it('should return a @returns with a type and a description', () => {
      const { extractedTags } = parseJsDoc('@returns {string} - A bar description');

      expect(extractedTags.returns).not.toBeNull();
      expect(extractedTags.returns.type).not.toBeNull();

• Read up
  Read up

Similar blocks of code found in 2 locations. Consider refactoring.

Open

    it('should return a @returns with a type', () => {
      const { extractedTags } = parseJsDoc('@returns {string}');

      expect(extractedTags.returns).not.toBeNull();
      expect(extractedTags.returns.type).not.toBeNull();

• Read up
  Read up

Similar blocks of code found in 2 locations. Consider refactoring.

Open

    it('should only consider the last @returns tag when there is multiple', () => {
      const { extractedTags } = parseJsDoc('@returns {string}\n@returns {number}');

      expect(extractedTags.returns).not.toBeNull();
      expect(extractedTags.returns.type).not.toBeNull();

• Read up
  Read up

Similar blocks of code found in 2 locations. Consider refactoring.

Open

    it('should set ignore to true when @ignore is present', () => {
      const { ignore, description, extractedTags } = parseJsDoc('Hey!\n@ignore');

      expect(ignore).toBeTruthy();
      expect(description).toBeUndefined();

• Read up
  Read up

Similar blocks of code found in 2 locations. Consider refactoring.

Open

  it('should set includesJsDocto to false when the value dont contains JSDoc', () => {
    const { includesJsDoc, description, extractedTags } = parseJsDoc('Hey!');

    expect(includesJsDoc).toBeFalsy();
    expect(description).toBeUndefined();

• Read up
  Read up

Similar blocks of code found in 14 locations. Consider refactoring.

Open

      it('should return @param name', () => {
        const { extractedTags } = parseJsDoc('@param {SyntheticEvent} event - React event');

        expect(extractedTags.params[0].getPrettyName()).toBe('event');
      });

• Read up
  Read up

Similar blocks of code found in 14 locations. Consider refactoring.

Open

      it('should support nullable type', () => {
        const { extractedTags } = parseJsDoc('@param {?number} event');

        expect(extractedTags.params[0].getTypeName()).toBe('number');
      });

• Read up
  Read up

Similar blocks of code found in 14 locations. Consider refactoring.

Open

      it('should fix missing space between the @param name and the description separator', () => {
        const { extractedTags } = parseJsDoc('@param {SyntheticEvent} event- React event');

        expect(extractedTags.params[0].getPrettyName()).toBe('event');
      });

• Read up
  Read up

Similar blocks of code found in 14 locations. Consider refactoring.

Open

      it('should support union type', () => {
        const { extractedTags } = parseJsDoc('@param {(number|boolean)} event');

        expect(extractedTags.params[0].getTypeName()).toBe('(number|boolean)');
      });

• Read up
  Read up

Similar blocks of code found in 14 locations. Consider refactoring.

Open

      it('should support optional param with []', () => {
        const { extractedTags } = parseJsDoc('@param {number} [event]');

        expect(extractedTags.params[0].getTypeName()).toBe('number');
      });

• Read up
  Read up

Similar blocks of code found in 14 locations. Consider refactoring.

Open

      it('should support record type with multiple fields', () => {
        const { extractedTags } = parseJsDoc('@param {{a: number, b: string}} event');

        expect(extractedTags.params[0].getTypeName()).toBe('({a: number, b: string})');
      });

• Read up
  Read up

Similar blocks of code found in 14 locations. Consider refactoring.

Open

      it('should support optional param with =', () => {
        const { extractedTags } = parseJsDoc('@param {number=} event');

        expect(extractedTags.params[0].getTypeName()).toBe('number');
      });

• Read up
  Read up

Similar blocks of code found in 14 locations. Consider refactoring.

Open

      it('should fix @param name ending with . followed by a @returns tag', () => {
        const { extractedTags } = parseJsDoc('@param {SyntheticEvent} event.\n');

        expect(extractedTags.params[0].getPrettyName()).toBe('event');
      });

• Read up
  Read up

Similar blocks of code found in 14 locations. Consider refactoring.

Open

      it('should support untyped array type', () => {
        const { extractedTags } = parseJsDoc('@param {[]} event');

        expect(extractedTags.params[0].getTypeName()).toBe('[]');
      });

• Read up
  Read up

Similar blocks of code found in 14 locations. Consider refactoring.

Open

      it('should support any type', () => {
        const { extractedTags } = parseJsDoc('@param {*} event');

        expect(extractedTags.params[0].getTypeName()).toBe('any');
      });

• Read up
  Read up

Similar blocks of code found in 14 locations. Consider refactoring.

Open

      it('should support record type with a single field', () => {
        const { extractedTags } = parseJsDoc('@param {{a: number}} event');

        expect(extractedTags.params[0].getTypeName()).toBe('({a: number})');
      });

• Read up
  Read up

Similar blocks of code found in 14 locations. Consider refactoring.

Open

      it('should support non nullable type', () => {
        const { extractedTags } = parseJsDoc('@param {!number} event');

        expect(extractedTags.params[0].getTypeName()).toBe('number');
      });

• Read up
  Read up

Similar blocks of code found in 14 locations. Consider refactoring.

Open

      it('should support record type with a field having only a name', () => {
        const { extractedTags } = parseJsDoc('@param {{a}} event');

        expect(extractedTags.params[0].getTypeName()).toBe('({a})');
      });

• Read up
  Read up

Similar blocks of code found in 14 locations. Consider refactoring.

Open

      it('should support array type', () => {
        const { extractedTags } = parseJsDoc('@param {number[]} event');

        expect(extractedTags.params[0].getTypeName()).toBe('number[]');
      });

• Read up
  Read up

Similar blocks of code found in 9 locations. Consider refactoring.

Open

      it('should support array type', () => {
        const { extractedTags } = parseJsDoc('@returns {integer[]}');

        expect(extractedTags.returns.getTypeName()).toBe('integer[]');
      });

• Read up
  Read up

Similar blocks of code found in 9 locations. Consider refactoring.

Open

      it('should support union type', () => {
        const { extractedTags } = parseJsDoc('@returns {(number|boolean)}');

        expect(extractedTags.returns.getTypeName()).toBe('(number|boolean)');
      });

• Read up
  Read up

Similar blocks of code found in 9 locations. Consider refactoring.

Open

      it('should support record type with multiple fields', () => {
        const { extractedTags } = parseJsDoc('@returns {{a: number, b: string}}');

        expect(extractedTags.returns.getTypeName()).toBe('({a: number, b: string})');
      });

• Read up
  Read up

Similar blocks of code found in 9 locations. Consider refactoring.

Open

      it('should support record type with a single field', () => {
        const { extractedTags } = parseJsDoc('@returns {{a: number}}');

        expect(extractedTags.returns.getTypeName()).toBe('({a: number})');
      });

• Read up
  Read up

Similar blocks of code found in 9 locations. Consider refactoring.

Open

      it('should support untyped array type', () => {
        const { extractedTags } = parseJsDoc('@returns {[]}');

        expect(extractedTags.returns.getTypeName()).toBe('[]');
      });

• Read up
  Read up

Similar blocks of code found in 9 locations. Consider refactoring.

Open

      it('should support record type with a field having only a name', () => {
        const { extractedTags } = parseJsDoc('@returns {{a}}');

        expect(extractedTags.returns.getTypeName()).toBe('({a})');
      });

• Read up
  Read up

Similar blocks of code found in 9 locations. Consider refactoring.

Open

      it('should support named type', () => {
        const { extractedTags } = parseJsDoc('@returns {string}');

        expect(extractedTags.returns.getTypeName()).toBe('string');
      });

• Read up
  Read up

Similar blocks of code found in 9 locations. Consider refactoring.

Open

      it('should support any type', () => {
        const { extractedTags } = parseJsDoc('@returns {*}');

        expect(extractedTags.returns.getTypeName()).toBe('any');
      });

• Read up
  Read up

Similar blocks of code found in 9 locations. Consider refactoring.

Open

      it('should support void', () => {
        const { extractedTags } = parseJsDoc('@returns {void}');

        expect(extractedTags.returns.getTypeName()).toBe('void');
      });

• Read up
  Read up

Similar blocks of code found in 2 locations. Consider refactoring.

Open

    it('should ignore invalid @returns', () => {
      const { extractedTags } = parseJsDoc('@returns');

      expect(extractedTags.returns).toBeNull();
    });

• Read up
  Read up

Similar blocks of code found in 2 locations. Consider refactoring.

Open

    it('should ignore invalid @param tags', () => {
      const { extractedTags } = parseJsDoc('@param');

      expect(extractedTags.params).toBeNull();
    });

• Read up
  Read up