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

Clarified file name in error message as per #7029 #7108

Merged
merged 4 commits into from Oct 2, 2022
Merged

Clarified file name in error message as per #7029 #7108

merged 4 commits into from Oct 2, 2022

Conversation

jacoblukewood
Copy link
Contributor

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

As per #7029 the displayed error message suggesting the user enable prerendering in the +layout.js/+layout.ts file should include the plus symbol and let the user know that if they are using TS, they should make the change in the .ts file.

@changeset-bot
Copy link

changeset-bot bot commented Oct 1, 2022

🦋 Changeset detected

Latest commit: 8f86a37

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

This PR includes changesets to release 1 package
Name Type
@sveltejs/adapter-static 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

@Conduitry
Copy link
Member

I'm in favor of adding the + because what's there now is wrong. I'm hesitant about adding (+layout.ts if your project is using TypeScript) because a) this error message is already pretty long and b) mentioning this sort of thing everywhere we mention a JS file is a slippery slope that will start to bog down all of our documentation and messages.

As a compromise, I could probably live with +layout.js/+layout.ts or +layout.js/.ts - but I think we can expect TypeScript users to mostly internally automatically translate references to .js into .ts without us needing to call it out as a possibility every time.

@dummdidumm
Copy link
Member

+1 on just adding the +

@jacoblukewood
Copy link
Contributor Author

I'm in favor of adding the + because what's there now is wrong. I'm hesitant about adding (+layout.ts if your project is using TypeScript) because a) this error message is already pretty long and b) mentioning this sort of thing everywhere we mention a JS file is a slippery slope that will start to bog down all of our documentation and messages.

As a compromise, I could probably live with +layout.js/+layout.ts or +layout.js/.ts - but I think we can expect TypeScript users to mostly internally automatically translate references to .js into .ts without us needing to call it out as a possibility every time.

I agree that it does make the message quite long. I think +layout.js/.ts is a suitable replacement. I have made the suggested changed to the PR.

@Rich-Harris Rich-Harris merged commit 9a941a1 into sveltejs:master Oct 2, 2022
@Rich-Harris
Copy link
Member

thank you

@github-actions github-actions bot mentioned this pull request Oct 2, 2022
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.

None yet

4 participants