fix: fix warning about circular imports#22
Open
sburton84 wants to merge 3 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR introduces an @ path alias for the src/ directory and updates several internal imports to use that alias, aiming to reduce circular import warnings and avoid importing through the src barrel.
Changes:
- Add
@alias resolution in Vite and TypeScript path mappings. - Replace some
src/...and relative imports with@/...imports in custom hooks and docs components/scripts. - Avoid importing utilities via the
srcbarrel export in a few components (e.g.,cn).
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| documentation-ui/vite.config.ts | Adds Vite @ alias pointing to /src for consistent module resolution. |
| documentation-ui/tsconfig.json | Adds @/* TypeScript path mapping to match the new alias usage. |
| documentation-ui/src/custom/use-theme.ts | Switches dark mode utility import to @/utils/darkMode. |
| documentation-ui/src/custom/docs/scripts/nav/index.tsx | Switches NavBar import to @/custom/docs/components/navmenu. |
| documentation-ui/src/custom/docs/QuantinuumLogo.tsx | Imports cn directly from @/utils instead of the src barrel. |
| documentation-ui/src/custom/docs/components/triplecard/Card.tsx | Imports cn directly from @/utils instead of the src barrel. |
| documentation-ui/src/custom/docs/components/gdpr/_components/CookieSettingsDialog/CookieSettingsDialog.tsx | Updates GDPR module imports to use @/custom/docs/components/gdpr/.... |
| documentation-ui/src/custom/docs/components/gdpr/_components/CookieConditional/CookieConditional.tsx | Updates GDPR context/type imports to use @/custom/docs/components/gdpr/.... |
| documentation-ui/src/custom/docs/components/footer/index.tsx | Switches QuantinuumLogo import to @/custom/docs/QuantinuumLogo. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.