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

feat: Improve errors from dev-time illegal module imports #13329

Merged
merged 6 commits into from
Jan 22, 2025

Conversation

elliott-with-the-longest-name-on-github
Copy link
Contributor

There are some (rightful) complaints that the errors we provide are super unhelpful:

Neither of these describes an actual bug, but they do show some frustration. Because we don't have knowledge of the full module graph during devtime, the error messages are kinda nasty and unhelpful, especially when we can't even provide information about the importer. This adds some information to the error to make it easier to understand. New errors will look like this:

Cannot import ${illegal_module} into client-side code. This could leak sensitive information.`
{if importer is available: Imported by ${importer}.}
Tips:
 - To resolve this error, ensure that no exports from ${illegal_module} is not used, even transitively, in client-side code.
 - If you're only using the import as a type, change it to \`import type\`.
 - If you're not sure which module is causing this, try building your app -- it will create a more helpful error.

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.

Tests

  • Run the tests with pnpm test and lint the project with pnpm lint and pnpm check

Changesets

  • If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

Edits

  • Please ensure that 'Allow edits from maintainers' is checked. PRs without this option may be closed.

@Rich-Harris
Copy link
Member

preview: https://svelte-dev-git-preview-kit-13329-svelte.vercel.app/

this is an automated message

packages/kit/src/exports/vite/index.js Outdated Show resolved Hide resolved
Copy link

changeset-bot bot commented Jan 17, 2025

⚠️ No Changeset found

Latest commit: 7313432

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@dummdidumm
Copy link
Member

Needs to adjust the test output, then this is good to go

@eltigerchino eltigerchino merged commit 416dbdf into main Jan 22, 2025
14 checks passed
@eltigerchino eltigerchino deleted the elliott/improve-env-errors branch January 22, 2025 07:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
5 participants