ci: improve linting checks (#4545)

Co-authored-by: Copilot <[email protected]>
Co-authored-by: Swopnil Dangol <[email protected]>

Author: 3 people

.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"
+      }
+    }
+  }
+}