Skip to content

Comments

Optimize Dependencies#57

Merged
iamEvanYT merged 5 commits intomainfrom
evan/optimise-deps
May 20, 2025
Merged

Optimize Dependencies#57
iamEvanYT merged 5 commits intomainfrom
evan/optimise-deps

Conversation

@iamEvanYT
Copy link
Member

@iamEvanYT iamEvanYT commented May 20, 2025

tldr

Build Before: 400MB
Build After: 334MB

Summary by CodeRabbit

  • New Features

    • Introduced a custom, lightweight icon system for improved performance and reduced application size.
    • Added documentation explaining the new icon system.
  • Refactor

    • Replaced usage of external icon library with the new custom icon components throughout the PDF viewer interface.
  • Chores

    • Updated dependency management to remove unused packages and reclassify certain dependencies for better project organization.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented May 20, 2025

Walkthrough

This change set replaces the external react-icons dependency with a custom, stripped-down local implementation for only the required icons. Icon imports across multiple components are redirected to this local version. Supporting infrastructure for the icon system is introduced, including context and base rendering logic. Package dependencies are updated to reflect these changes, and unused packages are removed or reclassified.

Changes

File(s) Change Summary
package.json Removed several packages from dependencies, moved @pdfslick/react and use-query-params to devDependencies, and removed react-icons entirely from devDependencies.
src/main/browser/utility/hot-reload.ts Replaced usage of @electron-toolkit/utils's is.dev with a direct check using app.isPackaged to determine development server status.
src/renderer/src/components/react-icons/README.md Added a README explaining the rationale for a stripped-down local react-icons implementation.
src/renderer/src/components/react-icons/iconBase.tsx Introduced a new icon rendering system: defines icon tree structure, recursive rendering, context-aware SVG wrapper, and exports types for icon components.
src/renderer/src/components/react-icons/iconContext.ts Added a React context for icon styling and attributes, with default values and exported context object.
src/renderer/src/routes/pdf-viewer/pdf-viewer/Thumbsbar/ButtonsBar.tsx
.../Outline.tsx
.../Toolbar/DocumentInfo.tsx
.../Toolbar/FreetextMenu.tsx
.../Toolbar/InkMenu.tsx
.../Toolbar/MoreActionsMenu.tsx
.../Toolbar/SearchBar.tsx
.../Toolbar/ZoomSelector.tsx
.../Toolbar/index.tsx
Changed icon imports from the external react-icons/vsc package to the local @/components/react-icons/vsc path. No other logic changes.

Sequence Diagram(s)

sequenceDiagram
    participant Component as PDF Viewer Component
    participant LocalIcons as @/components/react-icons/vsc
    participant IconBase as IconBase/IconContext

    Component->>LocalIcons: Import {VscIcon}
    LocalIcons->>IconBase: Use GenIcon/IconBase for rendering
    IconBase->>IconBase: Merge props, context, and defaults
    IconBase->>Component: Render SVG icon with correct attributes
Loading

Poem

🐇
A hop and a skip, the icons are light,
No more the bloat that kept us up at night.
From bulky to lean, our code’s now pristine,
With custom SVGs, our UI’s serene.
The toolkit is nimble, the rabbits rejoice—
Local icons, local choice!
🥕

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (3)
src/renderer/src/components/react-icons/iconContext.ts (1)

1-20: Consider using optional chaining

The implementation of IconContext looks good overall, providing the necessary infrastructure for your custom icon system. However, line 19 uses a potentially problematic pattern with the logical AND operator.

-export const IconContext: React.Context<IconContext> = React.createContext && React.createContext(DefaultContext);
+export const IconContext: React.Context<IconContext> = React.createContext?.(DefaultContext);
🧰 Tools
🪛 Biome (1.9.4)

[error] 19-19: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

src/renderer/src/components/react-icons/README.md (1)

1-3: Clear explanation for the custom implementation

The README explains the rationale for creating a custom icon implementation very clearly. The size difference (80MB for the full package vs. just what's needed) definitely justifies this approach.

Consider expanding this README with instructions on how to add new icons if needed in the future, which would help other developers maintain the custom icon system.

src/renderer/src/components/react-icons/iconBase.tsx (1)

11-15: Simplify with optional chaining

The Tree2Element function can be improved by using optional chaining for better readability.

function Tree2Element(tree: IconTree[]): React.ReactElement[] {
  return (
-    tree && tree.map((node, i) => React.createElement(node.tag, { key: i, ...node.attr }, Tree2Element(node.child)))
+    tree?.map((node, i) => React.createElement(node.tag, { key: i, ...node.attr }, Tree2Element(node.child)))
  );
}
🧰 Tools
🪛 Biome (1.9.4)

[error] 13-13: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between aa72724 and 7af13cb.

⛔ Files ignored due to path filters (1)
  • bun.lock is excluded by !**/*.lock
📒 Files selected for processing (14)
  • package.json (2 hunks)
  • src/main/browser/utility/hot-reload.ts (1 hunks)
  • src/renderer/src/components/react-icons/README.md (1 hunks)
  • src/renderer/src/components/react-icons/iconBase.tsx (1 hunks)
  • src/renderer/src/components/react-icons/iconContext.ts (1 hunks)
  • src/renderer/src/routes/pdf-viewer/pdf-viewer/Thumbsbar/ButtonsBar.tsx (1 hunks)
  • src/renderer/src/routes/pdf-viewer/pdf-viewer/Thumbsbar/Outline.tsx (1 hunks)
  • src/renderer/src/routes/pdf-viewer/pdf-viewer/Toolbar/DocumentInfo.tsx (1 hunks)
  • src/renderer/src/routes/pdf-viewer/pdf-viewer/Toolbar/FreetextMenu.tsx (1 hunks)
  • src/renderer/src/routes/pdf-viewer/pdf-viewer/Toolbar/InkMenu.tsx (1 hunks)
  • src/renderer/src/routes/pdf-viewer/pdf-viewer/Toolbar/MoreActionsMenu.tsx (1 hunks)
  • src/renderer/src/routes/pdf-viewer/pdf-viewer/Toolbar/SearchBar.tsx (1 hunks)
  • src/renderer/src/routes/pdf-viewer/pdf-viewer/Toolbar/ZoomSelector.tsx (1 hunks)
  • src/renderer/src/routes/pdf-viewer/pdf-viewer/Toolbar/index.tsx (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
src/renderer/src/components/react-icons/iconBase.tsx (1)
src/renderer/src/components/react-icons/iconContext.ts (3)
  • IconContext (3-9)
  • IconContext (19-19)
  • DefaultContext (11-17)
🪛 Biome (1.9.4)
src/renderer/src/components/react-icons/iconContext.ts

[error] 19-19: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

src/renderer/src/components/react-icons/iconBase.tsx

[error] 13-13: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: build (windows-latest)
  • GitHub Check: build (ubuntu-latest)
  • GitHub Check: build (macos-latest)
🔇 Additional comments (12)
package.json (1)

50-50: Dependency optimization looks good

The package.json changes show moving dependencies to more appropriate categories, which helps reduce the final build size.

Also applies to: 100-100

src/main/browser/utility/hot-reload.ts (1)

21-21: Good replacement for removed utility

The change from using the external is.dev utility to checking !app.isPackaged simplifies the dependency structure while maintaining the same functionality.

src/renderer/src/routes/pdf-viewer/pdf-viewer/Toolbar/DocumentInfo.tsx (1)

3-3: Import change looks good

Successfully migrated from external react-icons package to the local implementation, which will help reduce the bundle size.

src/renderer/src/routes/pdf-viewer/pdf-viewer/Thumbsbar/Outline.tsx (1)

3-3: Local icon import updated to custom implementation.
The import of VscTriangleRight now points to your stripped-down icon library at @/components/react-icons/vsc, which aligns with the bundle size reduction goal. Please verify that the @/* path alias is correctly configured in your tsconfig.json (or equivalent) so that this module resolves without errors.

src/renderer/src/routes/pdf-viewer/pdf-viewer/Toolbar/FreetextMenu.tsx (1)

3-3: Switched icon imports to local alias.
The icons VscChevronDown and VscCaseSensitive are now sourced from @/components/react-icons/vsc. This change is consistent with the dependency optimization. Ensure the path alias is set up correctly to avoid import resolution issues.

src/renderer/src/routes/pdf-viewer/pdf-viewer/Toolbar/SearchBar.tsx (1)

3-3: Redirected icon imports to the custom icon library.
By importing VscSearch, VscChevronLeft, and VscChevronRight from @/components/react-icons/vsc, you’ve removed the heavy react-icons dependency. Confirm that the alias is properly declared so these components load as expected.

src/renderer/src/routes/pdf-viewer/pdf-viewer/Toolbar/InkMenu.tsx (1)

3-3: Icon imports replaced with local components.
Changed VscChevronDown and VscEdit imports to the lightweight local library at @/components/react-icons/vsc. This aligns with the PR’s objective. Please verify module resolution via your path alias settings.

src/renderer/src/routes/pdf-viewer/pdf-viewer/Thumbsbar/ButtonsBar.tsx (1)

2-2: Updated icon imports to use custom set.
The icons VscVersions, VscListTree, and VscSaveAll now come from @/components/react-icons/vsc. This correctly supports the bundle size optimization. Ensure the alias mapping is configured so these imports resolve.

src/renderer/src/routes/pdf-viewer/pdf-viewer/Toolbar/MoreActionsMenu.tsx (1)

17-17: Great optimization to reduce bundle size!

Changing the icon imports from the external react-icons/vsc package to a local implementation is an excellent way to reduce dependencies and bundle size.

src/renderer/src/routes/pdf-viewer/pdf-viewer/Toolbar/index.tsx (1)

9-9: Good consistency in import optimization

This change correctly aligns with the other components to use the local icon implementation instead of the external package.

src/renderer/src/routes/pdf-viewer/pdf-viewer/Toolbar/ZoomSelector.tsx (1)

3-3: Excellent dependency optimization

Switching to the local icon implementation is consistent with the other changes and helps reduce the bundle size.

src/renderer/src/components/react-icons/iconBase.tsx (1)

1-71: Well-implemented custom icon system

The implementation of this custom icon system is excellent. It provides the necessary functionality for rendering SVG icons while maintaining a similar API to the original react-icons package, which makes the migration seamless. The context-aware styling and consistent rendering approach ensure that icons will look and behave consistently throughout the application.

This approach significantly contributes to the PR objective of reducing build size (from 400MB to 334MB). Great work!

🧰 Tools
🪛 Biome (1.9.4)

[error] 13-13: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

@iamEvanYT iamEvanYT merged commit e58cf4d into main May 20, 2025
8 checks passed
@iamEvanYT iamEvanYT deleted the evan/optimise-deps branch May 20, 2025 22:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant