Skip to content

Commit

Permalink
Document testing
Browse files Browse the repository at this point in the history
  • Loading branch information
MaddyGuthridge committed May 19, 2024
1 parent 325b1e8 commit 1048234
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 6 deletions.
3 changes: 1 addition & 2 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,5 @@
"cSpell.words": [
"Asciinema",
"superstruct"
],
"testing.openTesting": "neverOpen"
]
}
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,14 @@ npm run dev
npm run dev -- --open
```

### Testing

* Tests can be run with `npm t`. The dev server will be automatically started
and stopped.
* Type checking can be run with `npm run check`.
* Linting can be run with `npm run lint`. Automatic fixes can be applied using
`npm run lint-fix`.

## Building

To create a production version of your app:
Expand All @@ -34,9 +42,9 @@ To run the production server:
node -r dotenv/config build
```

This requires a `.env` file with the following properties:
This requires a `.env` file with the following keys:

```ini
HOST=127.0.0.1
PORT=5096
HOST=127.0.0.1 # the hostname to use
PORT=5096 # the port number to use
```
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,11 @@
"dev": "vite dev",
"build": "vite build",
"preview": "vite preview",
"test": "jest",
"check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
"check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
"lint": "eslint .",
"test": "jest"
"lint-fix": "eslint --fix ."
},
"type": "module",
"dependencies": {
Expand Down

0 comments on commit 1048234

Please sign in to comment.