Skip to content

chore: configure eslint-jsdoc-plugin#883

Open
mateuszlampert wants to merge 7 commits intomainfrom
@ml/configure-eslint-jsdoc-plugin
Open

chore: configure eslint-jsdoc-plugin#883
mateuszlampert wants to merge 7 commits intomainfrom
@ml/configure-eslint-jsdoc-plugin

Conversation

@mateuszlampert
Copy link
Contributor

@mateuszlampert mateuszlampert commented Feb 26, 2026

Description

This PR configures eslint-jsdoc-plugin so:

  • JSDocs are consistent throughout codebase and jsdocs are consistent with method/interface signature
  • there is defined set of @category tag values to prevent typos and generating additional sections in docs
  • fixed few jsdocs manually

Introduces a breaking change?

  • Yes
  • No

Type of change

  • Bug fix (change which fixes an issue)
  • New feature (change which adds functionality)
  • Documentation update (improves or adds clarity to existing documentation)
  • Other (chores, tests, code style improvements etc.)

Tested on

  • iOS
  • Android

Testing instructions

  • try to break some jsdocs (e. g. remove @returns tag, set @category to some value outside of values defined in eslintrc.js, change @param tag so it does not match signature) and see if eslint catches these errors.
  • build and open docs locally and check out if api reference is valid

Screenshots

Related issues

#831

Checklist

  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have updated the documentation accordingly
  • My changes generate no new warnings

Additional notes

NOTE: for now I switched off required destructured params as that's the convention we are mostly using, but we could move to destructured params eventually.

@mateuszlampert mateuszlampert self-assigned this Feb 26, 2026
@mateuszlampert mateuszlampert added the dev exp This issue tackles problems with developer experience e.g. debbuging label Feb 26, 2026
@mateuszlampert mateuszlampert linked an issue Feb 26, 2026 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dev exp This issue tackles problems with developer experience e.g. debbuging

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Configure eslint-plugin-jsdoc and eslint-plugin-tsdoc

1 participant