fumeapp/nuxt-storm

WebStorm and PhpStorm support for NuxtJS components

nuxt-storm

NuxtJS module for WebStorm and PhpStorm that assists with using @nuxt/components

Quick Setup

1. Add nuxt-storm to your project as a development dependency

# 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

{
  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

{
  buildModules: [
    ['nuxt-storm', { nested: true }],
  ]
}

If you have components in nested directories:

| components/
---| My/
------| Form/
---------| TextArea.vue

The component name will contain its path:

<MyFormTextArea />

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.

{
  buildModules: [
    ['nuxt-storm', { alias: true }],
  ]
}

🙏 Thanks

This was made possible by with the help of grunghi and eggsy

nuxt-storm's Issues

No component props hints

Webstorm [latest] doesn't show props and events hints for any auto imported component, although everything works as expected. Has anyone faces similiar issue? With pressed control there is hint saying variant is a Custom Vue component property, if import component manually it will show "HTML prop 'variant'"

I know it isn't a nuxt-storm propblem, but hope someone found way to fix it

Doesn't work with nuxt3

It doesn't generate .component.gen.js file on nuxt 3 rc4

Allow option to define the output dir of the .components.gen.js

Thanks for the module.

Could you make the output directory configurable?
I have a custom build directory set in nuxt.config.js:

buildDir: '.nuxt/mydir'

Because the patch is relative hardcoded, the .components.gen.js is inside the .nuxt folder and therefore useless.

Vite compatibility

CMD click

CMD click or alt click for windows redirects me to the .component.gen.js file instead of the original file.
Can I force it to directly open the original file??

Support for lazy load component

Hello, thank you for creating this package.
I wanted to say that this package has a problem that does not detect lazy load component, please fix this problem as well.

.components.gen.js

Bug - nested component index problem

There is a problem (in the case of components) that you have to write the Dialog in the file and not DialogIndex because when we want to load the Index Dialog we should not write DialogIndex because it creates an error.

This method is wrong.

The following method is correct.

not supporting <nuxt-content > tag

Please add support for tag.as nuxt content is now widely used in many projects.