Skip to content

chore(eslint): disable jsdoc/require-param-type rule in favor of typescript#7326

Merged
benelan merged 2 commits intomainfrom
benelan/disable-jsdoc-types-eslint-rule
Jul 17, 2023
Merged

chore(eslint): disable jsdoc/require-param-type rule in favor of typescript#7326
benelan merged 2 commits intomainfrom
benelan/disable-jsdoc-types-eslint-rule

Conversation

@benelan
Copy link
Copy Markdown
Contributor

@benelan benelan commented Jul 17, 2023

Related Issue: #7319

Summary

Disables the jsdoc/require-param-type eslint rule since we use TypeScript for that.

@github-actions github-actions Bot added the chore Issues with changes that don't modify src or test files. label Jul 17, 2023
@benelan benelan changed the title chore(eslint): disable disable/require-param-type rule in favor of typescript chore(eslint): disable jsdoc/require-param-type rule in favor of typescript Jul 17, 2023
@benelan benelan added the skip visual snapshots Pull requests that do not need visual regression testing. label Jul 17, 2023
@jcfranco
Copy link
Copy Markdown
Member

Sharing this from our convo for additional context: this will reduce linting noise we would get by not specifying the type in JSDoc, especially since the JSDoc type info isn't available in the build output.

@benelan benelan merged commit 90c3a61 into main Jul 17, 2023
@benelan benelan deleted the benelan/disable-jsdoc-types-eslint-rule branch July 17, 2023 22:02
@github-actions github-actions Bot added this to the Design Sprint milestone Jul 17, 2023
benelan added a commit that referenced this pull request Jul 18, 2023
…amping-ar-numberingsystem-bug

* origin/main:
  chore(eslint): disable jsdoc/require-param-type rule in favor of typescript (#7326)
  style: lint and format code (#7319)
  chore: add editorconfig (#7318)
  chore: release next
  fix(input-date-picker): provides placeholder text context for AT users (#7320)
  chore: release next
  fix(dropdown-item): provides accessible label when href is not parsed (#7316)
  ci: create more specific codeowners to limit unnecessary notifications (#7313)
driskull added a commit that referenced this pull request Sep 15, 2023
**Related Issue:** None

## Summary

Disables ESlint rule
["jsdoc/require-returns-type"](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns-type.md#readme)
since we rely on TypeScript.

This builds upon
#7326.
benelan added a commit that referenced this pull request Sep 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore Issues with changes that don't modify src or test files. skip visual snapshots Pull requests that do not need visual regression testing.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants