traefik / plugindemo

This repository includes an example plugin, for you to use as a reference for developing your own plugins
https://plugins.traefik.io/plugins/628c9ee2108ecc83915d7764/demo-plugin
Apache License 2.0
140 stars 45 forks source link

Add all fields for example manifest file #23

Open FlowingSPDG opened 1 month ago

FlowingSPDG commented 1 month ago

Hello, thanks for awesome plugin template! I am developing some small plugin for rewriting [GET]URL query to [POST]JSON body. (This is helpful for emulating AWS API Gateway w/o localstack)

I was trying to build my plugin but I was struggling with import error. https://github.com/FlowingSPDG/traefik-plugin-query-to-json/issues/6

And I digged into piceus's source code, and found out there's a basePkg field which is not listed unlike import field. https://github.com/traefik/piceus/blob/909a0aa078ceb53ca4af6dd4b299c4efc0b0335e/pkg/core/types.go#L16-L28

(Also import field automatically replaces hypen(-) to underscore(_) so I think that's why I was struggling) https://github.com/traefik/piceus/blob/909a0aa078ceb53ca4af6dd4b299c4efc0b0335e/pkg/core/yaegi.go#L153-L158

So can we add document for import/basePkg field, and note that import field value will be replaced on Yeagi check process?

Thank you.

nmengin commented 4 weeks ago

Hey @FlowingSPDG,

Thanks for your suggestion, we think it makes a lot of sense.

Unfortunately, this would not make it to our roadmap for a while as we are focused elsewhere.

If you or another community member would like to build it, let us know, and we will work with you to make sure you have all the information needed so that it can be merged.

FlowingSPDG commented 4 weeks ago

Hi again @nmengin !

It is totally okay, and thank you for reviewing my suggestion :)

I'll be waiting for you if you need any help, I love traefik ❤

nmengin commented 4 weeks ago

So can we add document for import/basePkg field, and note that import field value will be replaced on Yeagi check process?

We agree with your suggestion to improve the documentation. So so not hesitate to ping me on any PR you could open on this topic.

I'll be waiting for you if you need any help, I love traefik ❤

Thank you 😄