search

land-cap / the-good-book

Bible-reading app with the optimal reading experience across all platforms.
https://the-good-book.vercel.app
1 stars 0 forks source link

refactor: colocates reader layout with it's dependencies #168

Open land-cap opened 1 month ago

land-cap commented 1 month ago

Done

Refactors / Code debt / Maintenance

Summary by CodeRabbit

Release Notes

linear[bot] commented 1 month ago

TGB-9 Refactor ReaderNavigationMenu and use it as a reference for other modules

vercel[bot] commented 1 month ago

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

Name Status Preview Updated (UTC)
the-good-book ✅ Ready (Inspect) Visit Preview Oct 20, 2024 7:31am
coderabbitai[bot] commented 1 month ago

Walkthrough

The changes in this pull request involve modifications to various components within the codebase, primarily focusing on import statement updates and the introduction of new inspection tools in the .idea/vcs.xml file. New components and exports are added, while some existing components and exports are removed or restructured. The overall functionality remains intact, with no significant alterations to the logic or control flow of the components.

Changes

File Change Summary
.idea/vcs.xml Added inspection tools: CommitFormat and CommitNamingConvention with severity WARNING and enabled by default.
src/app/[...slug]/page.ts Consolidated import for buildReaderUrl and VERSE_RANGE_SEARCH_PARAM from separate paths into one.
src/app/read/[bookCode]/page.ts Updated import path for buildReaderUrl from ~/hooks to ../lib.
src/app/read/layout.tsx Introduced new ReaderLayout component and replaced the previous export statement.
src/app/read/lib/Footer/Footer.tsx Updated import path for FooterContainer reflecting new directory structure.
src/app/read/lib/hooks/buildReaderUrl.ts Changed import path for VERSE_RANGE_SEARCH_PARAM, no changes to function logic.
src/app/read/lib/hooks/index.ts Added export statement to re-export all entities from buildReaderUrl.
src/app/read/lib/index.ts Added exports for buildReaderUrl, PREV_SESSION_READER_URL_COOKIE, and VERSE_RANGE_SEARCH_PARAM.
src/hooks/index.ts Removed export for buildReaderUrl, modifying the public API.
src/layouts/ReaderLayout/Reader.layout.tsx Deleted ReaderLayout component.
src/layouts/ReaderLayout/index.ts Deleted re-export file for ReaderLayout.
src/layouts/index.ts Removed export for ReaderLayout.
src/middleware.ts Consolidated import for PREV_SESSION_READER_URL_COOKIE and buildReaderUrl.
src/organisms/BottomToolbar/ChapterPickerMenu/ChapterTabView.tsx Updated import path for buildReaderUrl.
src/organisms/BottomToolbar/ReturnFromReferenceFab.tsx Updated import path for buildReaderUrl, no changes to component logic.
src/organisms/VerseDetailsMenu/VerseDetailsMenu.tsx Updated import path for buildReaderUrl, no changes to component logic.
src/state/reader.state.ts Updated import path for buildReaderUrl, maintaining existing logic for chapter navigation.

Poem

In the code where rabbits play,
New tools hop in, brightening the day.
With paths refined and imports neat,
Our reader's journey feels complete.
So let us cheer, with a joyful thump,
For every change, a happy jump! 🐇✨

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.