Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Fix more lint warnings #9690

Merged
merged 4 commits into from
Jul 12, 2024
Merged

chore: Fix more lint warnings #9690

merged 4 commits into from
Jul 12, 2024

Conversation

gibson042
Copy link
Member

Ref #9632

Description

  • Fix bad JSDoc @imports
  • Make eslint-plugin-jsdoc aware of TypeDoc tags

Security Considerations

None; this PR only affects JSDoc comments.

Scaling Considerations

n/a

Documentation Considerations

Existing TypeDoc annotations are preserved and explicit support for currently-unused ones is added.

Testing Considerations

This should resolve all Bad @import tag and Invalid JSDoc tag name linter complaints. It currently upgrades rule check-tag-names violations to level "error" since we should not be using any unknown tags, but that could be relaxed if we find such configuration to be overly strict.

Upgrade Considerations

None.

Copy link
Member

@turadg turadg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the hygiene.

Import lines should end in ;. I haven't linted it because I expect we'll automate that with prettier someday but consider doing it in the lines you're touching.

@turadg turadg mentioned this pull request Jul 11, 2024
Copy link

cloudflare-workers-and-pages bot commented Jul 12, 2024

Deploying agoric-sdk with  Cloudflare Pages  Cloudflare Pages

Latest commit: 02ff11e
Status: ✅  Deploy successful!
Preview URL: https://7b0de255.agoric-sdk.pages.dev
Branch Preview URL: https://gibson-9632-jsdoc.agoric-sdk.pages.dev

View logs

Copy link
Contributor

@siarhei-agoric siarhei-agoric left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks Good!

@gibson042 gibson042 added the automerge:rebase Automatically rebase updates, then merge label Jul 12, 2024
@gibson042 gibson042 force-pushed the gibson-9632-jsdoc branch from 7458a1c to 0199a0b Compare July 12, 2024 21:15
@gibson042 gibson042 force-pushed the gibson-9632-jsdoc branch from 0199a0b to 02ff11e Compare July 12, 2024 22:22
@mergify mergify bot merged commit cc6a9e5 into master Jul 12, 2024
78 checks passed
@mergify mergify bot deleted the gibson-9632-jsdoc branch July 12, 2024 22:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automerge:rebase Automatically rebase updates, then merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants