Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add all fields for example manifest file #23

Open
FlowingSPDG opened this issue Sep 11, 2024 · 3 comments
Open

Add all fields for example manifest file #23

FlowingSPDG opened this issue Sep 11, 2024 · 3 comments
Labels
area/documentation Improvements or additions to documentation contributor-wanted kind/enhancement a new or improved feature.

Comments

@FlowingSPDG
Copy link

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.
FlowingSPDG/traefik-plugin-query-to-json#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 nmengin added kind/enhancement a new or improved feature. area/documentation Improvements or additions to documentation contributor-wanted labels Oct 10, 2024
@nmengin
Copy link

nmengin commented Oct 10, 2024

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
Copy link
Author

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
Copy link

nmengin commented Oct 10, 2024

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 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation contributor-wanted kind/enhancement a new or improved feature.
Projects
None yet
Development

No branches or pull requests

2 participants