readme-assert 7.1.0 → 7.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "readme-assert",
-  "version": "7.1.0",
+  "version": "7.2.0",
   "description": "Run code blocks in your readme as tests",
   "keywords": [
     "readme",

package/readme.md

@@ -71,6 +71,15 @@ const b = () => {
 b(); // throws /fail/
 ```
 
+Or use `//=>` with an error name and optional message to match both:
+
+```javascript test
+const c = () => {
+  throw new TypeError("bad input");
+};
+c(); //=> TypeError: bad input
+```
+
 ### console.log
 
 Assert console output — the call is preserved and an assertion is added:

package/src/comment-to-assert.js

@@ -7,6 +7,7 @@ import MagicString from "magic-string";
  *   expr //=> value        → assert.deepEqual(expr, value)
  *   expr // → value        → assert.deepEqual(expr, value)
  *   expr // throws /pat/   → assert.throws(() => { expr }, /pat/)
+ *   expr //=> Error: msg   → assert.throws(() => { expr }, { message: "msg" })
  *   console.log(x) //=> v  → console.log(x); assert.deepEqual(x, v)
  *   expr //=> resolves to v → assert.deepEqual(await expr, v)
  *   expr // rejects /pat/  → assert.rejects(() => expr, /pat/)
@@ -41,6 +42,8 @@ export function commentToAssert(code, { typescript = false } = {}) {
       const resolvesMatch = rest.match(/^resolves\s+(?:to\s+)?([\s\S]*)$/);
       changed = true;
 
+      const errorMatch = rest.match(/^((?:[A-Z]\w+)?Error)(?::\s*(.*))?$/);
+
       if (resolvesMatch) {
         // expr //=> resolves to value → assert.deepEqual(await expr, value)
         const expected = resolvesMatch[1].trim();
@@ -53,6 +56,23 @@ export function commentToAssert(code, { typescript = false } = {}) {
           comment.end,
           `assert.deepEqual(await ${exprSource}, ${expected});`,
         );
+      } else if (errorMatch) {
+        // expr //=> TypeError: msg → assert.throws(() => { expr }, { name, message })
+        const errorName = errorMatch[1];
+        const errorMessage = errorMatch[2]?.trim();
+        const exprSource = code.slice(
+          node.expression.start,
+          node.expression.end,
+        );
+        const props = [`name: "${errorName}"`];
+        if (errorMessage) {
+          props.push(`message: "${errorMessage}"`);
+        }
+        s.overwrite(
+          node.start,
+          comment.end,
+          `assert.throws(() => { ${exprSource}; }, { ${props.join(", ")} });`,
+        );
       } else if (isConsoleCall(node.expression)) {
         // console.log(expr) //=> value → keep log, add assertion after.
         // Stay on the same line so subsequent markdown line numbers are