noBadBlocks.js

export default {
  invalid: [
    {
      code: `
          /*
           * @param foo
           */
          function quux (foo) {

          }
      `,
      errors: [
        {
          line: 2,
          message: 'Expected JSDoc-like comment to begin with two asterisks.',
        },
      ],
      output: `
          /**
           * @param foo
           */
          function quux (foo) {

          }
      `,
    },
    {
      code: `
          /*
           * @property foo
           */
      `,
      errors: [
        {
          line: 2,
          message: 'Expected JSDoc-like comment to begin with two asterisks.',
        },
      ],
      output: `
          /**
           * @property foo
           */
      `,
    },
    {
      code: `
          function quux() {

          }
      `,
      errors: [
        {
          line: 1,
          message: 'Cannot add "name" to `require` with the tag\'s `name` set to `false`',
        },
      ],
      settings: {
        jsdoc: {
          structuredTags: {
            see: {
              name: false,
              required: [
                'name',
              ],
            },
          },
        },
      },
    },
    {
      code: '/* @ts-ignore */',
      errors: [
        {
          line: 1,
          message: 'Expected JSDoc-like comment to begin with two asterisks.',
        },
      ],
      options: [
        {
          ignore: [],
        },
      ],
      output: '/** @ts-ignore */',
    },
    {
      code: `
      /*
       * Some description.
       *
       * @returns {string} Some string
       */
      function echo() {
        return 'Something';
      }
      `,
      errors: [
        {
          line: 2,
          message: 'Expected JSDoc-like comment to begin with two asterisks.',
        },
      ],
      output: `
      /**
       * Some description.
       *
       * @returns {string} Some string
       */
      function echo() {
        return 'Something';
      }
      `,
    },
    {
      code: `
          /***
           * @param foo
           */
          function quux (foo) {

          }
      `,
      errors: [
        {
          line: 2,
          message: 'Expected JSDoc-like comment to begin with two asterisks.',
        },
      ],
      output: `
          /**
           * @param foo
           */
          function quux (foo) {

          }
      `,
    },
    {
      code: `
          /***
           *
           */
          function quux (foo) {

          }
      `,
      errors: [
        {
          line: 2,
          message: 'Expected JSDoc-like comment to begin with two asterisks.',
        },
      ],
      options: [
        {
          preventAllMultiAsteriskBlocks: true,
        },
      ],
      output: `
          /**
           *
           */
          function quux (foo) {

          }
      `,
    },
  ],
  valid: [
    {
      code: `
          /**
           * @property foo
           */
      `,
    },
    {
      code: `
          /**
           * @param foo
           */
           function quux () {

           }
      `,
    },
    {
      code: `
      function quux () {

      }
      `,
    },
    {
      code: `
           /* This could just be intended as a regular multiline comment,
              so don't report this */
           function quux () {

           }
      `,
    },
    {
      code: `
           /* Just a regular multiline comment with an \`@\` but not appearing
               like a tag in a jsdoc-block, so don't report */
           function quux () {

           }
      `,
    },
    {
      code: '/* @ts-check */',
    },
    {
      code: '/* @ts-expect-error */',
    },
    {
      code: '/* @ts-ignore */',
    },
    {
      code: '/* @ts-nocheck */',
    },
    {
      code: '/* */',
    },
    {
      code: '/** */',
    },
    {
      code: '/* @custom */',
      options: [
        {
          ignore: [
            'custom',
          ],
        },
      ],
    },
    {
      code: `
          /***
           * This is not JSDoc because of the 3 asterisks, but
           * is allowed without \`preventAllMultiAsteriskBlocks\`, as
           * some might wish normal multiline comments.
           */
          function quux (foo) {

          }
      `,
    },
    {
      code: '/***/',
    },
  ],
};