Skip to content

Commit

Permalink
create-svelte: Add descriptions to select options (#5221)
Browse files Browse the repository at this point in the history
* [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 <hello@rich-harris.dev>
  • Loading branch information
gtm-nayan and Rich-Harris authored Jun 22, 2022
1 parent 79959b0 commit d745435
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 8 deletions.
5 changes: 5 additions & 0 deletions .changeset/thick-swans-join.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'create-svelte': patch
---

Add descriptions to templates, and make TypeScript options more self-explanatory
19 changes: 13 additions & 6 deletions packages/create-svelte/bin.js
Original file line number Diff line number Diff line change
Expand Up @@ -61,23 +61,30 @@ 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
};
})
},
{
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 }
]
},
{
Expand Down
3 changes: 2 additions & 1 deletion packages/create-svelte/templates/default/.meta.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
{
"description": "SvelteKit demo app"
"title": "SvelteKit demo app",
"description": "A todo list app showcasing some of the features of SvelteKit"
}
3 changes: 2 additions & 1 deletion packages/create-svelte/templates/skeleton/.meta.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
{
"description": "Skeleton project"
"title": "Skeleton project",
"description": "Barebones scaffolding for your new SvelteKit app"
}

0 comments on commit d745435

Please sign in to comment.