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

Improve error message when a Svelte config is not found #3219

Merged
merged 14 commits into from
Jan 7, 2022
Merged

Improve error message when a Svelte config is not found #3219

merged 14 commits into from
Jan 7, 2022

Conversation

ykomatsu
Copy link
Contributor

@ykomatsu ykomatsu commented Jan 6, 2022

svelte-kit error message can be a bit confusing when both svelte.config.js and svelte.config.cjs are absent.
We need svelte.config.js , not svelte.config.cjs :

$ npm run dev
Cannot find module '/Users/ykoma/Repositories/kit-playground/svelte.config.cjs' imported from /Users/ykoma/Repositories/kit-playground/node_modules/@sveltejs/kit/dist/cli.js
...

After this PR:

$ npm run dev
Cannot find module '/Users/ykoma/Repositories/kit-playground/svelte.config.js' imported from /Users/ykoma/Repositories/kit-playground/node_modules/@sveltejs/kit/dist/cli.js
...

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 pnpx changeset and following the prompts. All changesets should be patch until SvelteKit 1.0

@changeset-bot
Copy link

changeset-bot bot commented Jan 6, 2022

🦋 Changeset detected

Latest commit: b70a118

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@sveltejs/kit Patch

Not sure what this means? Click here to learn what changesets are.

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

@netlify
Copy link

netlify bot commented Jan 6, 2022

✔️ Deploy Preview for kit-demo canceled.

🔨 Explore the source changes: b70a118

🔍 Inspect the deploy log: https://app.netlify.com/sites/kit-demo/deploys/61d7ad34dda44000083efb39

Copy link
Member

@dummdidumm dummdidumm left a comment

Choose a reason for hiding this comment

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

Please provide a changeset, other than that this looks good 👍

Co-authored-by: Bjorn Lu <bjornlu.dev@gmail.com>
@ykomatsu ykomatsu changed the title Improve an error message for MODULE_NOT_FOUND Improve an error message when a Svelte config is not found Jan 6, 2022
@ykomatsu ykomatsu changed the title Improve an error message when a Svelte config is not found Improve error message when a Svelte config is not found Jan 6, 2022
Copy link
Member

@Rich-Harris Rich-Harris left a comment

Choose a reason for hiding this comment

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

Thank you! This still isn't a great error message though — it should be a much more explicit 'Missing svelte.config.js', or perhaps

You need to create a svelte.config.js file — see https://kit.svelte.dev/docs#configuration

In fact, there's already some logic for that, it's just a) in a weird place that means it never actually runs, and b) overly complicated. We should just check to see if svelte.config.js or svelte.config.cjs exists, and if not throw a helpful error inside load_config

@Rich-Harris
Copy link
Member

Thanks. Realised we can actually simplify this stuff quite a bit, because the checks for svelte.config.cjs and vite.config.js are from many months ago, and really aren't needed any more

@Rich-Harris Rich-Harris merged commit 1a7c0da into sveltejs:master Jan 7, 2022
@github-actions github-actions bot mentioned this pull request Jan 7, 2022
@ykomatsu ykomatsu deleted the load-config branch January 7, 2022 18:02
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.

4 participants