Hi! I found the following issues with plugin-meta definitions and dependency check:</p

<a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="/us

Clarify usage of plugin-meta and dependency check about fastify-plugin HOT 5 CLOSED

fastify commented on July 30, 2024 1

Clarify usage of plugin-meta and dependency check

from fastify-plugin.

Comments (5)

mcollina commented on July 30, 2024

Can you please make an example of what you think it's happening right now vs what it should be happening according to you?

from fastify-plugin.

lependu commented on July 30, 2024

@mcollina I like how it works now, but I would improve the README:

I think it should be something like this

You can also pass some metadata that will be handled by Fastify, such as the dependencies of your plugin.

const fp = require('fastify-plugin')

function plugin (fastify, opts, next) {
  // your plugin code
  next()
}

module.exports = fp(plugin, {
  fastify: '0.x',
  // You need to define only one of the [dependency|decorator] properties.
  decorators: {
    fastify: ['plugin1', 'plugin2'],
    reply: ['compress']
  },
  dependencies: ['plugin1-name, plugin2-name']
})

And I think we should update Ecosystem plugins with name property, because

dependency only works if the name property defined int the plugin's meta.
For example:

plugin.js

const fp = require('fastify-plugin')

function plugin (fastify, opts, next) {
  // your plugin code
  next()
}

module.exports = fp(plugin, {
  fastify: '0.x',
  dependencies: ['fastify-redis']
})

server.js

const Fastify = require('fastify')                                              
const redis = require('fastify-redis')                                          
const plugin = require('./plugin')   

module.exports = (options) => {                                                    
  const instance = Fastify()                                                    
  instance
   .register(redis)
   .register(plugin)
   // more code
  return instance
}