TiddlyWiki5/plugins/tiddlywiki/jasmine
Jeremy Ruston 4a9b3009dd Further fix for d1c7f79dd2
The plus sign needs escaping on some regex engines
2023-12-11 15:21:03 +00:00
..
files Upgrade to Jasmine 3 (#4226) 2019-11-12 21:42:38 +00:00
command.js Jasmine command (#6944) 2022-11-20 17:54:18 +00:00
help.tid Jasmine command (#6944) 2022-11-20 17:54:18 +00:00
jasmine-plugin.js Fix comment missing from previous commit 6c7c21a87b 2023-07-06 12:01:39 +01:00
plugin.info Improve plugin metadata, and add a "name" field 2019-09-19 13:04:10 +01:00
readme.tid Jasmine command (#6944) 2022-11-20 17:54:18 +00:00
run-wiki-based-tests.js Further fix for d1c7f79dd2 2023-12-11 15:21:03 +00:00
startup.js Fix overeager onload handler in Jasmine plugin 2023-07-06 11:52:33 +01:00
update-packages.sh Upgrade to Jasmine 3 (#4226) 2019-11-12 21:42:38 +00:00

readme.tid

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/Jermolene/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.