toss / suspensive

Manage asynchronous operations, timing, error handling and detecting intersection of elements easily (one of TanStack Query's community resources)
https://suspensive.org
MIT License
528 stars 51 forks source link

feat(react-query): add cli status result table #1100

Closed gwansikk closed 3 months ago

gwansikk commented 3 months ago

Overview

close: #1029

I used the cli-table3 package to implement this.

When the version is correct When the version is incorrect
image image

PR Checklist

  1. I read the Contributing Guide
  2. I added documents and tests.
vercel[bot] commented 3 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
suspensive.org ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 18, 2024 5:01pm
v1.suspensive.org ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 18, 2024 5:01pm
visualization.suspensive.org ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 18, 2024 5:01pm
changeset-bot[bot] commented 3 months ago

🦋 Changeset detected

Latest commit: 0c8dd6ea054a63b7e23fafcf0e92debdeddd780e

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 4 packages | Name | Type | | ------------------------- | ----- | | @suspensive/react-query | Minor | | @suspensive/react | Minor | | @suspensive/react-query-4 | Minor | | @suspensive/react-query-5 | Minor |

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

codspeed-hq[bot] commented 3 months ago

CodSpeed Performance Report

Merging #1100 will create unknown performance changes

Comparing react-query/feat/cli-status-table (0c8dd6e) with main (fd2a280)

Summary

:warning: No benchmarks were detected in both the base of the PR and the PR.

codecov-commenter commented 3 months ago

Codecov Report

Attention: Patch coverage is 75.75758% with 8 lines in your changes missing coverage. Please review.

Project coverage is 85.19%. Comparing base (fd2a280) to head (4ceda15).

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/toss/suspensive/pull/1100/graphs/tree.svg?width=650&height=150&src=pr&token=5PopssACmx&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=toss)](https://app.codecov.io/gh/toss/suspensive/pull/1100?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=toss) ```diff @@ Coverage Diff @@ ## main #1100 +/- ## ========================================== - Coverage 85.99% 85.19% -0.81% ========================================== Files 64 65 +1 Lines 664 682 +18 Branches 138 145 +7 ========================================== + Hits 571 581 +10 - Misses 88 96 +8 Partials 5 5 ``` | [Components](https://app.codecov.io/gh/toss/suspensive/pull/1100/components?src=pr&el=components&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=toss) | Coverage Δ | | |---|---|---| | [@suspensive/react](https://app.codecov.io/gh/toss/suspensive/pull/1100/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=toss) | `97.05% <ø> (ø)` | | | [@suspensive/react-query](https://app.codecov.io/gh/toss/suspensive/pull/1100/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=toss) | `71.96% <75.75%> (-3.32%)` | :arrow_down: | | [@suspensive/react-query-4](https://app.codecov.io/gh/toss/suspensive/pull/1100/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=toss) | `0.00% <ø> (ø)` | | | [@suspensive/react-query-5](https://app.codecov.io/gh/toss/suspensive/pull/1100/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=toss) | `0.00% <ø> (ø)` | | | [@suspensive/jotai](https://app.codecov.io/gh/toss/suspensive/pull/1100/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=toss) | `0.00% <ø> (ø)` | | | [@suspensive/cache](https://app.codecov.io/gh/toss/suspensive/pull/1100/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=toss) | `98.16% <ø> (ø)` | | | [@suspensive/react-await](https://app.codecov.io/gh/toss/suspensive/pull/1100/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=toss) | `100.00% <ø> (ø)` | | | [@suspensive/react-image](https://app.codecov.io/gh/toss/suspensive/pull/1100/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=toss) | `80.39% <ø> (ø)` | |
gwansikk commented 3 months ago

@manudeli Additionally, how about providing a link to the official documentation in the "You can use" advice?

like this:

image
manudeli commented 3 months ago

@manudeli Additionally, how about providing a link to the official documentation in the "You can use" advice?

like this:

image

Cool! then we must maintain that link almost forever. Do we have to make redirector to make persistent link after merging this Pull Request?

gwansikk commented 3 months ago

@manudeli Additionally, how about providing a link to the official documentation in the "You can use" advice? like this:

image

Cool! then we must maintain that link almost forever. Do we have to make redirector to make persistent link after merging this Pull Request?

Yes, if using that link. Alternatively, how about displaying it as a permanent link (e.g., GitHub or suspensive.org)? If you have any better ideas, please let me know.

manudeli commented 3 months ago

@manudeli Additionally, how about providing a link to the official documentation in the "You can use" advice? like this:

image

Cool! then we must maintain that link almost forever. Do we have to make redirector to make persistent link after merging this Pull Request?

Yes, if using that link. Alternatively, how about displaying it as a permanent link (e.g., GitHub or suspensive.org)? If you have any better ideas, please let me know.

We can provide permanently maintaining link(redirecting to origin link changeable) to users https://suspensive.org/links/react-query (permanent link) -> https://suspensive.org/docs/react-query/motivation (changeable link) When we change path or order of https://suspensive.org/docs/react-query/motivation, we can persist link as https://suspensive.org/links/react-query and change our redirecting of https://suspensive.org/links/react-query

gwansikk commented 3 months ago

@manudeli Ah, I understand! I've set it to "https://suspensive.org/links/react-query". Once the PR is merged, we need to quickly set up the permanent link.

image
manudeli commented 3 months ago

Cool!