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

docs: explain why typescript is added either way #8484

Merged
merged 8 commits into from
Jan 13, 2023
Merged

Conversation

dummdidumm
Copy link
Member

@dummdidumm dummdidumm commented Jan 12, 2023

for a library project
closes #8189
also always add jsconfig.json, closes #7475

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:.

@changeset-bot
Copy link

changeset-bot bot commented Jan 12, 2023

🦋 Changeset detected

Latest commit: e47149a

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

This PR includes changesets to release 1 package
Name Type
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

@@ -136,6 +136,10 @@ async function main() {
} else if (options.types === 'checkjs') {
console.log(bold('✔ Type-checked JavaScript'));
console.log(' https://www.typescriptlang.org/tsconfig#checkJs');
} else if (options.template === 'skeletonlib') {
console.log(
'🛈 You chose to not add type checking, but TypeScript will still be installed in order to generate type definitions when building the library'
Copy link
Member

Choose a reason for hiding this comment

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

what character is this supposed to be? it shows up empty in my terminal

Copy link
Member Author

Choose a reason for hiding this comment

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

Huh, I saw it locally - it's supposed to be an info sign

Copy link
Member Author

Choose a reason for hiding this comment

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

I replaced it with a warning sign, which looks better in combination with the check marks anyway - hopefully you see that one now

Copy link
Member

Choose a reason for hiding this comment

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

i do, though the ⚠ character tends to look awful in a terminal context — on this MBP, where excellent font rendering is something you take for granted, it's a pixelated mess. I swapped it out for a yellow ▲ character instead

@idleman
Copy link

idleman commented Jan 13, 2023

"You chose to not add type checking, but TypeScript will still be installed in order to generate type definitions when building the library". Must projects never do this. so no, it is not a reason at all.

@Rich-Harris
Copy link
Member

Must projects never do this. so no, it is not a reason at all.

This change only applies if you create a library project. If you're creating a library project then yeah, you're gonna build it

@idleman
Copy link

idleman commented Jan 17, 2023

Must projects never do this. so no, it is not a reason at all.

This change only applies if you create a library project. If you're creating a library project then yeah, you're gonna build it

Thanks for clarification. Thought it was always installed. You never know these days.

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.

TypeScript added when not requested Error while creating 'Library skeleton project'
3 participants