Skip to content

Commit 42144af

Browse files
committed
docs: Nuxi CLI
1 parent fc554cd commit 42144af

File tree

2 files changed

+27
-16
lines changed

2 files changed

+27
-16
lines changed

README.md

Lines changed: 26 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@
3232

3333
- [Project directories and files creation](#project-directories-and-files-creation)
3434
- [Dependencies management](#dependencies-management)
35-
- [Nuxt/Custom Snippets](#nuxtcustom-snippets)
3635
- [IntelliSense and Auto Completion](#intellisense-and-auto-completion)
36+
- [Nuxt/Custom Snippets](#nuxtcustom-snippets)
3737
- [Vue File Templates](#vue-file-templates)
3838
- [srcDir, serverDir and monorepo support](#srcdir-serverdir-and-monorepo-support)
3939
- [Run scripts from the VSCode command palette or sidebar.](#run-scripts-from-the-vscode-command-palette-or-sidebar)
@@ -87,6 +87,31 @@ And auto open the created file using:
8787

8888
![Nuxt Dependencies](./.github/media/dependencies.png)
8989

90+
<br>
91+
<br>
92+
93+
### IntelliSense and Auto Completion
94+
95+
Nuxtr VSCode offers a robust IntelliSense with focused support for Vue files, offering relative path completion from the pages directory for [NuxtLinks](https://nuxt.com/docs/api/components/nuxt-link#internal-routing) and from the [public or static directories](https://nuxt.com/docs/guide/directory-structure/public) for media resources, depending on your Nuxt version. Moreover, it offers IntelliSense for essential configuration files like [`.nuxtignore`](https://nuxt.com/docs/guide/directory-structure/nuxtignore) and [`.nuxtrc`](), empowering you with accurate insights and efficient coding.
96+
97+
You can enable/disable IntelliSense from the settings:
98+
99+
```JSON
100+
"nuxtr.intellisense.nuxtrc": true,
101+
"nuxtr.intellisense.vueFiles": true,
102+
"nuxtr.intellisense.nuxtignore": true,
103+
```
104+
105+
<br>
106+
<br>
107+
108+
### Nuxi CLI Integration
109+
110+
The Nuxt CLI, also known as [Nuxi](https://github.com/nuxt/cli), stands as an indispensable tool in the arsenal of every Nuxt developer. Nuxtr seamlessly incorporates this powerful CLI, allowing you to execute Nuxi commands right from the command palette. Under the `Nuxtr: Run` prefix, you'll find a set of pre-defined most-used commands readily available. Additionally, you have the option to access the complete list of Nuxi commands through the `Nuxtr: Nuxi CLI` command.
111+
112+
While it's entirely sensible to employ the CLI directly from your terminal, Nuxtr's inclusion will enhance your DX working with multiple terminals. It provides a structured approach to your terminal environment, categorizing commands based on their scope. This not only streamlines your workflow but also simplifies the process of adding modules, eliminating the need to recall or search for exact names.
113+
114+
90115
<br>
91116
<br>
92117

@@ -114,20 +139,6 @@ More on this side of the extension is coming soon!
114139

115140
![Snippets](./.github/media/snippets.gif)
116141

117-
<br>
118-
<br>
119-
120-
### IntelliSense and Auto Completion
121-
122-
Nuxtr VSCode offers a robust IntelliSense with focused support for Vue files, offering relative path completion from the pages directory for [NuxtLinks](https://nuxt.com/docs/api/components/nuxt-link#internal-routing) and from the [public or static directories](https://nuxt.com/docs/guide/directory-structure/public) for media resources, depending on your Nuxt version. Moreover, it offers IntelliSense for essential configuration files like [`.nuxtignore`](https://nuxt.com/docs/guide/directory-structure/nuxtignore) and [`.nuxtrc`](), empowering you with accurate insights and efficient coding.
123-
124-
You can enable/disable IntelliSense from the settings:
125-
126-
```JSON
127-
"nuxtr.intellisense.nuxtrc": true,
128-
"nuxtr.intellisense.vueFiles": true,
129-
"nuxtr.intellisense.nuxtignore": true,
130-
```
131142

132143
<br>
133144
<br>

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -804,7 +804,7 @@
804804
},
805805
{
806806
"command": "nuxtr.showCLICommands",
807-
"title": "Nuxi CLI Commands",
807+
"title": "Nuxi CLI",
808808
"category": "Nuxtr",
809809
"when": "nuxtr.isNuxtProject"
810810
},

0 commit comments

Comments
 (0)