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

feat(docs): add tracking for plugins "promise" and "vitest" #4668

Merged

Conversation

Sysix
Copy link
Contributor

@Sysix Sysix commented Aug 5, 2024

follow up by #4611

Copy link

graphite-app bot commented Aug 5, 2024

Your org has enabled the Graphite merge queue for merging into main

Add the label “merge” to the PR and Graphite will automatically add it to the merge queue when it’s ready to merge. Or use the label “hotfix” to add to the merge queue as a hot fix.

You must have a Graphite account and log in to Graphite in order to use the merge queue. Sign up using this link.

@DonIsaac
Copy link
Contributor

DonIsaac commented Aug 5, 2024

@Sysix thanks for doing this! Did you test the task's output to ensure it generated the correct table?

@Sysix
Copy link
Contributor Author

Sysix commented Aug 5, 2024

@DonIsaac

yes, here are the outputs:

node ./task/lint_rules -t vitest
sysix@xxxx:~/dev/oxc$ node ./tasks/lint_rules -t vitest
👀 tree-shaking/no-side-effects-in-initialization is implemented but not found in their rules

> [!WARNING]
> This comment is maintained by CI. Do not edit this comment directly.
> To update comment template, see https://github.com/oxc-project/oxc/tree/main/tasks/lint_rules

This is tracking issue for `eslint-plugin-vitest`.


There are 51(+ 1 deprecated) rules.

- 7/8 recommended rules are remaining as TODO
- 43/43 not recommended rules are remaining as TODO


To get started, run the following command:

``sh <-- removed one ` for github formatting
just new-vitest-rule <RULE_NAME>
``

Then register the rule in `crates/oxc_linter/src/rules.rs` and also `declare_all_lint_rules` at the bottom.


## Recommended rules

<details open>
<summary>
  ✨: 1, 🚫: 0 / total: 8
</summary>

| Status | Name | Docs |
| :----: | :--- | :--- |
|  | vitest/no-identical-title | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-identical-title.md |
|  | vitest/expect-expect | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/expect-expect.md |
|  | vitest/no-commented-out-tests | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-commented-out-tests.md |
| ✨ | vitest/no-import-node-test | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-import-node-test.md |
|  | vitest/valid-title | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/valid-title.md |
|  | vitest/valid-expect | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/valid-expect.md |
|  | vitest/require-local-test-context-for-concurrent-snapshots | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/require-local-test-context-for-concurrent-snapshots.md |
|  | vitest/valid-describe-callback | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/valid-describe-callback.md |

✨ = Implemented, 🚫 = Not supported

</details>


## Not recommended rules

<details open>
<summary>
  ✨: 0, 🚫: 0 / total: 43
</summary>

| Status | Name | Docs |
| :----: | :--- | :--- |
|  | vitest/prefer-lowercase-title | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-lowercase-title.md |
|  | vitest/max-nested-describe | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/max-nested-describe.md |
|  | vitest/no-focused-tests | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-focused-tests.md |
|  | vitest/no-conditional-tests | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-conditional-tests.md |
|  | vitest/consistent-test-it | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/consistent-test-it.md |
|  | vitest/prefer-to-be | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-to-be.md |
|  | vitest/no-hooks | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-hooks.md |
|  | vitest/no-restricted-vi-methods | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-restricted-vi-methods.md |
|  | vitest/consistent-test-filename | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/consistent-test-filename.md |
|  | vitest/max-expects | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/max-expects.md |
|  | vitest/no-alias-methods | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-alias-methods.md |
|  | vitest/no-conditional-expect | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-conditional-expect.md |
|  | vitest/no-conditional-in-test | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-conditional-in-test.md |
|  | vitest/no-disabled-tests | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-disabled-tests.md |
|  | vitest/no-duplicate-hooks | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-duplicate-hooks.md |
|  | vitest/no-large-snapshots | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-large-snapshots.md |
|  | vitest/no-interpolation-in-snapshots | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-interpolation-in-snapshots.md |
|  | vitest/no-mocks-import | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-mocks-import.md |
|  | vitest/no-restricted-matchers | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-restricted-matchers.md |
|  | vitest/no-standalone-expect | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-standalone-expect.md |
|  | vitest/no-test-prefixes | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-test-prefixes.md |
|  | vitest/no-test-return-statement | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-test-return-statement.md |
|  | vitest/prefer-called-with | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-called-with.md |
|  | vitest/prefer-to-be-falsy | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-to-be-falsy.md |
|  | vitest/prefer-to-be-object | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-to-be-object.md |
|  | vitest/prefer-to-be-truthy | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-to-be-truthy.md |
|  | vitest/prefer-to-have-length | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-to-have-length.md |
|  | vitest/prefer-equality-matcher | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-equality-matcher.md |
|  | vitest/prefer-strict-equal | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-strict-equal.md |
|  | vitest/prefer-expect-resolves | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-expect-resolves.md |
|  | vitest/prefer-each | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-each.md |
|  | vitest/prefer-hooks-on-top | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-hooks-on-top.md |
|  | vitest/prefer-hooks-in-order | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-hooks-in-order.md |
|  | vitest/prefer-mock-promise-shorthand | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-mock-promise-shorthand.md |
|  | vitest/prefer-snapshot-hint | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-snapshot-hint.md |
|  | vitest/require-top-level-describe | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/require-top-level-describe.md |
|  | vitest/require-to-throw-message | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/require-to-throw-message.md |
|  | vitest/require-hook | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/require-hook.md |
|  | vitest/prefer-todo | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-todo.md |
|  | vitest/prefer-spy-on | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-spy-on.md |
|  | vitest/prefer-comparison-matcher | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-comparison-matcher.md |
|  | vitest/prefer-to-contain | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-to-contain.md |
|  | vitest/prefer-expect-assertions | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-expect-assertions.md |

✨ = Implemented, 🚫 = Not supported

</details>


## Deprecated rules

<details >
<summary>
  ✨: 0, 🚫: 0 / total: 1
</summary>

| Status | Name | Docs |
| :----: | :--- | :--- |
|  | vitest/no-done-callback | https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-done-callback.md |

✨ = Implemented, 🚫 = Not supported

</details>

node ./task/lint_rules -t promise
sysix@xxxxx:~/dev/oxc$ node ./tasks/lint_rules -t promise
👀 tree-shaking/no-side-effects-in-initialization is implemented but not found in their rules

> [!WARNING]
> This comment is maintained by CI. Do not edit this comment directly.
> To update comment template, see https://github.com/oxc-project/oxc/tree/main/tasks/lint_rules

This is tracking issue for `eslint-plugin-promise`.


There are 15(+ 0 deprecated) rules.

- 9/12 recommended rules are remaining as TODO
- 3/3 not recommended rules are remaining as TODO


To get started, run the following command:

``sh <-- removed one ` for github formatting
just new-promise-rule <RULE_NAME>
``

Then register the rule in `crates/oxc_linter/src/rules.rs` and also `declare_all_lint_rules` at the bottom.


## Recommended rules

<details open>
<summary>
  ✨: 3, 🚫: 0 / total: 12
</summary>

| Status | Name | Docs |
| :----: | :--- | :--- |
| ✨ | promise/param-names | https://github.com/eslint-community/eslint-plugin-promise/blob/main/docs/rules/param-names.md |
|  | promise/no-return-wrap | https://github.com/eslint-community/eslint-plugin-promise/blob/main/docs/rules/no-return-wrap.md |
|  | promise/always-return | https://github.com/eslint-community/eslint-plugin-promise/blob/main/docs/rules/always-return.md |
|  | promise/catch-or-return | https://github.com/eslint-community/eslint-plugin-promise/blob/main/docs/rules/catch-or-return.md |
|  | promise/no-native | https://github.com/eslint-community/eslint-plugin-promise/blob/main/docs/rules/no-native.md |
|  | promise/no-callback-in-promise | https://github.com/eslint-community/eslint-plugin-promise/blob/main/docs/rules/no-callback-in-promise.md |
|  | promise/no-promise-in-callback | https://github.com/eslint-community/eslint-plugin-promise/blob/main/docs/rules/no-promise-in-callback.md |
|  | promise/no-nesting | https://github.com/eslint-community/eslint-plugin-promise/blob/main/docs/rules/no-nesting.md |
| ✨ | promise/avoid-new | https://github.com/eslint-community/eslint-plugin-promise/blob/main/docs/rules/avoid-new.md |
| ✨ | promise/no-new-statics | https://github.com/eslint-community/eslint-plugin-promise/blob/main/docs/rules/no-new-statics.md |
|  | promise/no-return-in-finally | https://github.com/eslint-community/eslint-plugin-promise/blob/main/docs/rules/no-return-in-finally.md |
|  | promise/valid-params | https://github.com/eslint-community/eslint-plugin-promise/blob/main/docs/rules/valid-params.md |

✨ = Implemented, 🚫 = Not supported

</details>


## Not recommended rules

<details open>
<summary>
  ✨: 0, 🚫: 0 / total: 3
</summary>

| Status | Name | Docs |
| :----: | :--- | :--- |
|  | promise/prefer-await-to-callbacks | https://github.com/eslint-community/eslint-plugin-promise/blob/main/docs/rules/prefer-await-to-callbacks.md |
|  | promise/prefer-await-to-then | https://github.com/eslint-community/eslint-plugin-promise/blob/main/docs/rules/prefer-await-to-then.md |
|  | promise/no-multiple-resolved | https://github.com/eslint-community/eslint-plugin-promise/blob/main/docs/rules/no-multiple-resolved.md |

✨ = Implemented, 🚫 = Not supported

</details>

@DonIsaac DonIsaac merged commit 5c62f17 into oxc-project:main Aug 5, 2024
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants