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: update npm dependency to latest stable version #2145

Merged
merged 3 commits into from
May 13, 2024

Conversation

odinr
Copy link
Collaborator

@odinr odinr commented May 13, 2024

Why

This pull request introduces changes to improve the documentation and tooling for the @equinor/fusion-query package.

What is the current behavior?

The current behavior is that the documentation for the @equinor/fusion-query package is lacking in examples and clarity, making it difficult for developers to understand how to use the package effectively.

What is the new behavior?

The new behavior includes the following changes:

  • Updated the README.md file with a more detailed introduction, explaining the purpose and benefits of using the @equinor/fusion-query package.
  • Added several code examples to the README.md file, demonstrating how to create and use queries, execute queries asynchronously, mutate cache entries, and invalidate cache entries.
  • Improved the inline documentation within the Query.ts file, providing better explanations for various types, interfaces, and functions.
  • Updated the package manager version in the package.json file to the latest version (9.1.0).

Does this PR introduce a breaking change?

No, this PR does not introduce any breaking changes. It only improves the documentation and tooling for the existing functionality.

Other information?

This PR also includes some minor formatting and code style changes within the Query.ts file, but these changes do not affect the functionality of the code.

Check off the following:

  • Confirm that I checked changes to branch which I am merging into.

    • I have validated included files
    • My code does not generate new linting warnings
    • My PR is not a duplicate, check existing pr`s
  • Confirm that the I have completed the self-review checklist.

  • Confirm that my changes meet our code of conduct.

Copy link

changeset-bot bot commented May 13, 2024

🦋 Changeset detected

Latest commit: 7b772e5

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

This PR includes changesets to release 23 packages
Name Type
@equinor/fusion-query Patch
@equinor/fusion-framework-cli Patch
@equinor/fusion-framework-module-app Patch
@equinor/fusion-framework-module-bookmark Patch
@equinor/fusion-framework-module-context Patch
@equinor/fusion-framework-module-service-discovery Patch
@equinor/fusion-framework-module-widget Patch
@equinor/fusion-framework-react-components-people-provider Patch
@equinor/fusion-framework-react-module-bookmark Patch
@equinor/fusion-framework-react-module-context Patch
@equinor/fusion-framework-cookbook-app-react-context-custom-error Patch
@equinor/fusion-framework-cookbook-app-react-context Patch
@equinor/fusion-framework-cookbook-app-react-feature-flag Patch
@equinor/fusion-framework-app Patch
@equinor/fusion-framework-react-app Patch
@equinor/fusion-framework-react-components-bookmark Patch
@equinor/fusion-framework-react Patch
@equinor/fusion-framework-legacy-interopt Patch
@equinor/fusion-framework Patch
@equinor/fusion-framework-module-signalr Patch
@equinor/fusion-framework-react-widget Patch
@equinor/fusion-framework-widget Patch
@equinor/fusion-framework-react-module-signalr Patch

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

@github-actions github-actions bot added 🚧 chore maintaines work, (update deps, workflos ...) 🛠️ utils packages related to utils labels May 13, 2024
@odinr odinr force-pushed the docs/query/add-examples branch 2 times, most recently from 6dc0985 to de26908 Compare May 13, 2024 17:12
@github-actions github-actions bot added the 📚 documentation Improvements or additions to documentation label May 13, 2024
@odinr odinr self-assigned this May 13, 2024
odinr added 3 commits May 13, 2024 19:23
…adme

The changeset README has been updated with detailed instructions on how to write a changeset, including examples and guidelines for choosing version tags.

The main project README has been improved with a better overview of the Fusion Framework, sections on getting started, cookbooks, and contributing. This provides more context and guidance for new users and contributors.
@odinr odinr marked this pull request as ready for review May 13, 2024 17:23
@odinr odinr requested a review from a team as a code owner May 13, 2024 17:23
Copy link
Contributor

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 11.56% 3569 / 30854
🔵 Statements 11.56% 3569 / 30854
🔵 Functions 11.02% 85 / 771
🔵 Branches 24.06% 207 / 860
File Coverage
File Stmts % Branch % Funcs % Lines Uncovered Lines
Changed Files
packages/utils/query/src/Query.ts 97.32% 90.32% 76.47% 97.32% 192-193, 203, 331-333, 341-343, 366, 380, 590-591, 605-609, 699-701
Generated in workflow #5972

@odinr odinr merged commit bd3d3e1 into main May 13, 2024
11 of 13 checks passed
@odinr odinr deleted the docs/query/add-examples branch May 13, 2024 17:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🚧 chore maintaines work, (update deps, workflos ...) 📚 documentation Improvements or additions to documentation 🛠️ utils packages related to utils
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant