refactor(docs): apply eslint rules to code snippets

[niko-achilles]

Description of your changes

1. introduces : root: true in eslint configuration file in root of repository which manages the workspace.
2. applies existing eslint rules defined in eslint configuration file in root of repository
3. fixes code snippets in docs/snippets lintinting issues which are related to styling: semi, quotes, indent
4. introduces overrides section in eslint configuration file in root of repository, so that we can discuss explicit about typescript linting issues for code snippets: no-explicit-any, no-unused-vars, explicit-member-accessibility, no-var-requires ,
5. overrides section in eslint configuration file in root of repository, has no impact or side effects to the overall code base of this repository.
6. missing dependency of @aws-sdk/client-s3 defined as dev. dependency in package.json of docs/snippets

TODOs:
options / trade-offs, typescript linting issues for code snippets:

• no-explicit-any, no-unused-vars, explicit-member-accessibility, no-var-requires

How to verify this change

1. Verify that root eslint configuration file is used by running: npm run -w docs/snippets lint -- --debug
   should yield

...
 eslintrc:config-array-factory Loading JS config file: /aws-lambda-powertools-typescript/.eslintrc.js +1ms
...
eslintrc:cascading-config-array-factory Stop traversing because of 'root:true'. +806ms

2. Run: npm run -w docs/snippets lint

Related issues, RFCs

Issue number: #1252 #729

PR status

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

Checklist

• My changes meet the tenets criteria
• I have performed a self-review of my own code
• I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
• I have made corresponding changes to the documentation
• I have made corresponding changes to the examples
• My changes generate no new warnings
• The code coverage hasn't decreased
• I have added tests that prove my change is effective and works
• New and existing unit tests pass locally and in Github Actions
• Any dependent changes have been merged and published
• The PR title follows the conventional commit semantics

Breaking change checklist

• I have documented the migration process
• I have added, implemented necessary warnings (if it can live side by side)

---

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

[niko-achilles]

Please review so that we can discuss about the TODOs as described in this PR comment:
options / trade-offs, typescript linting issues for code snippets.

• no-explicit-any, no-unused-vars, explicit-member-accessibility, no-var-requires

// cc. @dreamorosi

[dreamorosi]

I've added a number of comments.

I think we are going in the right direction, maybe one/two more iterations and we'll get there.

Aside from the comments I have left, please also change the .github/workflows/reusable-run-linting-check-and-unit-tests.yml file to add -w docs/snippets:

• to this line
• and this line

Thanks!

[niko-achilles]

@dreamorosi proposals applied with additional new commit.
Please review and we can discuss to apply further changes if needed.

Note: docs/snippets/tracer/captureAWSAll.ts needs special treatment .

[saragerion]

LGTM! Thanks for opening this PR

[niko-achilles]

LGTM! Thanks for opening this PR

@saragerion i think the docs/snippets/tracer/captureAWSAll.ts needs special treatment and guide from you or other reviewers as maintainers of this repository.

What do you think ?

@dreamorosi having background information from the beginning of this journey with extracting and linting code snippets
may give guidance also.

[dreamorosi]

Hi Niko, I'm now back at work and I was able to look at the captureAWSAll code snippet.

I have proposed an alternative that works and shouldn't require any special override to the linting rules.

Whenever you can please apply this suggestion and resolve the merge conflicts. Looking forward to merge this and move on.

[dreamorosi]

Thank you for the work on this, I appreciate the effort you've put in it.