ci: improve linting checks

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

@@ -85,66 +85,51 @@ jobs:
       run:
         working-directory: examples/${{ matrix.example }}
     steps:
-      - name: Checkout code
+      - &checkout_code
+        name: Checkout code
         uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8  # v5.0.0
-      - name: Setup NodeJS
-        uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0
+      - &setup_node
+        name: Setup Node.js
+        uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444  # v5.0.0
         with:
           node-version: 22
           cache: "npm"
-      - name: Setup dependencies
+      - &setup_dependencies
+        name: Setup dependencies
         uses: aws-powertools/actions/.github/actions/cached-node-modules@29979bc5339bf54f76a11ac36ff67701986bb0f0
       - name: Run linting
-        run: npm run lint
+        run: npm run lint:ci
       - name: Run tests
         run: npm t
   check-layer-publisher:
     runs-on: ubuntu-latest
     env:
       NODE_ENV: dev
     steps:
-      - name: Checkout code
-        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8  # v5.0.0
-      - name: Setup NodeJS
-        uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0
-        with:
-          node-version: 22
-          cache: "npm"
-      - name: Setup dependencies
-        uses: aws-powertools/actions/.github/actions/cached-node-modules@29979bc5339bf54f76a11ac36ff67701986bb0f0
+      - *checkout_code
+      - *setup_node
+      - *setup_dependencies
       - name: Run linting
-        run: npm run lint -w layers
+        run: npm run lint:ci -w layers
       - name: Run tests
         run: npm run test:unit -w layers
   check-docs-snippets:
     runs-on: ubuntu-latest
     env:
       NODE_ENV: dev
     steps:
-      - name: Checkout code
-        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8  # v5.0.0
-      - name: Setup NodeJS
-        uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0
-        with:
-          node-version: 22
-          cache: "npm"
-      - name: Setup dependencies
-        uses: aws-powertools/actions/.github/actions/cached-node-modules@29979bc5339bf54f76a11ac36ff67701986bb0f0
+      - *checkout_code
+      - *setup_node
+      - *setup_dependencies
       - name: Run linting
-        run: npm run lint -w examples/snippets
+        run: npm run lint:ci -w examples/snippets
   check-docs:
     runs-on: ubuntu-latest
     env:
       NODE_ENV: dev
     steps:
-      - name: Checkout code
-        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8  # v5.0.0
-      - name: Setup NodeJS
-        uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0
-        with:
-          node-version: 22
-          cache: "npm"
-      - name: Setup dependencies
-        uses: aws-powertools/actions/.github/actions/cached-node-modules@29979bc5339bf54f76a11ac36ff67701986bb0f0
+      - *checkout_code
+      - *setup_node
+      - *setup_dependencies
       - name: Run linting
         run: npm run lint:markdown

biome.json

@@ -1,5 +1,6 @@
 {
-  "$schema": "https://biomejs.dev/schemas/2.0.6/schema.json",
+  "$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
+  "root": true,
   "assist": {
     "actions": {
       "source": {
@@ -22,6 +23,32 @@
         "useNumberNamespace": "error",
         "noInferrableTypes": "error",
         "noUselessElse": "error"
+      },
+      "suspicious": {
+        "noTsIgnore": "error",
+        "noConfusingVoidType": "error",
+        "noDoubleEquals": "error",
+        "noGlobalIsNan": "error",
+        "noGlobalIsFinite": "error",
+        "useNumberToFixedDigitsArgument": "error",
+        "noPrototypeBuiltins": "error",
+        "noSkippedTests": "error",
+        "noFocusedTests": "error",
+        "noUnassignedVariables": "error",
+        "noVar": "error",
+        "useAdjacentOverloadSignatures": "error",
+        "useAwait": "error",
+        "useErrorMessage": "error",
+        "useIsArray": "error",
+        "useStaticResponseMethods": "error"
+      },
+      "correctness": {
+        "useParseIntRadix": "error",
+        "useSingleJsDocAsterisk": "error",
+        "noUnusedVariables": "error",
+        "noUnusedPrivateClassMembers": "error",
+        "noUnusedImports": "error",
+        "noUnusedFunctionParameters": "error"
       }
     }
   },

docs/features/event-handler/appsync-events.md

@@ -210,7 +210,7 @@ When processing batch of items with `aggregate` enabled, you must format the pay
 
 === "Error handling with batch of items"
 
-    ```typescript hl_lines="21-24"
+    ```typescript hl_lines="25-28"
     --8<-- "examples/snippets/event-handler/appsync-events/errorHandlingWithBatchOfItems.ts"
     ```
 

docs/features/event-handler/appsync-graphql.md

@@ -176,7 +176,7 @@ You can use an AppSync JavaScript resolver or a VTL response mapping template to
 
 === "Exception Handling response"
 
-    ```json hl_lines="11 20"
+    ```json hl_lines="9 18"
     --8<-- "examples/snippets/event-handler/appsync-graphql/exceptionHandlingResponse.json"
     ```
 

docs/features/event-handler/rest.md

@@ -479,7 +479,7 @@ You can enable response compression by using the `compress` middleware. This wil
 
 === "Response"
 
-    ```json hl_lines="7-9 11 12"
+    ```json hl_lines="4-5 7-8"
     --8<-- "examples/snippets/event-handler/rest/samples/advanced_compress_res.json"
     ```
 

docs/features/tracer.md

@@ -230,7 +230,7 @@ You can trace other class methods using the `captureMethod` decorator or any arb
 
 === "Manual"
 
-    ```typescript hl_lines="7-13 19 22 26-31"
+    ```typescript hl_lines="7-10 16 21 25 27"
     --8<-- "examples/snippets/tracer/captureMethodManual.ts"
     ```
 

examples/app/functions/process-items-stream.ts

@@ -83,16 +83,19 @@ export const handler = async (
   event: DynamoDBStreamEvent,
   context: Context
 ): Promise<DynamoDBBatchResponse> => {
-  return tracer.provider.captureAsyncFunc('### handler', async (segment) => {
-    const result = await processPartialResponse(
-      event,
-      recordHandler,
-      processor,
-      { context }
-    );
+  return (await tracer.provider.captureAsyncFunc(
+    '### handler',
+    async (segment) => {
+      const result = await processPartialResponse(
+        event,
+        recordHandler,
+        processor,
+        { context }
+      );
 
-    segment?.close();
+      segment?.close();
 
-    return result;
-  }) as DynamoDBBatchResponse;
+      return result;
+    }
+  )) as DynamoDBBatchResponse;
 };

examples/app/package.json

@@ -13,6 +13,7 @@
     "test": "npm run test:unit",
     "lint": "biome lint .",
     "lint:fix": "biome check --write .",
+    "lint:ci": "biome ci .",
     "test:unit": "export POWERTOOLS_DEV=true && vitest --run --silent",
     "test:e2e": "echo 'To be implemented ...'",
     "cdk": "cdk"

examples/snippets/batch/advancedTracingRecordHandler.ts

@@ -22,7 +22,7 @@ const recordHandler = async (record: SQSRecord): Promise<void> => {
       // do something with the item
       subsegment?.addMetadata('item', item);
     } catch (error) {
-      subsegment?.addError(error);
+      subsegment?.addError(error as Error);
       throw error;
     }
   }

examples/snippets/biome.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "../../node_modules/@biomejs/biome/configuration_schema.json",
+  "extends": "//",
+  "root": false,
+  "linter": {
+    "rules": {
+      "suspicious": {
+        "useAwait": "off"
+      }
+    }
+  }
+}

examples/snippets/event-handler/appsync-events/errorHandlingWithBatchOfItems.ts

@@ -18,9 +18,13 @@ app.onPublish(
           payload: { processed: true, original_payload: payload },
         });
       } catch (error) {
+        const errorString =
+          error instanceof Error
+            ? `${error.name} - ${error.message}`
+            : 'Unknown error';
         returnValues.push({
           id: payload.id,
-          error: `${error.name} - ${error.message}`,
+          error: errorString,
         });
       }
     }

examples/snippets/event-handler/appsync-graphql/advancedTestYourCode.ts

@@ -38,7 +38,7 @@ describe('Unit test for AppSync GraphQL Resolver', () => {
     const event = onGraphqlEventFactory('listLocations', 'Query');
 
     // Act
-    const result = (await handler(event, {} as Context)) as Promise<unknown[]>;
+    const result = (await handler(event, {} as Context)) as unknown[];
 
     // Assess
     expect(result).toHaveLength(2);

examples/snippets/event-handler/appsync-graphql/exceptionHandling.ts

@@ -1,6 +1,6 @@
+import { AssertionError } from 'node:assert';
 import { AppSyncGraphQLResolver } from '@aws-lambda-powertools/event-handler/appsync-graphql';
 import { Logger } from '@aws-lambda-powertools/logger';
-import { AssertionError } from 'node:assert';
 import type { Context } from 'aws-lambda';
 
 const logger = new Logger({

examples/snippets/event-handler/appsync-graphql/exceptionHandlingResponse.json

@@ -4,9 +4,7 @@
   },
   "errors": [
     {
-      "path": [
-        "createSomething"
-      ],
+      "path": ["createSomething"],
       "data": null,
       "errorType": "AssertionError",
       "errorInfo": null,
@@ -20,4 +18,4 @@
       "message": "This is an assertion Error"
     }
   ]
-}
+}

examples/snippets/event-handler/rest/samples/advanced_binary_req.json

@@ -6,4 +6,4 @@
   "resource": "/logo",
   "path": "/logo",
   "httpMethod": "GET"
-}
+}

examples/snippets/event-handler/rest/samples/advanced_binary_res.json

@@ -1,13 +1,9 @@
 {
   "body": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyB3aWR0aD0iMjU2cHgiIGhlaWdodD0iMjU2cHgiIHZpZXdCb3g9IjAgMCAyNTYgMjU2IiB2ZXJzaW9uPSIxLjEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHByZXNlcnZlQXNwZWN0UmF0aW89InhNaWRZTWlkIj4KICAgIDx0aXRsZT5BV1MgTGFtYmRhPC90aXRsZT4KICAgIDxkZWZzPgogICAgICAgIDxsaW5lYXJHcmFkaWVudCB4MT0iMCUiIHkxPSIxMDAlIiB4Mj0iMTAwJSIgeTI9IjAlIiBpZD0ibGluZWFyR3JhZGllbnQtMSI+CiAgICAgICAgICAgIDxzdG9wIHN0b3AtY29sb3I9IiNDODUxMUIiIG9mZnNldD0iMCUiPjwvc3RvcD4KICAgICAgICAgICAgPHN0b3Agc3RvcC1jb2xvcj0iI0ZGOTkwMCIgb2Zmc2V0PSIxMDAlIj48L3N0b3A+CiAgICAgICAgPC9saW5lYXJHcmFkaWVudD4KICAgIDwvZGVmcz4KICAgIDxnPgogICAgICAgIDxyZWN0IGZpbGw9InVybCgjbGluZWFyR3JhZGllbnQtMSkiIHg9IjAiIHk9IjAiIHdpZHRoPSIyNTYiIGhlaWdodD0iMjU2Ij48L3JlY3Q+CiAgICAgICAgPHBhdGggZD0iTTg5LjYyNDExMjYsMjExLjIgTDQ5Ljg5MDMyNzcsMjExLjIgTDkzLjgzNTQ4MzIsMTE5LjM0NzIgTDExMy43NDcyOCwxNjAuMzM5MiBMODkuNjI0MTEyNiwyMTEuMiBaIE05Ni43MDI5MzU3LDExMC41Njk2IEM5Ni4xNjQwODU4LDEwOS40NjU2IDk1LjA0MTQ4MTMsMTA4Ljc2NDggOTMuODE2MjM4NCwxMDguNzY0OCBMOTMuODA2NjE2MywxMDguNzY0OCBDOTIuNTcxNzUxNCwxMDguNzY4IDkxLjQ0OTE0NjYsMTA5LjQ3NTIgOTAuOTE5OTE4NywxMTAuNTg1NiBMNDEuOTEzNDIwOCwyMTMuMDIwOCBDNDEuNDM4NzE5NywyMTQuMDEyOCA0MS41MDYwNzU4LDIxNS4xNzc2IDQyLjA5NjI0NTEsMjE2LjEwODggQzQyLjY3OTk5OTQsMjE3LjAzNjggNDMuNzA2MzgwNSwyMTcuNiA0NC44MDY1MzMxLDIxNy42IEw5MS42NTQ0MjMsMjE3LjYgQzkyLjg5NTcwMjcsMjE3LjYgOTQuMDIxNTE0OSwyMTYuODg2NCA5NC41NTM5NTAxLDIxNS43Njk2IEwxMjAuMjAzODU5LDE2MS42ODk2IEMxMjAuNjE3NjE5LDE2MC44MTI4IDEyMC42MTQ0MTIsMTU5Ljc5ODQgMTIwLjE4NzgyMiwxNTguOTI4IEw5Ni43MDI5MzU3LDExMC41Njk2IFogTTIwNy45ODUxMTcsMjExLjIgTDE2OC41MDc5MjgsMjExLjIgTDEwNS4xNzM3ODksNzguNjI0IEMxMDQuNjQ0NTYxLDc3LjUxMDQgMTAzLjUxNTU0MSw3Ni44IDEwMi4yNzc0NjksNzYuOCBMNzYuNDQ3OTQzLDc2LjggTDc2LjQ3NjgwOTksNDQuOCBMMTI3LjEwMzA2Niw0NC44IEwxOTAuMTQ1MzI4LDE3Ny4zNzI4IEMxOTAuNjc0NTU2LDE3OC40ODY0IDE5MS44MDM1NzUsMTc5LjIgMTkzLjA0MTY0NywxNzkuMiBMMjA3Ljk4NTExNywxNzkuMiBMMjA3Ljk4NTExNywyMTEuMiBaIE0yMTEuMTkyNTU4LDE3Mi44IEwxOTUuMDcxOTU4LDE3Mi44IEwxMzIuMDI5Njk2LDQwLjIyNzIgQzEzMS41MDA0NjgsMzkuMTEzNiAxMzAuMzcxNDQ5LDM4LjQgMTI5LjEzMDE2OSwzOC40IEw3My4yNzI1NzYsMzguNCBDNzEuNTA1Mjc1OCwzOC40IDcwLjA2ODM0MjEsMzkuODMwNCA3MC4wNjUxMzQ0LDQxLjU5NjggTDcwLjAyOTg1MjgsNzkuOTk2OCBDNzAuMDI5ODUyOCw4MC44NDggNzAuMzYzNDI2Niw4MS42NjA4IDcwLjk2OTYzMyw4Mi4yNjI0IEM3MS41Njk0MjQ2LDgyLjg2NCA3Mi4zODQxMTQ2LDgzLjIgNzMuMjM3Mjk0MSw4My4yIEwxMDAuMjUzNTczLDgzLjIgTDE2My41OTA5MiwyMTUuNzc2IEMxNjQuMTIzMzU1LDIxNi44ODk2IDE2NS4yNDU5NiwyMTcuNiAxNjYuNDg0MDMyLDIxNy42IEwyMTEuMTkyNTU4LDIxNy42IEMyMTIuOTY2Mjc0LDIxNy42IDIxNC40LDIxNi4xNjY0IDIxNC40LDIxNC40IEwyMTQuNCwxNzYgQzIxNC40LDE3NC4yMzM2IDIxMi45NjYyNzQsMTcyLjggMjExLjE5MjU1OCwxNzIuOCBMMjExLjE5MjU1OCwxNzIuOCBaIiBmaWxsPSIjRkZGRkZGIj48L3BhdGg+CiAgICA8L2c+Cjwvc3ZnPg==",
   "multiValueHeaders": {
-    "Content-Type": [
-      "image/png"
-    ],
-    "Content-Encoding": [
-      "gzip"
-    ]
+    "Content-Type": ["image/png"],
+    "Content-Encoding": ["gzip"]
   },
   "isBase64Encoded": true,
   "statusCode": 200
-}
+}

examples/snippets/event-handler/rest/samples/advanced_compress_req.json

@@ -5,4 +5,4 @@
   "resource": "/todos/1",
   "path": "/todos/1",
   "httpMethod": "GET"
-}
+}

examples/snippets/event-handler/rest/samples/advanced_compress_res.json

@@ -1,13 +1,9 @@
 {
   "statusCode": 200,
   "multiValueHeaders": {
-    "Content-Type": [
-      "application/json"
-    ],
-    "Content-Encoding": [
-      "gzip"
-    ]
+    "Content-Type": ["application/json"],
+    "Content-Encoding": ["gzip"]
   },
   "body": "H4sIAAAAAAACE42STU4DMQyFrxJl3QXln96AMyAW7sSDLCVxiJ0Kqerd8TCCUOgii1EmP/783pOPXjmw+N3L0TfB+hz8brvxtC5KGtHvfMCIkzZx0HT5MPmNnziViIr2dIYoeNr8Q1x3xHsjcVadIbkZJoq2RXU8zzQROLseQ9505NzeCNQdMJNBE+UmY4zbzjAJhWtlZ57sB84BWtul+rteH2HPlVgWARwjqXkxpklK5gmEHAQqJBMtFsGVygcKmNVRjG0wxvuzGF2L0dpVUOKMC3bfJNjJgWMrCuZk7cUp02AiD72D6WKHHwUDKbiJs6AZ0VZXKOUx4uNvzdxT+E4mLcMA+6G8nzrLQkaxkNEVrFKW2VGbJCoCY7q2V3+tiv5kGThyxfTecDWbgGz/NfYXhL6ePgF9PnFdPgMAAA==",
   "isBase64Encoded": true
-}
+}

examples/snippets/event-handler/rest/samples/advanced_cors_per_route.json

@@ -6,4 +6,4 @@
   },
   "body": "{\"status\":\"ok\"}",
   "isBase64Encoded": false
-}
+}

examples/snippets/event-handler/rest/samples/advanced_cors_simple.json

@@ -24,4 +24,4 @@
   },
   "body": "{\"todoId\":\"123\",\"task\":\"Example task\",\"completed\":false}",
   "isBase64Encoded": false
-}
+}

examples/snippets/event-handler/rest/samples/advanced_error_debug.json

@@ -6,4 +6,4 @@
   "details": {
     "errorName": "Name of the error class"
   }
-}
+}

examples/snippets/event-handler/rest/samples/advanced_error_prod.json

@@ -2,4 +2,4 @@
   "statusCode": 500,
   "error": "Internal Server Error",
   "message": "Internal Server Error"
-}
+}

examples/snippets/event-handler/rest/samples/advanced_fine_grained_responses.json

@@ -6,4 +6,4 @@
     "Location": "/todos/123"
   },
   "isBase64Encoded": false
-}
+}

examples/snippets/event-handler/rest/samples/advanced_mw_early_return.json

@@ -5,4 +5,4 @@
     "Content-Type": "application/json"
   },
   "isBase64Encoded": false
-}
+}

examples/snippets/event-handler/rest/samples/advanced_mw_middleware_order.json

@@ -7,4 +7,4 @@
     "x-post-processed-by": "global-middleware"
   },
   "isBase64Encoded": false
-}
+}

examples/snippets/event-handler/rest/samples/gettingStarted_dynamic_routes.json

@@ -2,4 +2,4 @@
   "resource": "/todos/{id}",
   "path": "/todos/1",
   "httpMethod": "GET"
-}
+}

examples/snippets/event-handler/rest/samples/gettingStarted_methods.json

@@ -3,4 +3,4 @@
   "path": "/todos",
   "httpMethod": "POST",
   "body": "{\"title\": \"foo\", \"userId\": 1, \"completed\": false}"
-}
+}

examples/snippets/event-handler/rest/samples/gettingStarted_serialization.json

@@ -5,4 +5,4 @@
   },
   "body": "{'message':'pong'}",
   "isBase64Encoded": false
-}
+}