Integrating Components

[eahefnawy]

What did you implement:

Integrates Serverless Components with the Serverless Framework.

How did you implement it:

Integrated with Serverless Components by simply depending on the components cli as a dependency and using its methods (I've kept all the required logic over there to keep things separate). Since components require at least Node 8, we are only integrating components for Node 8+ users.

One conflicting issue I've found is: what happens when there's an empty directory? I know @medikoo is working on an interactive serverless command, but the components project also ships with such a functionality. I think what we'll need to do is add support for components templates in @medikoo implementation, although I wish we could separate concerns. For now, the components check just moves on if it's an empty directory so that @medikoo updates kick in.

How can we verify it:

1. run serverless create -t aws-nodejs - this should create a framework project
2. run serverless deploy to deploy the newly created project
3. delete all files from cwd
4. in the same cwd, create a components serverless.yml file. For a minimal example

myBucket:
  component: "@serverless/aws-s3"

5. run serverless again in the same cwd. This should run components instead of the framework as it detected that it's a components project

Todos:

Note: Run npm run test-ci to run all validation checks on proposed changes

• Write tests and confirm existing functionality is not broken.
  Validate via npm test
• Write documentation
• Ensure there are no lint errors.
  Validate via npm run lint-updated
  Note: Some reported issues can be automatically fixed by running npm run lint:fix
• Ensure introduced changes match Prettier formatting.
  Validate via npm run prettier-check-updated
  Note: All reported issues can be automatically fixed by running npm run prettify-updated
• Make sure code coverage hasn't dropped
• Provide verification config / commands / resources
• Enable "Allow edits from maintainers" for this PR
• Update the messages below

Is this ready for review?: YES
Is it a breaking change?: NO

[pmuens]

I just tested it and it works fine.

I got an error when running the bucket example (NoSuchBucket) but I guess that this is intentional.

Then only thing that confused me was that the componentsCli has the logic which determines whether the serverless.yml is a Framework file or a Components file. As far as I understood it, the cli project is Components related (at least that what the project description on GitHub says).

I'd propose to add the check for whether it's a Framework or Componets project in the bin/serverless.js file and then call the relevant Components CLI commands if a components project is detected.

Another way would be to remove the emphasis on Components from the CLI project and build it in a consumer-agnostic way. In that case we should rename the variables in the bin/serverless.js file as suggested below.

[pmuens]

Just tested it again and it works fine 👍 (couldn't reproduce the Bucket error).

Thanks for updating the code 👍

LGTM