Use snapshots

Remove example output, the snapshots should be clear enough.

Author: novemberborn

example-output.md

@@ -13,8 +13,7 @@
     "node": ">=4"
   },
   "scripts": {
-    "test": "xo && nyc ava",
-    "preversion": "WRITE_EXAMPLES=1 npm run test && git add example-output.md"
+    "test": "xo && nyc ava"
   },
   "files": [
     "index.js"

package.json

@@ -17,16 +17,7 @@ The difficulty is that `t.throws(foo())` is allowed if `foo()` returns a promise
 
 ## Solution
 
-See [`example-output.md`](example-output.md) for the transformation this plugin performs.
-
-The example output can be generated by calling:
-
-```
-$ WRITE_EXAMPLES=1 ava
-```
-
-Contributors should not commit new examples. They will be regenerated as part of the release process.
-
+See [`test.js.md`](test.js.md) for the transformation this plugin performs.
 
 ## License
 

readme.md

@@ -1,6 +1,4 @@
-import path from 'path';
-import fs from 'fs';
-import {serial as test} from 'ava';
+import test from 'ava';
 import * as babel from '@babel/core';
 import fn from './';
 
@@ -11,76 +9,18 @@ function transform(input) {
 	});
 }
 
-const examples = [];
-
-function addExample(input, output) {
-	examples.push(
-		'input:',
-		'',
-		'```js',
-		input,
-		'```',
-		'',
-		'becomes:',
-		'',
-		'```js',
-		output,
-		'```',
-		'',
-		'---',
-		''
-	);
-}
-
-const HELPERS = `function _avaThrowsHelperStart(t, assertion, file, line) {
-  if (t._throwsArgStart) {
-    t._throwsArgStart(assertion, file, line);
-  }
-}
-
-function _avaThrowsHelperEnd(t, arg) {
-  if (t._throwsArgEnd) {
-    t._throwsArgEnd();
-  }
-
-  return arg;
-}\n\n`;
-
-function wrapped(throws, expression, line) {
-	return `t.${throws}((_avaThrowsHelperStart(t, "${throws}", "some-file.js", ${line}), _avaThrowsHelperEnd(t, ${expression})));`;
-}
-
-test('creates a helper', t => {
-	const input = 't.throws(foo())';
-	const {code} = transform(input);
-
-	t.is(code, HELPERS + wrapped('throws', 'foo()', 1));
-	addExample(input, code);
-});
-
-test('creates the helper only once', t => {
-	const input = 't.throws(foo());\nt.throws(bar());';
+function snapshotTransform(t, input) {
 	const {code} = transform(input);
+	t.snapshot(code, input);
+}
 
-	t.is(code, HELPERS + wrapped('throws', 'foo()', 1) + '\n' + wrapped('throws', 'bar()', 2));
-	addExample(input, code);
-});
+test('creates a helper', snapshotTransform, 't.throws(foo())');
 
-test('does nothing if it does not match', t => {
-	const input = 't.is(foo());';
-	const {code} = transform(input);
+test('creates the helper only once', snapshotTransform, 't.throws(foo()); t.throws(bar());');
 
-	t.is(code, input);
-	addExample(input, code);
-});
+test('does nothing if it does not match', snapshotTransform, 't.is(foo());');
 
-test('helps notThrows', t => {
-	const input = 't.notThrows(baz())';
-	const {code} = transform(input);
-
-	t.is(code, HELPERS + wrapped('notThrows', 'baz()', 1));
-	addExample(input, code);
-});
+test('helps notThrows', snapshotTransform, 't.notThrows(baz())');
 
 test('does not throw on generated code', t => {
 	t.notThrows(() => {
@@ -103,13 +43,3 @@ test('does not throw on generated code', t => {
 		});
 	});
 });
-
-if (process.env.WRITE_EXAMPLES) {
-	test('writing examples', t => {
-		fs.writeFileSync(
-			path.join(__dirname, 'example-output.md'),
-			examples.join('\n')
-		);
-		t.pass();
-	});
-}

test.js

@@ -0,0 +1,72 @@
+# Snapshot report for `test.js`
+
+The actual snapshot is saved in `test.js.snap`.
+
+Generated by [AVA](https://ava.li).
+
+## creates a helper
+
+> t.throws(foo())
+
+    `function _avaThrowsHelperStart(t, assertion, file, line) {␊
+      if (t._throwsArgStart) {␊
+        t._throwsArgStart(assertion, file, line);␊
+      }␊
+    }␊
+    ␊
+    function _avaThrowsHelperEnd(t, arg) {␊
+      if (t._throwsArgEnd) {␊
+        t._throwsArgEnd();␊
+      }␊
+    ␊
+      return arg;␊
+    }␊
+    ␊
+    t.throws((_avaThrowsHelperStart(t, "throws", "some-file.js", 1), _avaThrowsHelperEnd(t, foo())));`
+
+## creates the helper only once
+
+> t.throws(foo()); t.throws(bar());
+
+    `function _avaThrowsHelperStart(t, assertion, file, line) {␊
+      if (t._throwsArgStart) {␊
+        t._throwsArgStart(assertion, file, line);␊
+      }␊
+    }␊
+    ␊
+    function _avaThrowsHelperEnd(t, arg) {␊
+      if (t._throwsArgEnd) {␊
+        t._throwsArgEnd();␊
+      }␊
+    ␊
+      return arg;␊
+    }␊
+    ␊
+    t.throws((_avaThrowsHelperStart(t, "throws", "some-file.js", 1), _avaThrowsHelperEnd(t, foo())));␊
+    t.throws((_avaThrowsHelperStart(t, "throws", "some-file.js", 1), _avaThrowsHelperEnd(t, bar())));
+
+## does nothing if it does not match
+
+> t.is(foo());
+
+    't.is(foo());
+
+## helps notThrows
+
+> t.notThrows(baz())
+
+    `function _avaThrowsHelperStart(t, assertion, file, line) {␊
+      if (t._throwsArgStart) {␊
+        t._throwsArgStart(assertion, file, line);␊
+      }␊
+    }␊
+    ␊
+    function _avaThrowsHelperEnd(t, arg) {␊
+      if (t._throwsArgEnd) {␊
+        t._throwsArgEnd();␊
+      }␊
+    ␊
+      return arg;␊
+    }␊
+    ␊
+    t.notThrows((_avaThrowsHelperStart(t, "notThrows", "some-file.js", 1), _avaThrowsHelperEnd(t, baz())));`