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

Serverless Framework v3: integrating with the new design #279

Open
mnapoli opened this issue Nov 23, 2021 · 5 comments
Open

Serverless Framework v3: integrating with the new design #279

mnapoli opened this issue Nov 23, 2021 · 5 comments

Comments

@mnapoli
Copy link

mnapoli commented Nov 23, 2021

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

image

Everyone 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: Documentation of the new API.

If anyone wants to help, you can:

  • test the plugin with the v3 beta
  • send pull requests to improve the CLI output to match the new design, for example using the new APIs
@medikoo
Copy link
Contributor

medikoo commented Nov 23, 2021

@mnapoli it's a package we maintain (note the organization :)

@medikoo
Copy link
Contributor

medikoo commented Nov 23, 2021

Still, we welcome any help on it from outside. So if there's anyone that can help us, integrating with a new design that's highly appreciated!

@mnapoli
Copy link
Author

mnapoli commented Nov 23, 2021

🤦 I just opened this issue after opening one on the Azure plugin, I didn't even notice the org ^^

Well, at least the info is out there for those that may want to contribute :D

@colemanja91
Copy link

colemanja91 commented Jan 8, 2022

@medikoo @mnapoli Started a PR to address this - NodeJS is not my strong suite so I'm happy to receive critical feedback. Are there any recommended testing practices to ensure compatibility with v3?

@medikoo
Copy link
Contributor

medikoo commented Jan 10, 2022

@colemanja91 there are not many internal differences between v2 and v3, so v3 doesn't change much in that area.

In general, we recommend using runServerless util to set up tests that involve Framework (we use it in Framework internal tests and plugins)

I saw that you've prepared a PR with new logs. In Framework, we do not pursue any tests that confirm whether the given log is written. We only confirm on result state of the operation, and eventually the substantial command output (one written with writeText).

So when logs refactor is concerned, most that needs to be ensured is that currently setup tests pass, I wouldn't expect new tests to confirm on new logs configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants