Commit 2dcdbdd

committed

Documentation for automated tests

1 parent 474ff87 commit 2dcdbddCopy full SHA for 2dcdbdd

File tree

+15

-1

lines changed

+15

-1

lines changed

Lines changed: 12 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,15 @@ npm run compile`
`33`	`33`	`Now, depending on which part you want to work on follow the relevant section`
`34`	`34`	`below.`
`35`	`35`
	`36`	`+## Development Tools`
	`37`	`+`
	`38`	`+To support a good develop workflow we set up [TSLint][tslint], [Prettier][prettier] and integration tests using [Jest][jest]:`
	`39`	`+`
	`40`	`+ yarn run check # (runs lint, prettier and tests)`
	`41`	`+ yarn run lint`
	`42`	`+ yarn run test`
	`43`	`+ yarn run test:coverage`
	`44`	`+`
`36`	`45`	`## Working on the client`
`37`	`46`
`38`	`47`	`### Visual Studio Code`
`@@ -64,3 +73,6 @@ I'm open to suggestions on how to improve this workflow.`
`64`	`73`
`65`	`74`	`[LSP]: https://microsoft.github.io/language-server-protocol/`
`66`	`75`	`[ide-bash]: https://github.com/mads-hartmann/ide-bash`
	`76`	`+[jest]: https://facebook.github.io/jest/`
	`77`	`+[prettier]: https://prettier.io/`
	`78`	`+[tslint]: https://palantir.github.io/tslint/`

Lines changed: 3 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,9 @@`
`20`	`20`	`"lint:bail": "tslint --project vscode-client && tslint --project server",`
`21`	`21`	`"test": "jest --runInBand --forceExit",`
`22`	`22`	`"test:coverage": "npm run test -- --coverage",`
`23`		`- "test:watch": "npm run test -- --watch"`
	`23`	`+ "test:watch": "npm run test -- --watch",`
	`24`	`+ "check": "npm run lint && npm run test",`
	`25`	`+ "check:bail": "npm run lint:bail && npm run test"`
`24`	`26`	`},`
`25`	`27`	`"devDependencies": {`
`26`	`28`	`"@types/jest": "^22.2.2",`

Comments

(0)