feat: add vue integration

asd55667 commented 1 week ago

Summary by CodeRabbit

Release Notes

New Features
- Introduced comprehensive documentation for the @tryabby/vue package, covering the createAbby function and related hooks.
- Added new classes for managing storage related to A/B testing and feature flags.
- Implemented a robust architecture for A/B testing and feature flag management within Vue applications.
Bug Fixes
- Enhanced error handling in the context management for A/B testing.
Tests
- Established extensive unit tests for the useAbby hook and related functionalities, ensuring type safety and correct behavior.
- Added mock API handlers and a testing server setup to streamline testing processes.
Chores
- Updated configuration files for TypeScript, Vite, and bundling to improve development workflows and build processes.

vercel[bot] commented 1 week ago

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

Name	Status	Preview	Comments	Updated (UTC)
abby-docs	❌ Failed (Inspect)			Nov 11, 2024 7:48am

coderabbitai[bot] commented 1 week ago

Walkthrough

This pull request introduces several significant changes to the @tryabby/vue package, including the addition of a new .gitignore entry for the dist directory, comprehensive documentation in a new README.md file, and the creation of a package.json file that outlines the package's structure and dependencies. Additionally, new functionalities are implemented through various TypeScript files, including storage services, context management for A/B testing, and utility functions for random selection. The changes also include multiple test files to ensure the correctness of the implemented features.

Changes

File Path	Change Summary
`packages/vue/.gitignore`	Added `dist` entry to ignore the distribution directory.
`packages/vue/README.md`	Introduced documentation for the `createAbby` function, detailing its properties and associated React hooks, components, and utility functions.
`packages/vue/package.json`	Created a new `package.json` specifying the package name, version, entry points, scripts, dependencies, and development dependencies.
`packages/vue/src/StorageService.ts`	Added `ABStorageService`, `FFStorageService`, and `RCStorageService` classes for managing storage with methods for A/B testing, feature flags, and remote configuration.
`packages/vue/src/context.ts`	Introduced context management for A/B testing and feature flags, including the `createAbby` function and several utility hooks.
`packages/vue/src/helpers.ts`	Added types and functions for random number generation and weighted selection.
`packages/vue/src/index.ts`	Updated exports to include new functionalities from `context` and core package.
`packages/vue/tests/helpers.test.ts`	Added tests for `getWeightedRandomVariant` and `getRandomDecimal` functions.
`packages/vue/tests/mocks/handlers.ts`	Introduced mock API handlers for testing using `msw`.
`packages/vue/tests/mocks/server.ts`	Set up a request mocking server using `msw`.
`packages/vue/tests/setup.ts`	Established a testing setup for the Vue application, including API mocking and cleanup routines.
`packages/vue/tests/ssr.test.ts`	Created unit tests for the `createAbby` function focusing on server-side rendering behavior.
`packages/vue/tests/types.test.ts`	Introduced tests for type correctness in `createAbby` and its hooks.
`packages/vue/tests/useAbby.test.ts`	Added tests for the `useAbby` hook and its functionalities.
`packages/vue/tests/utils.ts`	Introduced `renderHook` function for testing hooks within a Vue component context.
`packages/vue/tsconfig.json`	Created a TypeScript configuration file extending from a base configuration.
`packages/vue/tsup.config.ts`	Added configuration for the TypeScript bundler `tsup`, specifying build options.
`packages/vue/vite.config.ts`	Introduced a Vite configuration file for the Vue project, including setup for testing.

Possibly related PRs

#136: The addition of the dist entry to the .gitignore file in the main PR is related to the packages/remix/.gitignore file, which also includes an entry to ignore the dist directory, indicating a similar intent to manage build artifacts across different packages.
#151: The main PR's changes to the .gitignore file align with the feature flag removal command introduced in this PR, as both involve managing files and configurations related to feature flags.
#152: The changes in the main PR regarding the .gitignore file may relate to the overall project structure and management, which is also a focus in this PR that updates TypeScript and removes dependencies.
#159: The improvements to the A/B testing overview page may connect with the changes in the main PR, as both involve enhancing the user experience and managing project configurations.
#161: The introduction of auto flag removal in this PR may relate to the changes in the main PR, as both involve managing feature flags and their configurations within the project.

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.

asd55667 commented 1 week ago

/claim #68

asd55667 commented 1 week ago

it's also my first time to do algora's bounty. I forgot to claim when submitted, should i do another pull reuqest agian ?

tryabby / abby