TiddlyWiki5/plugins/tiddlywiki/jasmine

title: $:/plugins/tiddlywiki/jasmine/readme

This plugin provides a framework for running tests in the browser and under Node.js. It is based on [[Jasmine|https://jasmine.github.io/]] test framework. On Tiddlywiki, it runs tests in all javascript tiddlers tagged with <<tag $:/tags/test-spec>>.

[[Source code|https://github.com/TiddlyWiki/TiddlyWiki5/blob/master/plugins/tiddlywiki/jasmine]]

!! Usage on Node.js

On the command line, type `tiddlywiki --test`.

Alternatively, you can set up a build task for jasmine by including the following in your tiddlywiki.info file:

```
{
	...
	"build": {
		...
		"test": ["--test"]
	}
}
```

You could then run tests by typing `tiddlywiki --build test` or just `tiddlywiki --build`. The advantage to this is it allows you to include other commands to run as well. See `tiddlywiki --help test` for more information.

This will run the tests and produce a test file in your output directory.

```
		"test": [
			"--test",
			"--rendertiddler","$:/core/save/all","test.html","text/plain"]
```

!! Usage on a browser

Once you've constructed a Tiddlywiki file using a command like the one above, you can run the tests simply by opening it. Tests run automatically, and the results will be at the bottom of the window.