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

rename App.PageError to App.Error #6963

Merged
merged 4 commits into from
Sep 22, 2022
Merged

rename App.PageError to App.Error #6963

merged 4 commits into from
Sep 22, 2022

Conversation

Rich-Harris
Copy link
Member

closes #6905. This is a breaking change, but I expect it to be very limited in impact.

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. All changesets should be patch until SvelteKit 1.0

@changeset-bot
Copy link

changeset-bot bot commented Sep 22, 2022

🦋 Changeset detected

Latest commit: 2f0f71e

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

This PR includes changesets to release 2 packages
Name Type
@sveltejs/kit Patch
create-svelte 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

@dummdidumm
Copy link
Member

Do you want to implement the "try to rename that inside src/app.d.ts during sync" thing I proposed in the issue, or did you decide against it?

@Rich-Harris
Copy link
Member Author

I agree with Dominik that it's probably a slippery slope. I think throwing an error telling the user to change it could be good, it just felt like a lot of effort when considering that we don't enforce a specific location for the user to declare those namespaces

@dummdidumm
Copy link
Member

dummdidumm commented Sep 22, 2022

We don't but I guess that 90% of the 5% of people that use this have it inside src/app.d.ts, which is where the starter templates put this, so we could check if that file exists, if yes if it has the app namespace, if yes if it has AppError in there, if yes throw, else do nothing.

@Rich-Harris Rich-Harris merged commit 868e5f5 into master Sep 22, 2022
@Rich-Harris Rich-Harris deleted the gh-6905 branch September 22, 2022 19:42
@asmajlovicmars
Copy link

asmajlovicmars commented Sep 23, 2022

Not sure if it matters much, but even if PageError is commented in app.d.ts/js, the error will be produced:
error when starting dev server:
Error: App.PageError has been renamed to App.Error — please update your src/app.d.ts

// app.d.ts
// interface PageError {}

@dummdidumm
Copy link
Member

Mhm yeah that's probably very annoying for everyone who doesn't even use it - probably worth expanding the check to see if it's commented out.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

App.PageError should probably be renamed App.Error
3 participants