Add StackBlitz examples for command line documentation

SamVerschueren · novemberborn · commit 0d5860f08b00 · 2021-07-25T19:28:28.000+02:00
diff --git a/.xo-config.json b/.xo-config.json
@@ -76,6 +76,12 @@
 			"rules": {
 				"ava/no-identical-title": "off"
 			}
+		},
+		{
+			"files": "examples/**",
+			"rules": {
+				"ava/no-only-test": "off"
+			}
 		}
 	]
 }
diff --git a/docs/05-command-line.md b/docs/05-command-line.md
@@ -80,6 +80,8 @@ When using `npm test`, you can pass positional arguments directly `npm test test
 
 ## Running tests with matching titles
 
+[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/avajs/ava/tree/main/examples/matching-titles?file=test.js&terminal=test&view=editor)
+
 The `--match` flag allows you to run just the tests that have a matching title. This is achieved with simple wildcard patterns. Patterns are case insensitive. See [`matcher`](https://github.com/sindresorhus/matcher) for more details.
 
 Match titles ending with `foo`:
@@ -154,6 +156,8 @@ test(function foo(t) {
 
 ## Running tests at specific line numbers
 
+[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/avajs/ava/tree/main/examples/specific-line-numbers?file=test.js&terminal=test&view=editor)
+
 AVA lets you run tests exclusively by referring to their line numbers. Target a single line, a range of lines or both. You can select any line number of a test.
 
 The format is a comma-separated list of `[X|Y-Z]` where `X`, `Y` and `Z` are integers between `1` and the last line number of the file.
@@ -236,6 +240,8 @@ Use the `--verbose` flag to enable the verbose reporter. This is always used in
 
 ### TAP reporter
 
+[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/avajs/ava/tree/main/examples/tap-reporter?file=test.js&terminal=test&view=editor)
+
 AVA supports the TAP format and thus is compatible with [any TAP reporter](https://github.com/sindresorhus/awesome-tap#reporters). Use the `--tap` flag to enable TAP output.
 
 ```console
diff --git a/examples/matching-titles/package.json b/examples/matching-titles/package.json
@@ -0,0 +1,10 @@
+{
+	"name": "ava-matching-titles",
+	"description": "Example for running tests with matching titles",
+	"scripts": {
+		"test": "ava --match='*oo*'"
+	},
+	"devDependencies": {
+		"ava": "^3.15.0"
+	}
+}
diff --git a/examples/matching-titles/readme.md b/examples/matching-titles/readme.md
@@ -0,0 +1,5 @@
+# Running tests with matching titles
+
+> Example for [running tests with matching titles](https://github.com/avajs/ava/blob/main/docs/05-command-line.md#running-tests-with-matching-titles)
+
+[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/avajs/ava/tree/main/examples/matching-titles?file=test.js&terminal=test&view=editor)
diff --git a/examples/matching-titles/test.js b/examples/matching-titles/test.js
@@ -0,0 +1,14 @@
+'use strict';
+const test = require('ava');
+
+test('foo will run', t => {
+	t.pass();
+});
+
+test('moo will also run', t => {
+	t.pass();
+});
+
+test.only('boo will run but not exclusively', t => {
+	t.pass();
+});
diff --git a/examples/specific-line-numbers/package.json b/examples/specific-line-numbers/package.json
@@ -0,0 +1,10 @@
+{
+	"name": "ava-specific-line-numbers",
+	"description": "Example for running tests at specific line numbers",
+	"scripts": {
+		"test": "ava test.js:5"
+	},
+	"devDependencies": {
+		"ava": "^3.15.0"
+	}
+}
diff --git a/examples/specific-line-numbers/readme.md b/examples/specific-line-numbers/readme.md
@@ -0,0 +1,5 @@
+# Running tests at specific line numbers
+
+> Example for [running tests at specific line numbers](https://github.com/avajs/ava/blob/main/docs/05-command-line.md#running-tests-at-specific-line-numbers)
+
+[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/avajs/ava/tree/main/examples/specific-line-numbers?file=test.js&terminal=test&view=editor)
diff --git a/examples/specific-line-numbers/test.js b/examples/specific-line-numbers/test.js
@@ -0,0 +1,10 @@
+'use strict';
+const test = require('ava');
+
+test('unicorn', t => {
+	t.pass();
+});
+
+test('rainbow', t => {
+	t.fail();
+});
diff --git a/examples/tap-reporter/package.json b/examples/tap-reporter/package.json
@@ -0,0 +1,11 @@
+{
+	"name": "ava-tap-reporter",
+	"description": "Example for a custom TAP reporter",
+	"scripts": {
+		"test": "ava --tap | tap-nyan"
+	},
+	"devDependencies": {
+		"ava": "^3.15.0",
+		"tap-nyan": "^1.1.0"
+	}
+}
diff --git a/examples/tap-reporter/readme.md b/examples/tap-reporter/readme.md
@@ -0,0 +1,5 @@
+# Running tests at specific line numbers
+
+> Example for a [custom TAP reporter](https://github.com/avajs/ava/blob/main/docs/05-command-line.md#running-tests-at-specific-line-numbers)
+
+[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/avajs/ava/tree/main/examples/tap-reporter?file=test.js&terminal=test&view=editor)
diff --git a/examples/tap-reporter/test.js b/examples/tap-reporter/test.js
@@ -0,0 +1,22 @@
+'use strict';
+const test = require('ava');
+
+test('unicorn', t => {
+	t.pass();
+});
+
+test('rainbow', t => {
+	t.fail();
+});
+
+test('foo', t => {
+	t.pass();
+});
+
+test('bar', t => {
+	t.pass();
+});
+
+test('baz', t => {
+	t.pass();
+});

Original file line number	Diff line number	Diff line change
`@@ -76,6 +76,12 @@`
`76`	`76`	`"rules": {`
`77`	`77`	`"ava/no-identical-title": "off"`
`78`	`78`	`}`
	`79`	`+ },`
	`80`	`+ {`
	`81`	`+ "files": "examples/**",`
	`82`	`+ "rules": {`
	`83`	`+ "ava/no-only-test": "off"`
	`84`	`+ }`
`79`	`85`	`}`
`80`	`86`	`]`
`81`	`87`	`}`