chore: setup prettier formatting via lint-staged, enforce in CI

Author: hrodmn

.devcontainer/devcontainer.json

@@ -1,4 +1,4 @@
 {
-    "name": "VS Code DEV Container for AWS CDK development",
-    "image": "jsii/superchain:1-buster-slim-node16"
+  "name": "VS Code DEV Container for AWS CDK development",
+  "image": "jsii/superchain:1-buster-slim-node16"
 }

.github/pull_request_template.md

@@ -1,4 +1,5 @@
 ## :warning: Checklist if your PR is changing anything else than documentation
+
 - [ ] Posted the link to a successful manually triggered deployment workflow (successful including the resources destruction)
 
 ## Merge request description

.github/workflows/deploy.yaml

@@ -30,7 +30,6 @@ jobs:
       - name: Generate distribution packages
         run: npm run package
 
-
       - name: Install deployment environment
         id: install_deploy_env
         run: |

.github/workflows/distribute.yaml

@@ -13,7 +13,6 @@ jobs:
     runs-on: ubuntu-latest
     needs: package
     steps:
-
       - uses: actions/download-artifact@v4
         with:
           name: python

.github/workflows/lint.yaml

@@ -24,3 +24,15 @@ jobs:
 
       - name: Run pre-commit
         run: pre-commit run --all-files
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "18"
+          cache: "npm"
+
+      - name: Install Node.js dependencies
+        run: npm ci
+
+      - name: Run Prettier check
+        run: npx prettier --check .

.husky/pre-commit

@@ -0,0 +1 @@
+npx lint-staged

.prettierignore

@@ -0,0 +1,28 @@
+CHANGELOG.md
+
+# Dependencies
+node_modules/
+
+# Build / Dist output
+dist/
+lib/ # If TS output directory, make sure it's ignored if not meant to be formatted
+
+# Other generated files
+.jsii
+coverage/
+build/
+
+# Package manager lock files
+package-lock.json
+yarn.lock
+pnpm-lock.yaml
+
+# Diagrams or other specific directories
+diagrams/
+
+# Python specific (optional, if ruff handles *.py formatting)
+.venv/
+toxenv/
+integration_tests/cdk/cdk.out/
+*.py
+

README.md

@@ -1,59 +1,64 @@
-# eoAPI CDK Constructs
-
-eoapi-cdk is a package of [AWS CDK constructs](https://docs.aws.amazon.com/prescriptive-guidance/latest/best-practices-cdk-typescript-iac/constructs-best-practices.html) designed to encapsulate eoAPI services and best practices as simple reusable components.
-
-
-For more background on the included services see [The Earth Observation API](https://eoapi.dev/)
-
-## Included constructs
-Detailed API docs for the constructs can be found [here](https://developmentseed.org/eoapi-cdk/).
-
-### [pgSTAC Database](https://developmentseed.org/eoapi-cdk/#pgstacdatabase-)
-An [RDS](https://aws.amazon.com/rds/) instance with [pgSTAC](https://github.com/stac-utils/pgstac) installed and the Postgres parameters optimized for the selected instance type.
-
-### [STAC API](https://developmentseed.org/eoapi-cdk/#pgstacapilambda-)
-A STAC API implementation using [stac-fastapi](https://github.com/stac-utils/stac-fastapi) with a [pgSTAC backend](https://github.com/stac-utils/stac-fastapi-pgstac). Packaged as a complete runtime for deployment with API Gateway and Lambda.
-
-### [pgSTAC Titiler API](https://developmentseed.org/eoapi-cdk/#titilerpgstacapilambda-)
-A complete dynamic tiling API using [titiler-pgstac](https://github.com/stac-utils/titiler-pgstac) to create dynamic mosaics of assets based on [STAC Search queries](https://github.com/radiantearth/stac-api-spec/tree/master/item-search).  Packaged as a complete runtime for deployment with API Gateway and Lambda and fully integrated with the pgSTAC Database construct.
-
-### [STAC browser](https://developmentseed.org/eoapi-cdk/#stacbrowser-)
-A CDK construct to host a static [Radiant Earth STAC browser](https://github.com/radiantearth/stac-browser) on S3.
-
-### [OGC Features/Tiles API](https://developmentseed.org/eoapi-cdk/#titilerpgstacapilambda-)
-A complete OGC Features/Tiles API using [tipg](https://github.com/developmentseed/tipg). Packaged as a complete runtime for deployment with API Gateway and Lambda. By default the API will be connected to the Database's `public` schema.
-
-### [STAC Ingestor](https://developmentseed.org/eoapi-cdk/#stacingestor-)
-An API for large scale STAC data ingestion and validation into a pgSTAC instance.
-
-![ingestor](/diagrams/ingestor_diagram.png)
-
-Authentication for the STAC Ingestor API can be configured with JWTs authenticated by JWKS.  To learn more about securing FastAPI applications with this approach see [Securing FastAPI with JWKS (AWS Cognito, Auth0)](https://alukach.com/posts/fastapi-rs256-jwt/).
-
-A sample Cognito-based authentication system is available at [aws-asdi-auth](https://github.com/developmentseed/aws-asdi-auth).
-
-### [Bastion Host](https://developmentseed.org/eoapi-cdk/#bastionhost-)
-A bastion host is a secure gateway that provides access to resources in a private subnet.  In this case it provides the ability to make administrative connections to eoAPI's pgSTAC instance.
-
-![Alt text](/diagrams/bastion_diagram.png)
-
-For more background on bastion hosts in AWS see [this article](https://dev.to/aws-builders/bastion-host-in-aws-vpc-2i63).
-
-And for configuration instructions for this construct see [the docs](https://developmentseed.org/eoapi-cdk/#bastionhost-).
-
-
-## Published Packages
-
-- https://pypi.org/project/eoapi-cdk/
-- https://www.npmjs.com/package/eoapi-cdk/
-
-## Release
-
-Versioning is automatically handled via [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) and [Semantic Release](https://semantic-release.gitbook.io/semantic-release/).
-
-_Warning_: If you rebase `main`, you must ensure that the commits referenced by tags point to commits that are within the `main` branch. If a commit references a commit that is no longer on the `main` branch, Semantic Release will fail to detect the correct version of the project. [More information](https://github.com/semantic-release/semantic-release/issues/1121#issuecomment-517945233).
-
-
-## Tests
-
+# eoAPI CDK Constructs
+
+eoapi-cdk is a package of [AWS CDK constructs](https://docs.aws.amazon.com/prescriptive-guidance/latest/best-practices-cdk-typescript-iac/constructs-best-practices.html) designed to encapsulate eoAPI services and best practices as simple reusable components.
+
+For more background on the included services see [The Earth Observation API](https://eoapi.dev/)
+
+## Included constructs
+
+Detailed API docs for the constructs can be found [here](https://developmentseed.org/eoapi-cdk/).
+
+### [pgSTAC Database](https://developmentseed.org/eoapi-cdk/#pgstacdatabase-)
+
+An [RDS](https://aws.amazon.com/rds/) instance with [pgSTAC](https://github.com/stac-utils/pgstac) installed and the Postgres parameters optimized for the selected instance type.
+
+### [STAC API](https://developmentseed.org/eoapi-cdk/#pgstacapilambda-)
+
+A STAC API implementation using [stac-fastapi](https://github.com/stac-utils/stac-fastapi) with a [pgSTAC backend](https://github.com/stac-utils/stac-fastapi-pgstac). Packaged as a complete runtime for deployment with API Gateway and Lambda.
+
+### [pgSTAC Titiler API](https://developmentseed.org/eoapi-cdk/#titilerpgstacapilambda-)
+
+A complete dynamic tiling API using [titiler-pgstac](https://github.com/stac-utils/titiler-pgstac) to create dynamic mosaics of assets based on [STAC Search queries](https://github.com/radiantearth/stac-api-spec/tree/master/item-search). Packaged as a complete runtime for deployment with API Gateway and Lambda and fully integrated with the pgSTAC Database construct.
+
+### [STAC browser](https://developmentseed.org/eoapi-cdk/#stacbrowser-)
+
+A CDK construct to host a static [Radiant Earth STAC browser](https://github.com/radiantearth/stac-browser) on S3.
+
+### [OGC Features/Tiles API](https://developmentseed.org/eoapi-cdk/#titilerpgstacapilambda-)
+
+A complete OGC Features/Tiles API using [tipg](https://github.com/developmentseed/tipg). Packaged as a complete runtime for deployment with API Gateway and Lambda. By default the API will be connected to the Database's `public` schema.
+
+### [STAC Ingestor](https://developmentseed.org/eoapi-cdk/#stacingestor-)
+
+An API for large scale STAC data ingestion and validation into a pgSTAC instance.
+
+![ingestor](/diagrams/ingestor_diagram.png)
+
+Authentication for the STAC Ingestor API can be configured with JWTs authenticated by JWKS. To learn more about securing FastAPI applications with this approach see [Securing FastAPI with JWKS (AWS Cognito, Auth0)](https://alukach.com/posts/fastapi-rs256-jwt/).
+
+A sample Cognito-based authentication system is available at [aws-asdi-auth](https://github.com/developmentseed/aws-asdi-auth).
+
+### [Bastion Host](https://developmentseed.org/eoapi-cdk/#bastionhost-)
+
+A bastion host is a secure gateway that provides access to resources in a private subnet. In this case it provides the ability to make administrative connections to eoAPI's pgSTAC instance.
+
+![Alt text](/diagrams/bastion_diagram.png)
+
+For more background on bastion hosts in AWS see [this article](https://dev.to/aws-builders/bastion-host-in-aws-vpc-2i63).
+
+And for configuration instructions for this construct see [the docs](https://developmentseed.org/eoapi-cdk/#bastionhost-).
+
+## Published Packages
+
+- https://pypi.org/project/eoapi-cdk/
+- https://www.npmjs.com/package/eoapi-cdk/
+
+## Release
+
+Versioning is automatically handled via [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) and [Semantic Release](https://semantic-release.gitbook.io/semantic-release/).
+
+_Warning_: If you rebase `main`, you must ensure that the commits referenced by tags point to commits that are within the `main` branch. If a commit references a commit that is no longer on the `main` branch, Semantic Release will fail to detect the correct version of the project. [More information](https://github.com/semantic-release/semantic-release/issues/1121#issuecomment-517945233).
+
+## Tests
+
 Each pull request to `main` is added to a [merge queue](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue#triggering-merge-group-checks-with-github-actions) so that a "deployment test" workflow can run before the merge actually happens. If the deployment fails, the merge is cancelled. Here is [the definition of this workflow](https://github.com/developmentseed/eoapi-cdk/blob/main/.github/workflows/deploy.yaml) and the [tests definition](https://github.com/developmentseed/eoapi-cdk/blob/main/tests).

integration_tests/cdk/README.md

@@ -1,4 +1,3 @@
-
 # Deployment CDK code for eoapi-cdk deployment tests
 
 This is a wrapper CDK code that is used to test a deployment of the `eoapi-cdk` constructs.

integration_tests/cdk/cdk.json

@@ -1,9 +1,7 @@
 {
   "app": "python3 app.py",
   "watch": {
-    "include": [
-      "**"
-    ],
+    "include": ["**"],
     "exclude": [
       "README.md",
       "cdk*.json",
@@ -24,9 +22,6 @@
     "@aws-cdk/aws-lambda:recognizeVersionProps": true,
     "@aws-cdk/aws-cloudfront:defaultSecurityPolicyTLSv1.2_2021": true,
     "@aws-cdk-containers/ecs-service-extensions:enableDefaultLogDriver": true,
-    "@aws-cdk/core:target-partitions": [
-      "aws",
-      "aws-cn"
-    ]
+    "@aws-cdk/core:target-partitions": ["aws", "aws-cn"]
   }
 }