https://github.com/fumeapp/nuxt-storm
WebStorm and PhpStorm support for NuxtJS components
https://github.com/fumeapp/nuxt-storm
Last synced: about 2 months ago
JSON representation
WebStorm and PhpStorm support for NuxtJS components
- Host: GitHub
- URL: https://github.com/fumeapp/nuxt-storm
- Owner: fumeapp
- License: mit
- Created: 2021-05-02T03:32:36.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-09-15T13:08:09.000Z (about 3 years ago)
- Last Synced: 2024-05-17T00:29:57.759Z (over 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 96.7 KB
- Stars: 66
- Watchers: 2
- Forks: 15
- Open Issues: 7
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# nuxt-storm
[![npm version][npm-version-src]][npm-version-href]
[![License][license-src]][license-href]
>[NuxtJS](https://nuxtjs.org) module for [WebStorm](https://jetbrains.com/webstorm/) and [PhpStorm](https://jetbrains.com/phpstorm/) that assists with using [@nuxt/components](https://github.com/nuxt/components)
## Quick Setup
1. Add `nuxt-storm` to your project as a development dependency
```bash
# Using yarn
yarn add --dev nuxt-storm
# Using npm
npm install --save-dev nuxt-storm
```
2. Add `.components.gen.js` to your `.gitignore` file
3. Add 'nuxt-storm' to the `buildModules` section of `nuxt.config.js`
```js
{
buildModules: [
'nuxt-storm',
]
}
```
âšī¸ If you are using `nuxt < 2.9.0`, use `modules` property instead.
That's it! Restart your `yarn dev` and components should now be found â¨
### Nested Components Support
Add `nested: true` in your buildModule inclusion
```js
{
buildModules: [
['nuxt-storm', { nested: true }],
]
}
```
If you have components in nested directories:
```bash
| components/
---| My/
------| Form/
---------| TextArea.vue
```
The component name will contain its path:
```html
```
### Path alias
Should your IDE fail to recognize vue component by its absolute path, you can replace it with path alias (default '@').
Thus, the aforementioned component path will be listed as
`@/components/My/Form/TextArea.vue`
instead of
`C:/some/absolute/path/project/components/My/Form/TextArea.vue`.
Add `alias: true` in your buildModule inclusion or set a custom alias as its value should you use one.
```js
{
buildModules: [
['nuxt-storm', { alias: true }],
]
}
```
### đ Thanks
This was made possible by with the help of [grunghi](https://github.com/grunghi) and [eggsy](https://github.com/eggsy/)
[npm-version-src]: https://img.shields.io/npm/v/nuxt-storm/latest.svg
[npm-version-href]: https://npmjs.com/package/nuxt-storm
[npm-downloads-src]: https://img.shields.io/npm/dt/nuxt-storm.svg
[npm-downloads-href]: https://npmjs.com/package/nuxt-storm
[license-src]: https://img.shields.io/npm/l/nuxt-storm.svg
[license-href]: https://npmjs.com/package/nuxt-storm