-
-
Notifications
You must be signed in to change notification settings - Fork 2k
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
create-svelte: Add descriptions to select options #5221
create-svelte: Add descriptions to select options #5221
Conversation
🦋 Changeset detectedLatest commit: f3ae911 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
packages/create-svelte/bin.js
Outdated
value: 'checkjs' | ||
}, | ||
{ | ||
title: 'With TypeScript annotations', |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe it's not just annotations, but the actual source is written in TypeScript
title: 'With TypeScript annotations', | |
title: 'Source is written TypeScript', |
packages/create-svelte/bin.js
Outdated
{ title: 'Type-checked JavaScript', value: 'checkjs' }, | ||
{ title: 'TypeScript', value: 'typescript' }, | ||
{ | ||
title: 'With JavaScript comments (JSDoc)', |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
might need a bit more explanation of what this is. but hopefully this isn't too long
title: 'With JavaScript comments (JSDoc)', | |
title: 'Runs TypeScript's type checking against JavaScript comments (JSDoc)', |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it would be better if it would be at same line... now it looks like another option.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree it looks nicer on the same line
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Type-Checked JavaScript - check for types in JS with JSDoc.
TypeScript - check for types with TS.
None - Don't check for types.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Or how it was in #5221 (comment) but shortcut JS and TS, and maybe replace last part with and run TSC to check types.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Another one: Do you want type checking?
|
The reason I proposed
is because 'JSDoc comments' by itself is too vague. We're specifically using the TypeScript flavour/subset of JSDoc (allowing us to e.g. import |
"Use TypeScript?" by itself would likely be interpreted as the TypeScript language itself.
|
another option. |
I tweaked @gtm-nayan's suggestion in #5221 (comment) very slightly and committed it, so that the diff is once again legible. I think we're in a good place so I'll approve the PR, but will leave it open in case we want to bikeshed further |
closes #5217
Please don't delete this checklist! Before submitting the PR, please make sure you do the following:
Tests
pnpm test
and lint the project withpnpm lint
andpnpm check
Changesets
pnpm changeset
and following the prompts. All changesets should bepatch
until SvelteKit 1.0Here's how the descriptions look