From d745435f72e41b1413215cf4965c17bcfb898a0d Mon Sep 17 00:00:00 2001 From: gtmnayan <50981692+gtm-nayan@users.noreply.github.com> Date: Wed, 22 Jun 2022 20:04:15 +0545 Subject: [PATCH] create-svelte: Add descriptions to select options (#5221) * [create-svelte] Add descriptions to select options * changeset * Obsoleteify? description * formatting * Update .meta.json * Update packages/create-svelte/bin.js * Update packages/create-svelte/bin.js * Update packages/create-svelte/bin.js * Update packages/create-svelte/bin.js * Update .changeset/thick-swans-join.md Co-authored-by: Rich Harris --- .changeset/thick-swans-join.md | 5 +++++ packages/create-svelte/bin.js | 19 +++++++++++++------ .../templates/default/.meta.json | 3 ++- .../templates/skeleton/.meta.json | 3 ++- 4 files changed, 22 insertions(+), 8 deletions(-) create mode 100644 .changeset/thick-swans-join.md diff --git a/.changeset/thick-swans-join.md b/.changeset/thick-swans-join.md new file mode 100644 index 000000000000..69ec820a2c42 --- /dev/null +++ b/.changeset/thick-swans-join.md @@ -0,0 +1,5 @@ +--- +'create-svelte': patch +--- + +Add descriptions to templates, and make TypeScript options more self-explanatory diff --git a/packages/create-svelte/bin.js b/packages/create-svelte/bin.js index 0997c21c274b..96bdfb5e1d51 100755 --- a/packages/create-svelte/bin.js +++ b/packages/create-svelte/bin.js @@ -61,10 +61,11 @@ async function main() { message: 'Which Svelte app template?', choices: fs.readdirSync(dist('templates')).map((dir) => { const meta_file = dist(`templates/${dir}/meta.json`); - const meta = JSON.parse(fs.readFileSync(meta_file, 'utf8')); + const { title, description } = JSON.parse(fs.readFileSync(meta_file, 'utf8')); return { - title: meta.description, + title, + description, value: dir }; }) @@ -72,12 +73,18 @@ async function main() { { type: 'select', name: 'types', - message: 'Add type checking?', + message: 'Add type checking with TypeScript?', initial: false, choices: [ - { title: 'Type-checked JavaScript', value: 'checkjs' }, - { title: 'TypeScript', value: 'typescript' }, - { title: 'None', value: null } + { + title: 'Yes, using JavaScript with JSDoc comments', + value: 'checkjs' + }, + { + title: 'Yes, using TypeScript syntax', + value: 'typescript' + }, + { title: 'No', value: null } ] }, { diff --git a/packages/create-svelte/templates/default/.meta.json b/packages/create-svelte/templates/default/.meta.json index a8ae4ca55d49..724899fe471d 100644 --- a/packages/create-svelte/templates/default/.meta.json +++ b/packages/create-svelte/templates/default/.meta.json @@ -1,3 +1,4 @@ { - "description": "SvelteKit demo app" + "title": "SvelteKit demo app", + "description": "A todo list app showcasing some of the features of SvelteKit" } diff --git a/packages/create-svelte/templates/skeleton/.meta.json b/packages/create-svelte/templates/skeleton/.meta.json index 279d0263563c..c707b6a95088 100644 --- a/packages/create-svelte/templates/skeleton/.meta.json +++ b/packages/create-svelte/templates/skeleton/.meta.json @@ -1,3 +1,4 @@ { - "description": "Skeleton project" + "title": "Skeleton project", + "description": "Barebones scaffolding for your new SvelteKit app" }