Skip to content

WebStorm and PhpStorm support for NuxtJS components

License

Notifications You must be signed in to change notification settings

ndragun92/nuxt-storm

 
 

Repository files navigation

nuxt-storm

npm version License

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
  1. Add .components.gen.js to your .gitignore file

  2. 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 />

🙏 Thanks

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

About

WebStorm and PhpStorm support for NuxtJS components

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 76.1%
  • JavaScript 23.9%