Skip to content

feat: add relative imports for src, routes, and test #228

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 16, 2025

Conversation

ken-zlai
Copy link
Contributor

@ken-zlai ken-zlai commented Jan 16, 2025

Summary

QOL change so we can use relative imports on the src, routes, and tests directory like we do for src now.

Checklist

  • Added Unit Tests
  • Covered by existing CI
  • Integration tested
  • Documentation update

Summary by CodeRabbit

  • Refactor
    • Updated import paths to use absolute and alias-based imports across the frontend configuration
    • Enhanced module resolution in TypeScript configuration with new path aliases
    • Improved code maintainability by standardizing import structures

@ken-zlai ken-zlai requested a review from sean-zlai January 16, 2025 19:31
Copy link
Contributor

coderabbitai bot commented Jan 16, 2025

Walkthrough

This pull request focuses on improving module resolution and import paths in the frontend project. The changes introduce new path aliases in both Svelte configuration and TypeScript configuration files, allowing for more consistent and readable imports. The modifications affect the project's module resolution strategy without changing any core functionality.

Changes

File Change Summary
frontend/src/lib/components/Observability/Observability.svelte Updated import path for JoinPageData from relative to absolute
frontend/svelte.config.js Added alias configuration with $src, $routes, and $test aliases
frontend/tsconfig.json Added baseUrl and paths for module resolution with new path aliases

Possibly related PRs

Suggested reviewers

  • nikhil-zlai
  • piyush-zlai

Poem

🚀 Paths rewritten, imports refined
Aliases dance, code intertwined
From relative to absolute we leap
Svelte's config secrets we now keep
Clarity blooms in every line! 🌟

Warning

Review ran into problems

🔥 Problems

GitHub Actions: Resource not accessible by integration - https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository.

Please grant the required permissions to the CodeRabbit GitHub App under the organization or repository settings.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro (Legacy)

📥 Commits

Reviewing files that changed from the base of the PR and between 9d32bfd and 77ac841.

📒 Files selected for processing (3)
  • frontend/src/lib/components/Observability/Observability.svelte (1 hunks)
  • frontend/svelte.config.js (1 hunks)
  • frontend/tsconfig.json (1 hunks)
🔇 Additional comments (4)
frontend/svelte.config.js (1)

15-19: LGTM! Clean alias configuration.

The aliases are well-structured and follow SvelteKit's recommended practices.

frontend/tsconfig.json (1)

13-19: LGTM! TypeScript paths match SvelteKit aliases.

Configuration is consistent and well-documented.

frontend/src/lib/components/Observability/Observability.svelte (2)

37-37: LGTM! Import uses new path alias.

Changed from relative path to more maintainable alias-based import.


37-37: Verify other relative imports that could use the new aliases.

✅ Verification successful

No other relative imports need alias conversion

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Find relative imports that could use the new aliases
rg -g '*.{ts,js,svelte}' -l '\.\./\.\./\.\.'

Length of output: 46


Script:

#!/bin/bash
# Check relative imports with various depths
rg -g '*.{ts,js,svelte}' '(?:from|import) [\'"]\.\./'

# Check current alias usage
rg -g '*.{ts,js,svelte}' '(?:from|import) [\'"](\$[^\'"]*)' -o

# Look for config files that might define aliases
fd -e json -e js -e ts "config|vite"

Length of output: 245


Script:

#!/bin/bash
# Find relative imports
rg -g '*.{ts,js,svelte}' 'from "\.\.'
rg -g '*.{ts,js,svelte}' "from '\.\."

# Find alias imports
rg -g '*.{ts,js,svelte}' 'from "\$'
rg -g '*.{ts,js,svelte}' "from '\$"

# Find config files
fd "tsconfig|vite.config" -e json -e js -e ts

Length of output: 255

Finishing Touches

  • 📝 Generate Docstrings (Beta)

🪧 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.
    • 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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

@sean-zlai sean-zlai left a comment

Choose a reason for hiding this comment

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

When I peaked at the PR earlier, I was going to double check about needing it defined tsconfig.json as well, but saw you already did :). LGTM!

@ken-zlai ken-zlai merged commit db12b81 into main Jan 16, 2025
4 checks passed
@ken-zlai ken-zlai deleted the ken/relative-imports branch January 16, 2025 23:47
@coderabbitai coderabbitai bot mentioned this pull request Jan 29, 2025
4 tasks
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.

2 participants