search

paoloricciuti / sveltekit-search-params

The easiest way to read and WRITE from query parameters in sveltekit.
https://sveltekit-search-params.netlify.app
MIT License
546 stars 18 forks source link

chore: split out the ssp definitions #116

Closed gwax closed 1 month ago

gwax commented 1 month ago

I was looking to offer another ssp definition but I was worried the main file was getting a bit too large, so I split the existing definitions out first.

Summary by CodeRabbit

changeset-bot[bot] commented 1 month ago

🦋 Changeset detected

Latest commit: 1c1b899e413be568572cbb3bccfca0c1034f8abb

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

This PR includes changesets to release 1 package | Name | Type | | ----------------------- | ----- | | sveltekit-search-params | 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

coderabbitai[bot] commented 1 month ago

Walkthrough

The pull request introduces several modifications across multiple files, primarily focusing on encoding and decoding functionalities. Key changes include disabling a TypeScript ESLint rule, updating export statements in the index file, and adding new encoding and decoding options in various modules. Additionally, several redundant functions and type definitions were removed from the sveltekit-search-params.ts file, while new type definitions were added to enhance type safety. A new module for handling the ssp component was also created, encapsulating various encoding and decoding methods.

Changes

File Change Summary
eslint.config.js - Rule @typescript-eslint/no-explicit-any set to 'off'.
src/lib/index.ts - Added import and export for ssp from ./ssp.
- Updated export for queryParameters and queryParam to remove file extension.
src/lib/ssp/index.ts - Added default export encapsulating encoding/decoding options for various data types.
src/lib/ssp/json-encode.ts - Added objectEncodeAndDecodeOptions and arrayEncodeAndDecodeOptions functions with overloads for encoding/decoding objects and arrays.
src/lib/ssp/lz-encode.ts - Introduced lzEncodeAndDecodeOptions function with overloads for LZ compression encoding/decoding.
src/lib/ssp/util.ts - Added primitiveEncodeAndDecodeOptions function and overloads for ssp.
src/lib/sveltekit-search-params.ts - Removed types EncodeAndDecodeOptions and StoreOptions.
- Removed encoding functions and ssp constant.
- Updated batchTimeout type to ReturnType<typeof setTimeout>.
src/lib/types.ts - Added new types: EncodeAndDecodeOptions and StoreOptions to enhance type safety and configurability.

Possibly related PRs

🐰 In the meadow, changes sprout,
New rules and exports, without a doubt.
Encoding options, all in a row,
With cleaner paths, watch them glow!
From any to types, we leap and bound,
In our code, new treasures found! 🌼

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
netlify[bot] commented 1 month ago

Deploy Preview for sveltekit-search-params ready!

Name Link
Latest commit 1c1b899e413be568572cbb3bccfca0c1034f8abb
Latest deploy log https://app.netlify.com/sites/sveltekit-search-params/deploys/670acbb52b43df0008ade311
Deploy Preview https://deploy-preview-116--sveltekit-search-params.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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