chore(docs): add docs/snippets
to npm workspace
#1251
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of your changes
As part of the efforts described in #729 we are extracting the code snippets present in the docs in their own files, so that we can apply linting as part of our CI.
In order to do that, these code snippets need to:
@middy/core
,@aws-sdk/client-dynamodb
, etc.)@aws-lambda-powertools/*
packages, which might be still not available on npm.eslintrc.js
file as the rest of the monorepo (for best practices)To comply with these three points, we have decided to add the
docs/snippets
folder to the npm workspace that contains the rest of the utilities (and soon thelayer-publisher
folder too).This PR does the following:
docs/snippets
and makes it part of the wider npm workspacedevDependencies
used by the code snippets (more might be added once linting is applied)docs/snippets/node_modules
directory from the docsCloses #1250.
How to verify this change
N/A
Related issues, RFCs
Issue number: #1250
PR status
Is this ready for review?: YES
Is it a breaking change?: NO
Checklist
Breaking change checklist
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.