best practices typescript
this repo contains a declapract
declaration of best practices for typescript projects
usage
- add
declapract
to your repo
npm install --save-dev declapract
- add a declapract usage config to your repo
# declapract.use.yml
declarations: npm:best-practices-typescript
useCase: lambda-service # specify which use case your repo is following, see `best-practices-typescript:src/useCases.yml` for options
variables: # specify the values of the variables to use against checks
organizationName: 'awesome-org'
serviceName: 'svc-awesome-thing'
infrastructureNamespaceId: 'abcde12345'
slackReleaseWebHook: 'https://...'
- clone a declared best practices example, do bootstrap a new repo
declapract clone lambda-service-with-rds # bootstrap a new lambda-service-with-rds repo
- check that your repo is conforming to best practices
declapract check
- fix a specific practice that your repo is failing to conform to (if it has an automatic fix declared)
declapract fix --practice dates-and-times # e.g., apply a fix for the the dates-and-times practice