BREAKING: Update jsdoc/require-jsdoc to require documentation for more things

[Mrtenz]

This updates the jsdoc/require-jsdoc rule to require documentation for:

• Arrow functions.

  const myFunction = () => {
    // ...
  };

• Class declarations.

  class MyClass {
    // ...
  }

• TypeScript enum declarations.

  enum MyEnum {
    // ...
  };

• Function expressions.

  const myFunction = function () {
    // ...
  };

• TypeScript interface declarations.

  interface MyInterface {
    // ...
  };

• Method definitions.

  const myObject = {
    myFunction() {
      // ...
    },
  };

• TypeScript type alias declarations.

  type MyType = {
    // ...
  };

• TypeScript property signatures.

  type MyType = {
    myProperty: string;
  };

Breaking changes

Each of the code blocks above was previously valid, but will now produce an error.

Closes #223.

---

Note

Expands jsdoc/require-jsdoc to require JSDoc on more JS/TS constructs and adds a brief doc comment to ConfigWithExtends.extends.

• ESLint config (packages/base/src/index.mjs, packages/base/rules-snapshot.json):
  • Expand jsdoc/require-jsdoc from a simple enablement to a configured rule requiring docs for:
    • ArrowFunctionExpression, ClassDeclaration, FunctionDeclaration, FunctionExpression, MethodDefinition.
    • TS contexts: TSInterfaceDeclaration, TSTypeAliasDeclaration, TSEnumDeclaration, TSPropertySignature.
• Types (packages/base/src/index.d.mts):
  • Add JSDoc for ConfigWithExtends.extends detailing supported shapes.

^{Written by Cursor Bugbot for commit e0efa13. This will update automatically on new commits. Configure here.}

[mcmire]

Nice, I didn't realize it was this easy!

@Mrtenz Any place we've tried this out yet? If not I will try this out in core.

[Mrtenz]

Nice, I didn't realize it was this easy!

@Mrtenz Any place we've tried this out yet? If not I will try this out in core.

@mcmire I've tried it in a small repo to make sure the rule works as expected, but I haven't tested it in core or snaps yet.

I expect there will be a lot of lint errors since this is quite strict, but that's something we can gradually tackle.

[Gudahtt]

LGTM! Maybe we should avoid merging this until after we cut a release for the non-breaking changes though