Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
scosman committed Mar 3, 2024
1 parent 2735fdf commit aa44145
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,12 +134,10 @@ The repo includes [CI scripts](https://aws.amazon.com/devops/continuous-integrat

You can manually run these scripts yourself; `npm run build` for the build, `npm run format_check` to check formatting, `npm run lint` for the linting, `npm run check` for typechecking, and `npm run test` for testing (if you add tests).

Installing extensions in your editor can automatically format-on-save, show linting/type issues inline, and run your test cases. We suggest the following extensions for VSCode:
- [Svelte Extension](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode) for Svelte and accessibility issues
- [ESLint for type checking and linting](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
- [Testing with Vitest](https://marketplace.visualstudio.com/items?itemName=vitest.explorer) - if you add tests

Extensions for other editors are available [here](https://sveltesociety.dev/tools#editor-support) and [here](https://eslint.org/docs/latest/use/integrations).
Installing extensions in your editor can automatically format-on-save, show linting/type issues inline, and run your test cases:
- Svelte for Svelte and accessibility issues: ([VSCode](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode) or [other editors](https://sveltesociety.dev/tools#editor-support)) -
- ESLint for type checking and linting: [VSCode](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) and [other editors](https://eslint.org/docs/latest/use/integrations)
- Vitest for testing if you add tests: [VSCode](https://marketplace.visualstudio.com/items?itemName=vitest.explorer) or [other editors](https://vitest.dev/guide/ide)

To catch build, formatting, linting and test issues before you commit changes, we suggest the following local git hook. It will run before you commit, stop you from breaking the build, and show any issues that are found. Add the lines below to an executable git hook script at the location `.git/hooks/pre-commit`.

Expand Down

0 comments on commit aa44145

Please sign in to comment.