#78 and #72 Hide default params when showDefaults is False and the va…

[herronelou]

#78 and #72 Hide default params when showDefaults is False and the values are equivalent to the default.

Note: I didn't go deep into how the code works, but did this patch showing how I would expect the plugin to behave, and how the authors of #78 and #72 also expect it to behave as far as I can tell.

Maybe there's a better implementation but this was simple enough and seemed to do the trick. Tests didn't run when I pulled the repo so I didn't add new ones.

Summary by CodeRabbit

• New Features
  • Improved handling of query parameters for better management and control.
  • Enhanced logic to automatically delete unnecessary query parameters based on specific conditions.

[changeset-bot[bot]]

⚠️ No Changeset found

Latest commit: 9591a72cdeb94e899759e359c2e3f3942676858a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

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

[coderabbitai[bot]]

Walkthrough

The changes in this pull request modify the logic for handling query parameters in the queryParameters and queryParam functions within the src/lib/sveltekit-search-params.ts file. The updated logic includes conditions for deleting query parameters based on the values provided and the showDefaults flag, ensuring that parameters are only retained when they differ from their default values.

Changes

Files	Change Summary
src/lib/sveltekit-search-params.ts	Modified queryParameters and queryParam functions to include conditions for deleting parameters when newValue is undefined or matches the encoded default value if showDefaults is false.

Possibly related PRs

• #89: The changes in this PR also modify the sveltekit-search-params functionality, specifically addressing the handling of complex values in query parameters, which relates to the modifications made to the queryParameters and queryParam functions in the main PR.

Poem

In the meadow where bunnies play,
Query parameters dance and sway.
With new rules to keep them neat,
Defaults vanish, oh what a treat!
Hopping through code, we cheer and sing,
For clearer paths that changes bring! 🐰✨

---

Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL

Commits

Files that changed from the base of the PR and between 45171cfc94b342787286009b0360d95c0c0d6aab and 9591a72cdeb94e899759e359c2e3f3942676858a.

Files selected for processing (1)

• src/lib/sveltekit-search-params.ts (2 hunks)

Files skipped from review as they are similar to previous changes (1)

• src/lib/sveltekit-search-params.ts

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example: -- I pushed a fix in commit <commit_id>, please review it. -- Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples: -- @coderabbitai generate unit testing code for this file. -- @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: -- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase. -- @coderabbitai read src/utils.ts and generate unit testing code. -- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format. -- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[netlify[bot]]

✅ Deploy Preview for sveltekit-search-params ready!

Name	Link
🔨 Latest commit	9591a72cdeb94e899759e359c2e3f3942676858a
🔍 Latest deploy log	https://app.netlify.com/sites/sveltekit-search-params/deploys/66edfeb649fb2e0008e63da9
😎 Deploy Preview	https://deploy-preview-112--sveltekit-search-params.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[jippi]

This would be 👍 to have, been fighting this for a couple of hours, thinking it was a bug it did not behave like this :)

[ollema]

also want to voice my support for this PR (if it works, I have not tested it 😂).

I use ssp with tanstack table to create sharable views of my data tables, where the state of the table is contained in the query parameters (seen here are the defaults):

const params = queryParameters(
  {
    columnFilters: ssp.object<ColumnFiltersState>([
      { id: 'membership', value: ['active', 'passive'] }
    ]),
    sorting: ssp.object<SortingState>([{ id: 'memberSince', desc: false }]),
    pagination: ssp.object<PaginationState>({
      pageIndex: 1,
      pageSize: 10
    }),
    visibility: ssp.object<VisibilityState>({
      email: false,
      slackEmail: false,
      phone: false,
      memberSince: false
    })
  },
  {
    debounceHistory: 500,
    showDefaults: false
  }
);

<DataTable {params} />

as you might have guessed this can become a bit noisy, even when simply incrementing the page once, because some of these are written to despite them being equal to the default values and without a patch like this they would be shown

[paoloricciuti]

I'm not against this PR but I would need to port the code the the runes version. I will try to find a bit of time for this