Skip to content

Commit 95005fc

Browse files
danipaniiiPriebe DanielHeiko Holz
authored
Feature: Update Readme to help developers handle prettier errors. (#1529)
* Update Readme to help developers handle prettier errors in the Config UI tests * Minor improvements in README for prettier trouble shooting Co-authored-by: Priebe Daniel <dpr@novatec-gmbh.de> Co-authored-by: Heiko Holz <heiko.holz@novatec-gmbh.de>
1 parent 3bafa42 commit 95005fc

File tree

1 file changed

+13
-0
lines changed
  • components/inspectit-ocelot-configurationserver-ui

1 file changed

+13
-0
lines changed

components/inspectit-ocelot-configurationserver-ui/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,19 @@ And the following to fix them automatically.
3333
yarn lint:fix
3434
```
3535

36+
### Prettier
37+
38+
When facing prettier/prettier errors in the Config UI tests and developing with VS Code, follows these steps for problem solving:
39+
40+
* make sure to install the [prettier extension from Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
41+
* open the file in which the prettier errors occur
42+
* format the document using prettier
43+
1. to format the document, open the command palette with `Ctrl + Shift + P` (Windows) or `Cmd + Shift + P` (Mac)
44+
2. search for `Format Document With...`.
45+
3. press Enter
46+
4. in the opened drop down menu you can choose your preferred code styling (in this case prettier). Select `prettier` and press Enter
47+
* the opened code file will automatically be formatted by prettier, which will fix the prettier errors in the Config UI tests.
48+
3649
#### Storybook
3750

3851
The project also contains [Storybook](https://storybook.js.org/) which supports the development of components by providing an isolated sandbox UI for testing these components.

0 commit comments

Comments
 (0)