Skip to content
This repository has been archived by the owner on Oct 14, 2024. It is now read-only.

Commit

Permalink
docs(ui): add Prettier to docs
Browse files Browse the repository at this point in the history
Signed-off-by: András Jáky <[email protected]>
  • Loading branch information
akijakya committed Jul 25, 2024
1 parent 73a64d9 commit 67dbcf7
Showing 1 changed file with 21 additions and 2 deletions.
23 changes: 21 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,8 @@ use (
./uibackend/server
./uibackend/types
./utils
./workflow)
./workflow
)
```

### Running the VMClarity stack locally using Docker
Expand Down Expand Up @@ -147,7 +148,7 @@ You must be logged into the docker registry locally before using this target.
ran:

- `make license-check` can be used to validate that all the files in the repo have the correctly formatted license
header.
header.
- `make lint-actions` checks Github Actions workflow files.
- `make lint-bicep` lints Bicep files.
- `make lint-cfn` lints Cloudformation files.
Expand Down Expand Up @@ -181,6 +182,24 @@ client and server code.
- Run `make gen-bicep` for generating bicep files after modifying them for installing VMClarity on Azure.
- Run `make gen-helm-docs` for generating the docs after making changes to VMClarity's Helm chart.

### Formatting

Prettier is enabled (so you can use autoformatting plugins), and its use is enforced for files under the `ui/`
directory. For example you could use something similar in VSCode's `settings.json`:

```json
}
"[javascriptreact]": {
"editor.formatOnSave": true,
"editor.formatOnType": true,
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
...
}
```

`make format` can be used to format everything at once with Prettier which is also being checked by the CI.

### Testing End to End

`make e2e-docker` can be used run the end-to-end tests in the repository locally using Docker. `make e2e-k8s` can also
Expand Down

0 comments on commit 67dbcf7

Please sign in to comment.