Skip to content

Commit cc8d108

Browse files
committed
fix(docs): remove overrides, introduce changes to code-snippets
1 parent 07c548d commit cc8d108

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+11510
-14781
lines changed

.eslintrc.js

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -64,16 +64,5 @@ module.exports = {
6464
'prefer-arrow-callback': 'error',
6565
quotes: [ 'error', 'single', { allowTemplateLiterals: true } ],
6666
semi: [ 'error', 'always' ]
67-
},
68-
overrides:[
69-
{
70-
files:['docs/snippets/**/*.ts'],
71-
rules:{
72-
'@typescript-eslint/no-explicit-any': 'warn',
73-
'@typescript-eslint/no-unused-vars': 'warn',
74-
'@typescript-eslint/explicit-member-accessibility': 'warn',
75-
'@typescript-eslint/no-var-requires': 'warn'
76-
}
77-
}
78-
]
67+
}
7968
};

.github/workflows/reusable-run-linting-check-and-unit-tests.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,9 @@ jobs:
4242
if: steps.cache-node-modules.outputs.cache-hit == 'true'
4343
run: |
4444
npm run build -w packages/commons
45-
npm run build -w packages/logger & npm run build -w packages/tracer & npm run build -w packages/metrics & npm run build -w packages/parameters & npm run build -w packages/idempotency
45+
npm run build -w packages/logger & npm run build -w packages/tracer & npm run build -w packages/metrics & npm run build -w packages/parameters & npm run build -w packages/idempotency & npm run build -w docs/snippets
4646
- name: Run linting
47-
run: npm run lint -w packages/commons -w packages/logger -w packages/tracer -w packages/metrics -w packages/parameters -w packages/idempotency
47+
run: npm run lint -w packages/commons -w packages/logger -w packages/tracer -w packages/metrics -w packages/parameters -w packages/idempotency -w docs/snippets
4848
- name: Run unit tests
4949
run: npm t -w packages/commons -w packages/logger -w packages/tracer -w packages/metrics -w packages/parameters -w packages/idempotency
5050
check-examples:

docs/snippets/logger/appendKeys.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ const logger = new Logger({
2424
// extra_key: "some-value"
2525
// });
2626

27-
export const handler = async (_event: any, _context: any): Promise<unknown> => {
27+
export const handler = async (_event: unknown, _context: unknown): Promise<unknown> => {
2828

2929
// If you don't want to log the "extra_key" attribute in your logs, you can remove it
3030
logger.removeKeys(['extra_key']);

docs/snippets/logger/basicUsage.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@ import { Logger } from '@aws-lambda-powertools/logger';
33
const logger = new Logger({ serviceName: 'serverlessAirline' });
44

55
export const handler = async (_event, _context): Promise<void> => {
6-
// ...
6+
logger.info('Hello World');
77
};

docs/snippets/logger/clearStateDecorator.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ const logger = new Logger({
1414
class Lambda implements LambdaInterface {
1515
// Enable the clear state flag
1616
@logger.injectLambdaContext({ clearState: true })
17-
public async handler(_event: any, _context: any): Promise<void> {
17+
public async handler(event: unknown, _context: unknown): Promise<void> {
1818
// Persistent attributes added inside the handler will NOT be cached
1919
// across invocations
2020
if (event['special_key'] === '123456'){

docs/snippets/logger/clearStateMiddy.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ const logger = new Logger({
1111
}
1212
});
1313

14-
const lambdaHandler = async (event: { special_key: string }, _context: any): Promise<void> => {
14+
const lambdaHandler = async (event: { special_key: string }, _context: unknown): Promise<void> => {
1515
// Persistent attributes added inside the handler will NOT be cached
1616
// across invocations
1717
if (event['special_key'] === '123456') {

docs/snippets/logger/createChild.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ const childLogger = logger.createChild({
1010
logLevel: 'ERROR'
1111
});
1212

13-
export const handler = async (_event: any, _context: any): Promise<void> => {
13+
export const handler = async (_event: unknown, _context: unknown): Promise<void> => {
1414

1515
logger.info('This is an INFO log, from the parent logger');
1616
logger.error('This is an ERROR log, from the parent logger');

docs/snippets/logger/decorator.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ const logger = new Logger();
66
class Lambda implements LambdaInterface {
77
// Decorate your handler class method
88
@logger.injectLambdaContext()
9-
public async handler(_event: any, _context: any): Promise<void> {
9+
public async handler(_event: unknown, _context: unknown): Promise<void> {
1010
logger.info('This is an INFO log with some context');
1111
}
1212

docs/snippets/logger/eventDecorator.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ const logger = new Logger();
66
class Lambda implements LambdaInterface {
77
// Set the log event flag to true
88
@logger.injectLambdaContext({ logEvent: true })
9-
public async handler(_event: any, _context: any): Promise<void> {
9+
public async handler(_event: unknown, _context: unknown): Promise<void> {
1010
logger.info('This is an INFO log with some context');
1111
}
1212

docs/snippets/logger/eventMiddy.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import middy from '@middy/core';
33

44
const logger = new Logger();
55

6-
const lambdaHandler = async (_event: any, _context: any): Promise<void> => {
6+
const lambdaHandler = async (_event: unknown, _context: unknown): Promise<void> => {
77
logger.info('This is an INFO log with some context');
88
};
99

0 commit comments

Comments
 (0)