This repo contains the code for Account Components
Install NVM or FNM and select the correct Node version by running nvm use
or fnm use
.
Install Homebrew.
Install dependencies with npm ci
.
When updating the Node version you will need to update the following:
engines.node
field in package.json- .nvmrc
- .node-version
- Node images in Dockerfiles
- ensure the base TSConfig installed as a development dependency in package.json and used in tsconfig.json corresponds with the Node version being used e.g. for Node 22 use the base TSConfig
@tsconfig/node22
- ensure the major version of
@types/node
installed as a development dependency in package.json corresponds with the Node version being used
There are various commands which can be run manually and which are also run by Git hooks and in CI:
npm run format
to run Prettier formattingnpm run eslint
to run ESLintnpm run knip
to run Knipnpm run tflint
to lint Terraform filesnpm run cflint
to lint CloudFormation templates with the file extension.cf.yaml
npm run check-gh-actions
to check GitHub Actions with Zizmornpm run detect-secrets
to detect secrets which should not be in the repo. False positives can be ignored with comments or added to the baseline by runningnpm run detect-secrets:update-baseline
If these commands detect issues it may be possible to fix them by running:
npm run format:fix
npm run eslint:fix
npm run knip:fix
npm run tflint:fix
npm run cflint:fix
npm run check-gh-actions:fix