Skip to content

Commit 0304bd7

Browse files
committed
🚀 RELEASE: Version 0.1.1
1 parent 763ba16 commit 0304bd7

File tree

5 files changed

+208
-72
lines changed

5 files changed

+208
-72
lines changed

.github/media/dependencies.gif

-2.34 MB
Binary file not shown.
-2.16 MB
Binary file not shown.

.github/media/items_creation.gif

-1.52 MB
Binary file not shown.

CHANGELOG.md

Lines changed: 109 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -2,71 +2,149 @@
22

33
<br>
44

5+
### Version 0.1.0
6+
<br>
7+
8+
📦 New
9+
10+
- All Nuxt API (Components/Composables/Utils) snippets.
11+
- Snippets section in Project View.
12+
- Introducing File Templates for pages/layout:
13+
- File Templates section in Project View.
14+
- `nuxtr.vueFiles.pages.defaultTemplate` setting.
15+
- `nuxtr.vueFiles.layouts.defaultTemplate` setting.
16+
- `.page-template` and `.layout-template` extensions for ile templates.
17+
- Actions to add (Modules/Plugins/ and Layers) in `nuxt.config.ts`.
18+
- Auto adding plugins to `nuxt.config.ts` upon creating them.
19+
- Layers detection and auto adding to `extends` field inside `nuxt.config.ts`.
20+
- Linters Configuration (ESLint/Stylelint).
21+
- `srcDir` and Monorepo Support.
22+
- `nuxtr.monorepoMode.DiretoryName` setting.
23+
- Output channel.
24+
- New filter for Ingration view (modules/layers/all).
25+
- Outdated NPM dependencies update statusBar Icon.
26+
27+
✨ Improvements
28+
29+
- Dynamic Store naming.
30+
- Nested API/Composables creation support.
31+
- Project View Sidebar UI.
32+
- Running Nuxtr on VSCode startup finishing.
33+
- Handling deprected configuration for Devtools.
34+
- Dependencies section UI in Project View.
35+
36+
37+
🩹 Fixes
38+
39+
- vueFiles Templates: `lang=ts` in script tag.
40+
- Including `nuxtr.vueFiles.firstTag` setting in `package.json`.
41+
42+
<br>
43+
44+
💚 Contributions
45+
46+
- [Anas Obaidat](https://github.com/anasobeidat)
47+
- [Mohammad Nsairat](https://github.com/Nsairat)
48+
49+
<br>
50+
551
### Version 0.0.6
652

7-
- 📦 NEW: Install and Configure Vuetify.
8-
- ✨ IMPROVE: Commmands prefixing.
9-
- ✨ IMPROVE: Information/Error messages.
10-
- ✨ IMPROVE: Context menu prefixing.
11-
- ✨ IMPROVE: Handling no lockfiles or default package manager.
12-
- ✨ IMPROVE: Nuxt Devtools installation for Linux/Windows.
13-
- ✨ IMPROVE: vueFiles templates.
14-
- 🐞 FIX: Sidebar not working on Windows.
53+
<br>
54+
55+
📦 New
56+
- Supporting Vuetify among the CSS frameworks.
57+
58+
✨ Improvements
59+
60+
- Commands prefixing.
61+
- Information/Error messages & context menus.
62+
- Handling no lockfiles or default package manager.
63+
- Devtools installation for Linux/Windows.
64+
- vueFiles templates.
65+
66+
🩹 Fixes
67+
68+
- Sidebar not working on Windows.
1569

1670
<br>
1771

1872
### Version 0.0.5
1973

20-
- 🐞 FIX: Activity Bar icon not showing on Linux.
21-
- 🐞 FIX: Windows performance issues.
74+
<br>
75+
76+
🩹 Fixes
77+
78+
- Activity Bar icon not showing on Linux.
79+
- Windows performance issues.
2280

2381
<br>
2482

2583
### Version 0.0.4
2684

27-
- 📦 NEW: Install and Configure most CSS frameworks with few steps.
85+
<br>
86+
87+
📦 New
88+
89+
- Install and Configure most CSS frameworks with few steps.
2890
- TailwindCSS.
2991
- UnoCSS.
3092
- WindiCSS.
31-
- 📦 NEW: Introducing `nuxtr.vueFiles.style.alwaysScoped` setting.
32-
- 📦 NEW: Introducing `nuxtr.defaultPackageManager` setting.
33-
- 📦 NEW: Create Nuxt project directories Settings.
34-
- ✨ IMPROVE: Files creation is not relying on Nuxi CLI.
35-
- ✨ IMPROVE: Depndencies card in the sidebar.
36-
- ✨ IMPROVE: Grouping extension settings.
37-
- 🐞 FIX: Nuxt Devtools installation error on Windows & Linux.
38-
- 🐞 FIX: Activity Bar icon not showing on Linux.
93+
- Introducing `nuxtr.vueFiles.style.alwaysScoped` setting.
94+
- Introducing `nuxtr.defaultPackageManager` setting.
95+
- Create project directories Settings.
96+
97+
✨ Improvements
98+
99+
- Files creation is not relying on Nuxi CLI.
100+
- Dependencies card in the sidebar.
101+
- Grouping extension settings.
102+
103+
104+
🩹 Fixes
105+
106+
- Devtools installation error on Windows & Linux.
107+
- Activity Bar icon not showing on Linux.
39108

40109
<br>
41110

42111
### Version 0.0.3
43112

44-
- 📖 DOCS: Update README.md.
45-
- ✨ IMPROVE: Extension performance.
113+
<br>
114+
115+
📖 Documentation:
116+
117+
- Update README.md.
118+
119+
✨ Improvements
120+
121+
- Extension performance.
46122

47123
<br>
48124

49125

50126
### Version 0.0.2
51127

128+
<br>
129+
52130
- 📖 DOCS: Update README.md.
53131

54132
<br>
55133

56134

57135
### Version 0.0.1
58136

59-
- 📦 NEW: Create Nuxt project directories.
60-
- 📦 NEW: Create Nuxt.js files.
61-
- 📦 NEW: Open Nuxt.js Docs.
62-
- 📦 NEW: Installing dependencies.
63-
- 📦 NEW: Run scripts from the VSCode command palette or sidebar.
64-
- 📦 NEW: Toggle Nuxt Devtools from your status bar.
65-
- 📦 NEW: Install, remove and update project dependencies.
66-
- 📦 NEW: Search and install nuxt modules.
67-
68137
<br>
69138

139+
📦 New
70140

141+
- Create project directories.
142+
- Create files.
143+
- Open Nuxt.js Docs.
144+
- Installing dependencies.
145+
- Run scripts from the VSCode command palette or sidebar.
146+
- Toggle Devtools from your status bar.
147+
- Install, remove and update project dependencies.
148+
- Search and install modules.
71149

72-
150+
<br>

README.md

Lines changed: 99 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,58 @@
1-
### What does Nuxtr do?
1+
<br />
22

3-
Nuxtr VSCode extension offers a set of commands and tools to help with your Nuxt.js development workflow. You can create items (components, pages, layouts, stores, etc.), run Nuxt.js commands from the VSCode command palette. Toggle Nuxt Devtools from your status bar, manage your Nuxt.js project dependencies, find, install and add your modules to nuxt.config.ts files with one click and more.
3+
<div align="center">
4+
<a href="https://github.com/krvaibhaw/best-readme-template">
5+
<img src=".github/media/logo.png" alt="Logo" width="80" height="80">
6+
</a>
47

5-
<br>
8+
<h3 align="center">Nuxtr VSCode</h3>
69

7-
### Features
10+
<p align="center">
11+
An extension offering commands and tools <br /> to make your experience with Nuxt.js more pleasant!
12+
</p>
813

9-
- [Create Nuxt project directories.](#create-nuxt-project-directories)
10-
- [Create Nuxt.js files.](#create-nuxtjs-files)
11-
- Open Nuxt documentation.
12-
- [Installing dependencies.](#installing-dependencies)
13-
- [Run scripts from the VSCode command palette or sidebar.](#run-scripts-from-the-vscode-command-palette-or-sidebar)
14-
- [Toggle Nuxt Devtools from your status bar.](#toggle-nuxt-devtools-from-your-status-bar)
15-
- [Install, remove and update project dependencies.](#install-remove-and-update-project-dependencies)
16-
- [Search and install nuxt modules.](#search-and-install-nuxt-modules)
17-
- [Install and Configure most CSS frameworks with few steps. (TailwindCSS, WindiCSS, UnoCSS, and more coming soon)](#install-and-configure-most-css-frameworks-with-few-steps)
14+
<p align="center">
15+
<a href="https://marketplace.visualstudio.com/items?itemName=Nuxtr.nuxtr-vscode" target="_blank">
16+
<img src="https://img.shields.io/visual-studio-marketplace/v/Nuxtr.nuxtr-vscode.svg?color=eee&label=VS%20Code%20Marketplace&logo=visual-studio-code" alt="Visual Studio Marketplace Version" />
17+
</a>
18+
</p>
1819

20+
<p align="center">
21+
<a target="_blank" href="https://github.com/nuxtrdev/nuxtr-vscode/issues/new?assignees=&labels=bug%2Ctriage&projects=&template=issue.yaml&title=%5BBug%5D%3A+">
22+
<strong>Report Bug</strong> »
23+
</a>
24+
·
25+
<a target="_blank" href="https://github.com/nuxtrdev/nuxtr-vscode/discussions">
26+
<strong>Start a Discussion</strong> »
27+
</a>
28+
</p>
29+
</div>
1930

2031

21-
<br>
22-
<br>
32+
![Nuxt Dependencies](https://raw.githubusercontent.com/nuxtrdev/nuxtr-vscode/main/.github/media/dependencies.gif)
33+
2334

24-
### Create Nuxt project directories
35+
<br>
2536

26-
You can create all Nuxt.js project directories with few clicks either using a command or a context menu.
37+
### What does Nuxtr do?
2738

28-
![Nuxt Project Creation](./.github/media/directories_creation.gif)
2939

40+
- [Project directories and files creation](#project-directories-and-files-creation)
41+
- [Dependencies management](#dependencies-management)
42+
- [Nuxt/Custom Snippets](#nuxtcustom-snippets)
43+
- [Vue File Templates](#vue-file-templates)
44+
- [Run scripts from the VSCode command palette or sidebar.](#run-scripts-from-the-vscode-command-palette-or-sidebar)
45+
- [Toggle Nuxt Devtools from your status bar](#toggle-nuxt-devtools-from-your-status-bar)
46+
- [Search and install Nuxt integrations](#search-and-install-nuxt-integrations)
47+
- [Install & Configure CSS frameworks and Linters](#install--configure-css-frameworks-and-linters)
3048

3149
<br>
3250
<br>
3351

34-
### Create Nuxt.js files
35-
You can create all kind of files that Nuxt.js needs (Vue/TypeScript) and special files like [`.nuxtignore`](https://nuxt.com/docs/guide/directory-structure/nuxtignore) and [`app.config.ts`](https://nuxt.com/docs/guide/directory-structure/app-config) files using commands or context menus on each directory. Flat/sub directories structure are supported too.
52+
### Project directories and files creation
53+
54+
With just a few clicks or using commands and context menus, you can effortlessly create all the necessary directories and files for your Nuxt.js project, including Vue/TypeScript files, special files like [`.nuxtignore`](https://nuxt.com/docs/guide/directory-structure/nuxtignore), and [`app.config.ts`](https://nuxt.com/docs/guide/directory-structure/app-config). The flexibility extends to supporting both flat and subdirectory structures.
3655

37-
![Nuxt Files Creation](./.github/media/items_creation.gif)
3856

3957
You can customize Vue file templates using the following settings:
4058

@@ -52,71 +70,111 @@ And auto open the created file using:
5270
"nuxtr.openItemsAfterCreation": true
5371
```
5472

73+
![Nuxt Project Creation](./.github/media/file_creation.gif)
74+
5575
<br>
5676
<br>
5777

58-
### Installing dependencies
78+
### Dependencies management
5979

60-
Detecting your package manager if a lock file exists. Or letting you choose which package manager to use with this setting
80+
**Package Manager Detection**: Detecting your package manager if a lock file exists. Or letting you choose which package manager to use with this setting. You can select your default package manager from the setting:
6181

6282
```JSON
63-
"nuxtr.defaultPackageManager": "yarn"
83+
"nuxtr.defaultPackageManager": "pnpm"
6484
```
6585

86+
**Dependency Removal and Upgrade/Downgrade**: From sidebar inside project view, You can remove or upgrade/downgrade your dependencies by selecting which version you want to install.
87+
88+
**Status Bar Icon**: In your statusbar you can see your outdated dependencies and update them with few clicks.
89+
90+
<br>
91+
92+
![Nuxt Dependencies](./.github/media/dependencies.png)
93+
94+
6695
<br>
6796
<br>
6897

69-
### Run scripts from the VSCode command palette or sidebar.
70-
Main scripts are available from command palette, if you want to use a custom command you can find it in the sidebar.
7198

72-
![Nuxt Scripts](./.github/media/scripts.gif)
99+
### Nuxt/Custom Snippets
100+
101+
**Nuxt Snippets**: You can use Nuxt snippets by typing `nuxt` for components, `use` for Composables or just start typing Nuxt utils and selecting your snippet from the list.
102+
103+
**Custom Snippets**: Easily manage your custom snippets from the sidebar. You can create, edit or delete your snippets.
104+
105+
More on this side of the extension is coming soon!
106+
107+
![Snippets](./.github/media/snippets.gif)
73108

74109

75110
<br>
76111
<br>
77112

78-
### Toggle Nuxt Devtools from your status bar
79-
[Nuxt Devtools](https://devtools.nuxtjs.org/) is a great tool! One of the great features it offer is working globally with your project if you are using Nuxt <= 3.4.0. You can toggle it from your status bar. Extension detects your Nuxt.js version and advices you to update if not.
113+
### Vue File Templates
80114

81-
Manual toggling from nuxt.config.ts is detected and state is synced.
115+
To provide users with greater flexibility in customizing their Vue files, we offer the ability to create and utilize personalized templates. These templates can be set as defaults or used selectively as per the user's preference.
82116

83-
![Nuxt Devtools](./.github/media/devtools.gif)
117+
We currently support two types of templates for ensuring a consistent user experience: `.page-template` and `.layout-template`. When Nuxt.js is loaded, these files are treated as regular Vue files, simplifying the editing process. Templates creation can be done from existing respective files via context menu item or empty templates from sidebar.
118+
119+
You can set your default template from these settings:
120+
121+
```JSON
122+
"nuxtr.vueFiles.pages.defaultTemplate": "default.page-template",
123+
"nuxtr.vueFiles.layouts.defaultTemplate": "default.layout-template"
124+
```
84125

126+
![File Templates](./.github/media/file_templates.gif)
85127

86128
<br>
87129
<br>
88130

89-
### Install, remove and update project dependencies.
90131

91-
You can remove or update your dependencies by selecting which version you want to install.
132+
### Run scripts from the VSCode command palette or sidebar
92133

93-
![Nuxt Dependencies](./.github/media/dependencies.gif)
134+
Main scripts are available from command palette, if you want to use a custom command you can find it in the sidebar. Besides `nuxt dev` command, all other commands run in the background and you can see the output in the VSCode output channel.
94135

136+
![Nuxt Scripts](./.github/media/scripts.gif)
137+
138+
<br>
139+
<br>
95140

141+
### Toggle Nuxt Devtools from your status bar
142+
143+
[Nuxt Devtools](https://devtools.nuxtjs.org/) is a great tool! One of the great features it offer is working globally with your project if you are using Nuxt <= 3.4.0. You can toggle it from your status bar. Extension detects your Nuxt.js version and advices you to update if not.
144+
145+
Manual toggling from nuxt.config.ts is detected and state is synced.
146+
147+
![Nuxt Devtools](./.github/media/devtools.gif)
96148

97149
<br>
98150
<br>
99151

100-
### Search and install nuxt modules.
101152

102-
Almost full support for Nuxt modules with typical searching/filters experience as [Nuxt Modules directory](https://nuxt.com/modules). Once you found your wanted module, clicking install will install using the right flag (normal/dev) after detecting your package manager, add them to nuxt.config.ts and showing you a success message with a button to the module docs.
153+
### Search and install Nuxt integrations
103154

104-
![Nuxt Modules](./.github/media/modules.gif)
155+
Almost full support for Nuxt modules with a typical searching/filters experience as Nuxt Modules directory. Once you have found your desired module and detected your package manager, it will be installed and added to the nuxt.config file. A success message will be displayed, along with a button to access the module documentation.
105156

157+
Starting from v0.1.0, you can filter integration types (modules/layers) from the sidebar.
158+
159+
![Nuxt Modules](./.github/media/modules.gif)
106160

107161
<br>
108162
<br>
109163

110-
### Install and Configure most CSS frameworks with few steps
164+
### Install & Configure CSS frameworks and Linters
111165

112-
You can install and configure most CSS frameworks with few steps.
166+
You can install and configure most CSS frameworks with few steps:
113167

114168
- Tailwind CSS.
115169
- Uno CSS.
116170
- Windi CSS.
117171
- Vueitfy.
118172

119-
More coming soon.
173+
Same for linters:
120174

175+
- Stylelint.
176+
- Eslint.
177+
178+
More coming soon.
121179

122-
![Nuxt Modules](./.github/media/css_frameworks.gif)
180+
![Nuxt Modules](./.github/media/css_frameworks.gif)

0 commit comments

Comments
 (0)