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.

Sign up for GitHub

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

Jump to bottom

Fix Lint issues in agoric-sdk #9632

Closed
toliaqat opened this issue Jul 1, 2024 · 0 comments · Fixed by #9975
Closed

Fix Lint issues in agoric-sdk #9632

toliaqat opened this issue Jul 1, 2024 · 0 comments · Fixed by #9975
Assignees
@siarhei-agoric
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@toliaqat
Copy link
Contributor

toliaqat commented Jul 1, 2024

What is the Problem Being Solved?

Every PR shows some lint issue that we should cleanup. After fixing these Lint issues, we should force that no new lint issues are introduced.

Description of the Design

Security Considerations

Scaling Considerations

Test Plan

No lint warnings in the PRs.

Upgrade Considerations
@toliaqat toliaqat added enhancement New feature or request good first issue Good for newcomers labels Jul 1, 2024
siarhei-agoric added a commit that referenced this issue Jul 11, 2024
@siarhei-agoric
chore: Resolve Array.forEach lint warnings
c7687e8 
Fixes #9632
@siarhei-agoric siarhei-agoric mentioned this issue Jul 11, 2024
Merged
siarhei-agoric added a commit that referenced this issue Jul 11, 2024
@siarhei-agoric
chore: Resolve Array.forEach lint warnings
bb2ce5e 
Ref #9632
gibson042 added a commit that referenced this issue Jul 11, 2024
@gibson042
chore: Fix bad JSDoc imports
e81c2ad 
Ref #9632
gibson042 added a commit that referenced this issue Jul 11, 2024
@gibson042
chore: Make eslint-plugin-jsdoc aware of TypeDoc tags
5bd25e0 
Ref #9632
@gibson042 gibson042 mentioned this issue Jul 11, 2024
Merged
gibson042 added a commit that referenced this issue Jul 12, 2024
@gibson042
chore: Fix bad JSDoc imports
496d6ac 
Ref #9632
gibson042 added a commit that referenced this issue Jul 12, 2024
@gibson042
chore: Make eslint-plugin-jsdoc aware of TypeDoc tags
0fe8afc 
Ref #9632
gibson042 added a commit that referenced this issue Jul 12, 2024
@gibson042
chore: Fix bad JSDoc imports
6c7054c 
Ref #9632
gibson042 added a commit that referenced this issue Jul 12, 2024
@gibson042
chore: Make eslint-plugin-jsdoc aware of TypeDoc tags
476229d 
Ref #9632
mergify bot added a commit that referenced this issue Jul 12, 2024
@mergify
chore: Fix more lint warnings (#9690)
cc6a9e5 
Ref #9632

## Description
* Fix bad JSDoc `@import`s
* 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`](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-tag-names.md) 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.
gibson042 pushed a commit that referenced this issue Jul 13, 2024
@siarhei-agoric @gibson042
chore: Resolve Array.forEach lint warnings
c9bf879 
Ref #9632
mergify bot added a commit that referenced this issue Jul 13, 2024
@mergify
chore: Resolve Array.forEach lint warnings (#9688)
bd50e5e 
Ref #9632

## Description
Replaced `Array.forEach();` calls with `for ( x of y ) { };` loops.

### Security Considerations
Assume that Array.forEach() calls are equivalent to `for ( x of y ) { };` in all cases.

### Scaling Considerations
No significant difference expected.

### Documentation Considerations
N/A

### Testing Considerations
No new tests required. Local tests passed, including lint (specific to this PR).

### Upgrade Considerations
The change preserves the behavior, thus there are no upgrade concerns.
@siarhei-agoric siarhei-agoric mentioned this issue Aug 26, 2024
Open
siarhei-agoric added a commit that referenced this issue Aug 26, 2024
@siarhei-agoric
chore: fix remaining lint issues (#9632)
b4149da 
refs: #9965

Fixed the following two issues:

1. packages/inter-protocol/src/proposals/startPSM.js
  351:1  warning  Expected JSDoc block to be aligned  jsdoc/check-alignment
- factored out typedef from the type cast so the cast is now a
  single-line comment.

2. packages/agoric-cli/test/inter-cli.test.js
  255:1  warning  `test.todo()` should not be used  ava/no-todo-test
  361:1  warning  `test.todo()` should not be used  ava/no-todo-test
  419:1  warning  `test.todo()` should not be used  ava/no-todo-test
  610:1  warning  `test.todo()` should not be used  ava/no-todo-test
  620:1  warning  `test.todo()` should not be used  ava/no-todo-test
  622:1  warning  `test.todo()` should not be used  ava/no-todo-test
  628:1  warning  `test.todo()` should not be used  ava/no-todo-test
- Opened a new issue #9965 to creare missing tests and commented out
  test.todo()'s

None

None.

None.

None: passed lint and type checker; actual code not affected.

None.
@siarhei-agoric siarhei-agoric mentioned this issue Aug 26, 2024
Closed
siarhei-agoric added a commit that referenced this issue Aug 27, 2024
@siarhei-agoric
chore (packages): Fix remaining lint issues (#9632)
34862ec 
closes: #3632
refs: #9965

Fixed the following two issues:

1. packages/inter-protocol/src/proposals/startPSM.js
  351:1  warning  Expected JSDoc block to be aligned  jsdoc/check-alignment
- factored out typedef from the type cast so the cast is now a
  single-line comment.

2. packages/agoric-cli/test/inter-cli.test.js
  255:1  warning  `test.todo()` should not be used  ava/no-todo-test
  361:1  warning  `test.todo()` should not be used  ava/no-todo-test
  419:1  warning  `test.todo()` should not be used  ava/no-todo-test
  610:1  warning  `test.todo()` should not be used  ava/no-todo-test
  620:1  warning  `test.todo()` should not be used  ava/no-todo-test
  622:1  warning  `test.todo()` should not be used  ava/no-todo-test
  628:1  warning  `test.todo()` should not be used  ava/no-todo-test
- Opened a new issue #9965 to create missing tests and removed test.todo()
@siarhei-agoric siarhei-agoric mentioned this issue Aug 27, 2024
Merged
siarhei-agoric added a commit that referenced this issue Aug 28, 2024
@siarhei-agoric
chore (packages): Fix remaining lint issues (#9632)
58e72d1 
closes: #3632
refs: #9965

Fixed the following two issues:

1. packages/inter-protocol/src/proposals/startPSM.js
  351:1  warning  Expected JSDoc block to be aligned  jsdoc/check-alignment
- factored out typedef from the type cast so the cast is now a
  single-line comment.

2. packages/agoric-cli/test/inter-cli.test.js
  255:1  warning  `test.todo()` should not be used  ava/no-todo-test
  361:1  warning  `test.todo()` should not be used  ava/no-todo-test
  419:1  warning  `test.todo()` should not be used  ava/no-todo-test
  610:1  warning  `test.todo()` should not be used  ava/no-todo-test
  620:1  warning  `test.todo()` should not be used  ava/no-todo-test
  622:1  warning  `test.todo()` should not be used  ava/no-todo-test
  628:1  warning  `test.todo()` should not be used  ava/no-todo-test
- Opened a new issue #9965 to create missing tests and removed test.todo()
siarhei-agoric added a commit that referenced this issue Aug 28, 2024
@siarhei-agoric
chore (packages): Fix remaining lint issues (#9632)
4c72b38 
closes: #3632
refs: #9965

Fixed the following two issues:

1. packages/inter-protocol/src/proposals/startPSM.js
  351:1  warning  Expected JSDoc block to be aligned  jsdoc/check-alignment
- factored out typedef from the type cast so the cast is now a
  single-line comment.

2. packages/agoric-cli/test/inter-cli.test.js
  255:1  warning  `test.todo()` should not be used  ava/no-todo-test
  361:1  warning  `test.todo()` should not be used  ava/no-todo-test
  419:1  warning  `test.todo()` should not be used  ava/no-todo-test
  610:1  warning  `test.todo()` should not be used  ava/no-todo-test
  620:1  warning  `test.todo()` should not be used  ava/no-todo-test
  622:1  warning  `test.todo()` should not be used  ava/no-todo-test
  628:1  warning  `test.todo()` should not be used  ava/no-todo-test
- Opened a new issue #9965 to create missing tests and removed test.todo()
siarhei-agoric added a commit that referenced this issue Aug 28, 2024
@siarhei-agoric
chore (packages): Fix remaining lint issues (#9632)
b9c90aa 
closes: #3632
refs: #9965

Fixed the following two issues:

1. packages/inter-protocol/src/proposals/startPSM.js
  351:1  warning  Expected JSDoc block to be aligned  jsdoc/check-alignment
- factored out typedef from the type cast so the cast is now a
  single-line comment.

2. packages/agoric-cli/test/inter-cli.test.js
  255:1  warning  `test.todo()` should not be used  ava/no-todo-test
  361:1  warning  `test.todo()` should not be used  ava/no-todo-test
  419:1  warning  `test.todo()` should not be used  ava/no-todo-test
  610:1  warning  `test.todo()` should not be used  ava/no-todo-test
  620:1  warning  `test.todo()` should not be used  ava/no-todo-test
  622:1  warning  `test.todo()` should not be used  ava/no-todo-test
  628:1  warning  `test.todo()` should not be used  ava/no-todo-test
- Opened a new issue #9965 to create missing tests and removed test.todo()
@mergify mergify bot closed this as completed in #9975 Aug 28, 2024
mergify bot added a commit that referenced this issue Aug 28, 2024
@mergify
chore (packages): Fix remaining lint issues (#9632) (#9975)
12c0dab 
closes: #9632 
refs: #9965 

## Description
Fixed the following two issues:

    1. packages/inter-protocol/src/proposals/startPSM.js
      351:1  warning  Expected JSDoc block to be aligned  jsdoc/check-alignment
    - factored out typedef from the type cast so the cast is now a
      single-line comment.

    2. packages/agoric-cli/test/inter-cli.test.js
      255:1  warning  `test.todo()` should not be used  ava/no-todo-test
      361:1  warning  `test.todo()` should not be used  ava/no-todo-test
      419:1  warning  `test.todo()` should not be used  ava/no-todo-test
      610:1  warning  `test.todo()` should not be used  ava/no-todo-test
      620:1  warning  `test.todo()` should not be used  ava/no-todo-test
      622:1  warning  `test.todo()` should not be used  ava/no-todo-test
      628:1  warning  `test.todo()` should not be used  ava/no-todo-test
    - Opened a new issue #9965 to create missing tests and removed test.todo()

### Security Considerations
None.

### Scaling Considerations
None.

### Documentation Considerations
None.

### Testing Considerations
None: passed lint and type checker; actual code not affected.

### Upgrade Considerations
None.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@siarhei-agoric siarhei-agoric

Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
2 participants
@toliaqat @siarhei-agoric