Skip to content
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

Next.js: Support path aliases when no base url is set #26651

Merged
merged 1 commit into from Mar 27, 2024

Conversation

yannbf
Copy link
Member

@yannbf yannbf commented Mar 26, 2024

Closes #11639

What I did

When testing a Nextjs project, I noticed that the path aliases were not working, even though I had them set up correctly.
As of TypeScript 4.1, baseUrl is no longer required, and therefore we shouldn't safeguard against not having it.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

This was manually tested in the following scenarios:

  • Nextjs + TS + tsconfig with baseUrl set [works]
  • Nextjs + TS + tsconfig with no baseUrl set [works]
  • Nextjs + JS + jsconfig [works]
  • Nextjs + JS + no jsconfig [bails]
  1. Run a sandbox for a NextJS template, e.g. yarn task --task sandbox --start-from auto --template nextjs/default-ts
  2. Remove baseUrl from tsconfig.json
  3. Storybook should still work if components use path aliases

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

@yannbf yannbf added bug patch:yes Bugfix & documentation PR that need to be picked to main branch nextjs ci:merged Run the CI jobs that normally run when merged. labels Mar 26, 2024
@yannbf yannbf self-assigned this Mar 26, 2024
Copy link

nx-cloud bot commented Mar 26, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit d80b2fb. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@valentinpalkovic valentinpalkovic merged commit 44fc0b6 into next Mar 27, 2024
67 of 74 checks passed
@valentinpalkovic valentinpalkovic deleted the yann/fix-tsconfig-paths-nextjs branch March 27, 2024 06:44
@github-actions github-actions bot mentioned this pull request Mar 27, 2024
22 tasks
storybook-bot pushed a commit that referenced this pull request Mar 28, 2024
…xtjs

NextJS: Support path aliases when no base url is set
(cherry picked from commit 44fc0b6)
@github-actions github-actions bot mentioned this pull request Mar 28, 2024
11 tasks
storybook-bot pushed a commit that referenced this pull request Mar 28, 2024
…xtjs

NextJS: Support path aliases when no base url is set
(cherry picked from commit 44fc0b6)
storybook-bot pushed a commit that referenced this pull request Mar 28, 2024
…xtjs

NextJS: Support path aliases when no base url is set
(cherry picked from commit 44fc0b6)
storybook-bot pushed a commit that referenced this pull request Apr 1, 2024
…xtjs

NextJS: Support path aliases when no base url is set
(cherry picked from commit 44fc0b6)
@valentinpalkovic valentinpalkovic changed the title NextJS: Support path aliases when no base url is set Next.js: Support path aliases when no base url is set Apr 1, 2024
storybook-bot pushed a commit that referenced this pull request Apr 1, 2024
…xtjs

NextJS: Support path aliases when no base url is set
(cherry picked from commit 44fc0b6)
storybook-bot pushed a commit that referenced this pull request Apr 2, 2024
…xtjs

NextJS: Support path aliases when no base url is set
(cherry picked from commit 44fc0b6)
storybook-bot pushed a commit that referenced this pull request Apr 2, 2024
…xtjs

NextJS: Support path aliases when no base url is set
(cherry picked from commit 44fc0b6)
storybook-bot pushed a commit that referenced this pull request Apr 2, 2024
…xtjs

NextJS: Support path aliases when no base url is set
(cherry picked from commit 44fc0b6)
storybook-bot pushed a commit that referenced this pull request Apr 3, 2024
…xtjs

NextJS: Support path aliases when no base url is set
(cherry picked from commit 44fc0b6)
storybook-bot pushed a commit that referenced this pull request Apr 3, 2024
…xtjs

NextJS: Support path aliases when no base url is set
(cherry picked from commit 44fc0b6)
storybook-bot pushed a commit that referenced this pull request Apr 3, 2024
…xtjs

NextJS: Support path aliases when no base url is set
(cherry picked from commit 44fc0b6)
storybook-bot pushed a commit that referenced this pull request Apr 4, 2024
…xtjs

NextJS: Support path aliases when no base url is set
(cherry picked from commit 44fc0b6)
storybook-bot pushed a commit that referenced this pull request Apr 4, 2024
…xtjs

NextJS: Support path aliases when no base url is set
(cherry picked from commit 44fc0b6)
storybook-bot pushed a commit that referenced this pull request Apr 4, 2024
…xtjs

NextJS: Support path aliases when no base url is set
(cherry picked from commit 44fc0b6)
storybook-bot pushed a commit that referenced this pull request Apr 4, 2024
…xtjs

NextJS: Support path aliases when no base url is set
(cherry picked from commit 44fc0b6)
storybook-bot pushed a commit that referenced this pull request Apr 5, 2024
…xtjs

NextJS: Support path aliases when no base url is set
(cherry picked from commit 44fc0b6)
storybook-bot pushed a commit that referenced this pull request Apr 5, 2024
…xtjs

NextJS: Support path aliases when no base url is set
(cherry picked from commit 44fc0b6)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Apr 5, 2024
@SalahAdDin
Copy link

Does this PR solve this issue?

@valentinpalkovic
Copy link
Contributor

No, this is unrelated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug ci:merged Run the CI jobs that normally run when merged. nextjs patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Storybook is not able to resolve path with Next js absolute import
3 participants