Maintenance: apply linting to docs/snippets code snippets

[dreamorosi]

Summary

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.

Once all the code has been extracted, and #1251 has been merged, we should apply the same linting that the rest of the project has to these files.

Why is this needed?

So that we can automate checking the correctness of the code snippets that are part of the docs, leading to a better DX.

Which area does this relate to?

Automation

Solution

The steps needed to close the issue would be:

• add two new npm scripts to the docs/snippets/package.json file:
  • "lint": "eslint --ext .ts --no-error-on-unmatched-pattern logger tracer metrics parameters", - example
  • "lint-fix": "eslint --fix --ext .ts --no-error-on-unmatched-pattern logger tracer metrics parameters", - example
• verify that the linting rules applied are the one in the main eslintrc.js file at the root of the project
• run npm run lint -w docs/snippets and fix all the linting issues that show up

Notes

• in many cases the signature of the handler function contains the any type. I would recommend to type them as unknown for the time being
• as far as I can tell, there's no missing dependency. If there's any, install them like this npm i -D dependency-name -w docs/snippets

Acknowledgment

• This request meets Lambda Powertools Tenets
• Should this be considered in other Lambda Powertools languages? i.e. Python, Java

[niko-achilles]

@dreamorosi i can take this as task for Friday.
I read your notes , point handler function about any type . I will test with the existing eslint rules as given and see what i get in the console , OK ?

[dreamorosi]

Sure, that works. I expect the current linting to give errors about any specifically - but happy to discuss this while working on it.

[github-actions]

⚠️ COMMENT VISIBILITY WARNING ⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.