Skip to content

Commit 05abdbe

Browse files
committed
feat: custom project starters
1 parent 26c0769 commit 05abdbe

File tree

9 files changed

+312
-183
lines changed

9 files changed

+312
-183
lines changed

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,23 @@
3636
<br>
3737
<br>
3838

39+
### Project Creation
40+
41+
Using `Nuxtr: Create Nuxt project` command, you can create a new Nuxt project with a few steps. You can choose a project starter from [Nuxt Startes](https://nuxt.new) or you can add your own project started:
42+
43+
```JSON
44+
"nuxtr.projectTemplates": [
45+
{
46+
"name": "Vitesse",
47+
"description": " Vitesse for Nuxt 3 🏔💚⚡️ ",
48+
"repoURL": "https://github.com/antfu/vitesse-nuxt3",
49+
"branch": "main", // Optional
50+
},
51+
],
52+
```
53+
54+
<br>
55+
3956
### Directory and File Creation
4057

4158
Effortlessly generate all essential directories and files for your Nuxt project right from within VSCode. Utilize the command palette or context menus to swiftly create Vue/TypeScript files, as well as special files like [`.nuxtignore`](https://nuxt.com/docs/guide/directory-structure/nuxtignore), [`.nuxtrc`](https://nuxt.com/docs/api/configuration/nuxt-config), and [`app.config.ts`](https://nuxt.com/docs/guide/directory-structure/app-config).
@@ -87,7 +104,7 @@ Additionally, you can choose to automatically open the newly created file with:
87104

88105
### IntelliSense and Auto Completion
89106

90-
Nuxtr VSCode offers robust IntelliSense capabilities tailored for Vue files. This includes dynamic path completion for [NuxtLinks](https://nuxt.com/docs/api/components/nuxt-link#internal-routing) within the pages directory, and seamless handling of media resources from the [public or static directories](https://nuxt.com/docs/guide/directory-structure/public), depending on your Nuxt version. Additionally, enjoy IntelliSense support for critical configuration files like [`.nuxtignore`](https://nuxt.com/docs/guide/directory-structure/nuxtignore) and [`.nuxtrc`](https://nuxt.com/docs/guide/directory-structure/nuxtrc), ensuring precise guidance and efficient coding.
107+
Nuxtr offers robust IntelliSense capabilities tailored for Vue files. This includes dynamic path completion for [NuxtLinks](https://nuxt.com/docs/api/components/nuxt-link#internal-routing) within the pages directory, and seamless handling of media resources from the [public or static directories](https://nuxt.com/docs/guide/directory-structure/public), depending on your Nuxt version. Additionally, enjoy IntelliSense support for critical configuration files like [`.nuxtignore`](https://nuxt.com/docs/guide/directory-structure/nuxtignore) and [`.nuxtrc`](https://nuxt.com/docs/guide/directory-structure/nuxtrc), ensuring precise guidance and efficient coding.
91108

92109
You can enable/disable IntelliSense from the settings:
93110

@@ -242,7 +259,7 @@ If you have any idea, feel free to [open a discussion](https://github.com/orgs/n
242259

243260
### Acknowledgements
244261

245-
Nuxtr VSCode relies on the following projects/repositories:
262+
Nuxtr relies on the following projects/repositories:
246263

247264
- [Nuxt Modules](https://github.com/nuxt/modules)
248265
- [Nuxt Assets](https://github.com/nuxt/assets)

package.json

Lines changed: 31 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"displayName": "Nuxtr",
44
"description": "An extension for Nuxt.js offering commands and tools to make your experience more pleasant.",
55
"version": "0.2.10",
6-
"packageManager": "pnpm@8.11.0",
6+
"packageManager": "pnpm@8.12.1",
77
"engines": {
88
"vscode": "^1.84.0"
99
},
@@ -497,6 +497,32 @@
497497
"type": "string",
498498
"default": null,
499499
"description": "Nuxt project path inside your monorepo"
500+
},
501+
"nuxtr.projectTemplates": {
502+
"type": "array",
503+
"default": [],
504+
"items": {
505+
"type": "object",
506+
"properties": {
507+
"name": {
508+
"type": "string",
509+
"description": "Template Name."
510+
},
511+
"description": {
512+
"type": "string",
513+
"description": "Description template."
514+
},
515+
"repoURL": {
516+
"type": "string",
517+
"description": "Repo URL of the template."
518+
}
519+
},
520+
"required": [
521+
"name",
522+
"description",
523+
"repoURL"
524+
]
525+
}
500526
}
501527
}
502528
},
@@ -1066,11 +1092,11 @@
10661092
"@types/node": "20.4.1",
10671093
"@types/util.promisify": "^1.0.8",
10681094
"@types/vscode": "^1.85.0",
1069-
"@typescript-eslint/eslint-plugin": "^6.13.2",
1070-
"@typescript-eslint/parser": "^6.13.2",
1095+
"@typescript-eslint/eslint-plugin": "^6.14.0",
1096+
"@typescript-eslint/parser": "^6.14.0",
10711097
"@vscode/test-electron": "^2.3.8",
10721098
"changelogen": "^0.5.5",
1073-
"eslint": "^8.55.0",
1099+
"eslint": "^8.56.0",
10741100
"nuxi-edge": "3.9.1-1697113884.a6acb6a",
10751101
"taze": "^0.11.4",
10761102
"terser": "^5.26.0",
@@ -1099,4 +1125,4 @@
10991125
"uglify-js@<2.4.24": ">=2.4.24"
11001126
}
11011127
}
1102-
}
1128+
}

0 commit comments

Comments
 (0)