serverless-appsync-plugin icon indicating copy to clipboard operation
serverless-appsync-plugin copied to clipboard

Serverless Framework v3: new design & how to integrate

Open mnapoli opened this issue 2 years ago • 4 comments

Hi 👋 , Serverless Framework core team here!

We're working on the v3 beta version right now. The v3 will include a redesigned CLI output:

image

You can try the v3 beta with: npm i serverless@pre-3

To help plugins integrate with that new design (and build a great user experience), we've added new APIs for plugins:

We've identified 2 options for plugins:

  • either support both v2 and v3 in the current version: if the 3rd argument is passed to the plugin's constructor, you can switch logging to the new design and use the new CLI output APIs
  • or create a new version of the plugin that only supports v3

Any feedback is appreciated! If you want to update the plugin to use these new APIs, feel free to ping me if you have any questions!

If you don't have time to update the plugin, let me know, we'll see how we can help.

mnapoli avatar Nov 05 '21 14:11 mnapoli

Hi!

Thank you for chiming in. I will have a look at this asap. I was actually about to work on a v2 of this plugin (see RFC). I will evaluate the two possibilities and see what fits best for this plugin and our users.

I won't hesitate to contact you in case of questions.

bboure avatar Nov 05 '21 14:11 bboure

👍 awesome!

mnapoli avatar Nov 05 '21 14:11 mnapoli

@bboure what is the status on the re-write of this wonderful plugin? Cannot upgrade to serverless v3 because I am very much tied to this plugin...

epanfile avatar Sep 17 '22 07:09 epanfile

@epanfile version 1 of this plugin should be compatible with v3 of serverless framework. It might not be a smooth experience due to the changes in the command output api, but it should work. Actually, I have done it and it worked.

You may want to have a look at the v2 of this plugin. It is still in alpha (see the alpha branch). Unfortunately, I have not had much time to test it enough to the point of being confident that it's stable for an official release. Feel free to give it a try and report any issue. That would actually help moving this forward for a possible official release.

npm i serverless-appsync-plugin@alpha

bboure avatar Sep 17 '22 19:09 bboure