chore(maintenance): add biome to the project (aws-powertools#2791)

Author: dreamorosi

biome.json

@@ -0,0 +1,37 @@
+{
+  "$schema": "https://biomejs.dev/schemas/1.8.3/schema.json",
+  "organizeImports": {
+    "enabled": true
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": true
+    }
+  },
+  "formatter": {
+    "enabled": true,
+    "indentStyle": "space",
+    "indentWidth": 2,
+    "lineEnding": "lf",
+    "lineWidth": 80
+  },
+  "javascript": {
+    "formatter": {
+      "semicolons": "always",
+      "bracketSpacing": true,
+      "quoteStyle": "single",
+      "trailingCommas": "es5"
+    }
+  },
+  "files": {
+    "ignore": [
+      "node_modules",
+      "coverage",
+      "lib",
+      "cdk.out",
+      "site",
+      ".aws-sam"
+    ]
+  }
+}

examples/app/cdk/example-stack.ts

@@ -1,4 +1,4 @@
-import { RemovalPolicy, Stack, StackProps } from 'aws-cdk-lib';
+import { RemovalPolicy, Stack, type StackProps } from 'aws-cdk-lib';
 import { LambdaIntegration, RestApi } from 'aws-cdk-lib/aws-apigateway';
 import {
   AttributeType,
@@ -18,7 +18,7 @@ import { DynamoEventSource } from 'aws-cdk-lib/aws-lambda-event-sources';
 import { OutputFormat } from 'aws-cdk-lib/aws-lambda-nodejs';
 import { Queue } from 'aws-cdk-lib/aws-sqs';
 import { StringParameter } from 'aws-cdk-lib/aws-ssm';
-import { Construct } from 'constructs';
+import type { Construct } from 'constructs';
 import { FunctionWithLogGroup } from './function-with-logstream-construct.js';
 
 export class PowertoolsExampleStack extends Stack {

examples/app/functions/commons/helpers/get-item.ts

@@ -1,7 +1,7 @@
+import { GetCommand, type GetCommandOutput } from '@aws-sdk/lib-dynamodb';
 import { docClient } from '#clients/dynamodb';
 import { itemsTableName } from '#constants';
 import type { DebugLogger } from '#types';
-import { GetCommand, type GetCommandOutput } from '@aws-sdk/lib-dynamodb';
 
 /**
  * Fetch an item from the DynamoDB table.
@@ -22,7 +22,7 @@ const getItemDynamoDB = async (
     })
   );
 
-  logger.debug(`ddb response`, {
+  logger.debug('ddb response', {
     response,
   });
 

examples/app/functions/commons/helpers/put-item.ts

@@ -1,8 +1,8 @@
+import { randomUUID } from 'node:crypto';
+import { PutCommand } from '@aws-sdk/lib-dynamodb';
 import { docClient } from '#clients/dynamodb';
 import { itemsTableName } from '#constants';
 import type { DebugLogger } from '#types';
-import { PutCommand } from '@aws-sdk/lib-dynamodb';
-import { randomUUID } from 'node:crypto';
 
 /**
  * Put an item in the DynamoDB table.
@@ -28,7 +28,7 @@ const putItemInDynamoDB = async (
     })
   );
 
-  logger.debug(`ddb response`, {
+  logger.debug('ddb response', {
     response,
   });
 

examples/app/functions/commons/helpers/scan-items.ts

@@ -1,7 +1,7 @@
+import { ScanCommand, type ScanCommandOutput } from '@aws-sdk/lib-dynamodb';
 import { docClient } from '#clients/dynamodb';
 import { itemsTableName } from '#constants';
 import type { DebugLogger } from '#types';
-import { ScanCommand, type ScanCommandOutput } from '@aws-sdk/lib-dynamodb';
 
 /**
  * Scan the DynamoDB table and return all items.
@@ -19,7 +19,7 @@ const scanItemsDynamoDB = async (
     })
   );
 
-  logger.debug(`ddb response`, {
+  logger.debug('ddb response', {
     response,
   });
 

examples/app/package.json

@@ -11,16 +11,12 @@
   "scripts": {
     "build": "echo 'Not applicable, run `npx cdk synth` instead to build the stack'",
     "test": "npm run test:unit",
-    "lint": "eslint --ext .ts,.js --no-error-on-unmatched-pattern .",
-    "lint-fix": "eslint --fix --ext .ts,.js --fix --no-error-on-unmatched-pattern .",
+    "lint": "biome lint .",
+    "lint:fix": "biome check --write .",
     "test:unit": "export POWERTOOLS_DEV=true && jest --silent",
     "test:e2e": "echo 'To be implemented ...'",
     "cdk": "cdk"
   },
-  "lint-staged": {
-    "*.ts": "npm run lint-fix",
-    "*.js": "npm run lint-fix"
-  },
   "type": "module",
   "imports": {
     "#types": "./functions/commons/types.js",
@@ -64,4 +60,4 @@
     "ts-node": "^10.9.2",
     "typescript": "^5.4.5"
   }
-}
+}

package-lock.json

@@ -49,6 +49,7 @@
   },
   "homepage": "https://github.com/aws-powertools/powertools-lambda-typescript#readme",
   "devDependencies": {
+    "@biomejs/biome": "^1.8.3",
     "@types/aws-lambda": "^8.10.141",
     "@types/jest": "^29.5.12",
     "@types/node": "^20.14.10",
@@ -77,7 +78,7 @@
     "typescript": "^5.4.5"
   },
   "lint-staged": {
-    "*.{js,ts}": "eslint --fix",
+    "*.{js,ts}": "biome check --write",
     "*.md": "markdownlint-cli2 --fix"
   },
   "engines": {
@@ -88,4 +89,4 @@
       "tar": "6.2.1"
     }
   }
-}
+}