Nuxt•2mo ago

How to add my module to the nuxt module list

I created my module and opened the request at https://github.com/nuxt/modules/issues/1088, but it wasn't very clear to me how to do it, what would be the step-by-step process to be followed?

GitHub

Issues · nuxt/modules

Discover the Nuxt modules to add any CMS, Database, UI, Auth and integrations into your Vue application. - Issues · nuxt/modules

4 Replies

kapa.ai•2mo ago

Hi @FoxForGate. I'm kapa.ai, your friendly support bot. I will try to answer your question by searching through the knowledge base. :wave:

FoxForGateOP•2mo ago

https://www.npmjs.com/package/nuxt-http-preset

npm

nuxt-http-preset

A Nuxt module to manage and simplify HTTP requests across multiple APIs and endpoints.. Latest version: 1.0.0, last published: 3 days ago. Start using nuxt-http-preset in your project by running npm i nuxt-http-preset. There are no other projects in the npm registry using nuxt-http-preset.

kapa.ai•2mo ago

---------------------- I apologize, but I don't have specific information about the step-by-step process for adding your module to the official Nuxt module list. The knowledge sources provided don't contain details about submitting modules to the Nuxt modules repository or the exact procedure following an issue creation. However, I can provide some general information about Nuxt modules that might be helpful: 1. Nuxt encourages developers to create and share modules. As mentioned in the Nuxt contribution guide (https://nuxt.com/docs/community/contribution#create-a-module), "If you've built something with Nuxt that's cool, why not extract it into a module, so it can be shared with others?" 2. When creating a module, you can use the defineNuxtModule function from @nuxt/kit to define your module structure. Here's a basic example:

import { defineNuxtModule } from '@nuxt/kit'

export default defineNuxtModule({
  meta: {
    name: 'my-module',
    configKey: 'myModule'
  },
  defaults: {
    test: 123
  },
  setup (options, nuxt) {
    nuxt.hook('modules:done', () => {
      console.log('My module is ready with current test option: ', options.test)
    })    
  }
})

import { defineNuxtModule } from '@nuxt/kit'

export default defineNuxtModule({
  meta: {
    name: 'my-module',
    configKey: 'myModule'
  },
  defaults: {
    test: 123
  },
  setup (options, nuxt) {
    nuxt.hook('modules:done', () => {
      console.log('My module is ready with current test option: ', options.test)
    })    
  }
})

Source (https://nuxt.com/docs/api/kit/modules#examples) 3. For the official process of adding your module to the Nuxt module list, it seems you've already taken the correct first step by opening an issue in the nuxt/modules repository. 4. If you need further assistance with the process, the Nuxt documentation suggests: "If you need help while building it, feel free to check in with us (https://nuxt.com/docs/community/getting-help)." This might be a good next step to get more specific guidance on your submission. For more detailed information or next steps, I recommend following up on your GitHub issue or reaching out to the Nuxt community through their official channels. ---------------------- Note: you can ask me a follow up question by @ mentioning me again :speech_balloon: ----------------------

kapa.ai•2mo ago

<@404016877623443456> Kapa.ai is still learning and improving, please let me know how I did by reacting below.

Gaming

Programming

How to add my module to the nuxt module list