File tree Expand file tree Collapse file tree 1 file changed +22
-0
lines changed
Expand file tree Collapse file tree 1 file changed +22
-0
lines changed Original file line number Diff line number Diff line change @@ -82,13 +82,35 @@ Please report any problems you've had with the setup instructions!
8282## Code Style
8383
8484To make sure the code changes only where it should, we are using prettier to unify the code style.
85+
86+ - You can format all files at once by running ` pnpm prettier ` from the project root
87+ - Run ` pnpm format-check ` from the project root to check if all files are well formatted
88+
8589If you use VSCode, you can
8690
87911 . install [ the prettier extension] ( https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode )
88922 . open command palette and run "Format Document With..."
89933 . Choose "Configure Default Formatter..."
90944 . Select prettier
9195
96+ ## ESLint
97+
98+ To prevent unwanted runtime errors, this project uses [ eslint] ( https://eslint.org/ ) .
99+
100+ - You can check for lint errors by running ` pnpm lint `
101+
102+ There are also eslint extensions / plugins for most editors.
103+
104+ ## Running Tests
105+
106+ - Run all tests with ` pnpm test `
107+ - Run all tests with UI using ` pnpm test-ui `
108+
109+ ## Running all CI Checks
110+
111+ When opening a PR, the CI runner will automatically check the code style and eslint, as well as run all tests.
112+ You can run the same check with ` pnpm check `
113+
92114## Package Workflow
93115
94116The project is split into multiple [ packages] ( https://github.com/tidalcycles/strudel/tree/main/packages ) with independent versioning.
You can’t perform that action at this time.
0 commit comments