Contribution

Thanks for contributing. In the following section, you will find how to set up s3-simpler (S4).

Pre-requisite

= NodeJs 18.x
PNPM
AWS account and use the environment variables
- AWS_REGION, AWS_ACCESS_KEY_ID, AWS_SECRETS_ACCESS_KEY, AWS_SESSION_TOKEN (when SSO)

This project is generated by projen and is using its Typescript Project.

pnpm install

Run all tests. This works only when AWS credentials are provided.

pnpm test

Run just unit tests

pnpm test:unit

Run just integration tests. This works only when AWS credentials are provided.

pnpm test:integration

Run the vitest UI.

pnpm vitest:ui

We use Biome to format and lint.

pnpm lint

This runs a safe fix linting. If not everything is formatted but after reviewing you see it is fine, you can run

pnpm lint:unsafe

Usually, this is sufficient to format and lint at the same time.