Skip to content

fix: use tsc-alias for path alias compilation #9

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 1 commit into from
Jun 29, 2025
Merged

Conversation

DaxServer
Copy link
Contributor

@DaxServer DaxServer commented Jun 29, 2025

Summary by CodeRabbit

  • Chores
    • Updated build process to improve compatibility with TypeScript path aliases. No impact on app functionality.

Copy link

coderabbitai bot commented Jun 29, 2025

Walkthrough

The package.json was updated to modify the build process by running tsc-alias after tsc in the build script. Additionally, tsc-alias was added as a development dependency. No changes were made to exported or public entities.

Changes

File Change Summary
package.json Updated build script to run tsc && tsc-alias; added tsc-alias as a dev dependency

Poem

The build now hops from tsc to alias with cheer,
With tsc-alias added, our paths are clear!
Scripts in the garden, dependencies in line,
This bunny’s code is looking fine.
🐇✨


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

@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 (1)
package.json (1)

35-35: Consider delegating tsc-alias to a postbuild script for cleaner chaining and clearer failure handling

Running tsc && tsc-alias inline works, but:

  1. A postbuild script keeps the primary build step focused on transpilation while letting NPM automatically run postbuild if (and only if) tsc succeeds.
  2. It avoids the shell-specific && operator, reducing cross-platform quirks (PowerShell, Yarn 2 PNP, etc.).
  3. Makes it easier to add more post-processing steps later (e.g., rimraf, cp).

Example diff:

"scripts": {
-  "build": "tsc && tsc-alias",
+  "build": "tsc",
+  "postbuild": "tsc-alias",

Not critical, but improves maintainability.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5920191 and 9db4e9c.

⛔ Files ignored due to path filters (1)
  • bun.lock is excluded by !**/*.lock
📒 Files selected for processing (1)
  • package.json (2 hunks)
🔇 Additional comments (1)
package.json (1)

47-47: Verify that tsc-alias aligns with your tsconfig.json path mappings

Good call adding the dev dependency. Double-check:

  1. compilerOptions.paths & baseUrl are set; otherwise tsc-alias is a no-op.
  2. outDir and rootDir are correct, or pass --outDir/--resolve-full-paths flags to tsc-alias.
  3. In watch mode (npm run dev) aliases will still be unresolved; consider tsc-alias -w or tsx/ts-node for dev if you hit runtime module-not-found errors.

If everything is configured, no further action needed.

@DaxServer DaxServer merged commit fd13c4e into main Jun 29, 2025
3 checks passed
@DaxServer DaxServer deleted the path-alias branch June 29, 2025 15:30
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