expose declaration nodes

observablehq · Dec 28, 2021 · 98467c8 · 98467c8
1 parent a364003
commit 98467c8
Show file tree

Hide file tree

Showing 119 changed files with 700 additions and 139 deletions.
diff --git a/src/parse.js b/src/parse.js
@@ -23,6 +23,7 @@ export function parseCell(input, {tag, raw, globals, ...options} = {}) {
   }
   parseReferences(cell, input, globals);
   parseFeatures(cell, input);
+  parseDeclarations(cell);
   return cell;
 }
 
@@ -199,29 +200,12 @@ export class CellParser extends Parser {
       : super.toAssignable(node, isBinding, refDestructuringErrors);
   }
   checkCellDeclaration(node) {
-    switch (node.type) {
-      case "Identifier":
-        break;
-      case "ObjectPattern":
-        for (const p of node.properties) this.checkCellDeclaration(p);
-        break;
-      case "ArrayPattern":
-        for (const e of node.elements) e && this.checkCellDeclaration(e);
-        break;
-      case "Property":
-        this.checkCellDeclaration(node.value);
-        break;
-      case "RestElement":
-        this.checkCellDeclaration(node.argument);
-        break;
-      case "AssignmentPattern":
-        this.checkCellDeclaration(node.left);
-        break;
-      default:
-        // Don’t allow destructuring into viewof or mutable declarations.
+    // Don’t allow destructuring into viewof or mutable declarations.
+    declarePattern(node, id => {
+      if (id.type !== "Identifier") {
         this.unexpected();
-        break;
-    }
+      }
+    });
   }
   checkLocal(id) {
     const node = id.id || id;
@@ -423,3 +407,56 @@ function parseFeatures(cell, input) {
   }
   return cell;
 }
+
+// Find declarations: things that this cell defines.
+function parseDeclarations(cell) {
+  if (!cell.body) {
+    cell.declarations = [];
+  } else if (cell.body.type === "ImportDeclaration") {
+    cell.declarations = cell.body.specifiers.map(s => s.local);
+  } else if (!cell.id) {
+    cell.declarations = [];
+  } else {
+    switch (cell.id.type) {
+      case "Identifier":
+      case "ViewExpression":
+      case "MutableExpression":
+        cell.declarations = [cell.id];
+        break;
+      case "ArrayPattern":
+      case "ObjectPattern":
+        cell.declarations = [];
+        declarePattern(cell.id, node => cell.declarations.push(node));
+        break;
+      default:
+        throw new Error(`unexpected identifier: ${cell.id.type}`);
+    }
+  }
+}
+
+function declarePattern(node, callback) {
+  switch (node.type) {
+    case "Identifier":
+    case "ViewExpression":
+    case "MutableExpression":
+      callback(node);
+      break;
+    case "ObjectPattern":
+      node.properties.forEach(node => declarePattern(node, callback));
+      break;
+    case "ArrayPattern":
+      node.elements.forEach(node => node && declarePattern(node, callback));
+      break;
+    case "Property":
+      declarePattern(node.value, callback);
+      break;
+    case "RestElement":
+      declarePattern(node.argument, callback);
+      break;
+    case "AssignmentPattern":
+      declarePattern(node.left, callback);
+      break;
+    default:
+      throw new Error(`unexpected declaration: ${node.type}`);
+  }
+}
diff --git a/test/output/anonymous-block-cell.js.json b/test/output/anonymous-block-cell.js.json
@@ -27,5 +27,6 @@
   "references": [],
   "fileAttachments": [],
   "databaseClients": [],
-  "secrets": []
+  "secrets": [],
+  "declarations": []
 }
diff --git a/test/output/anonymous-expression-cell.js.json b/test/output/anonymous-expression-cell.js.json
@@ -15,5 +15,6 @@
   "references": [],
   "fileAttachments": [],
   "databaseClients": [],
-  "secrets": []
+  "secrets": [],
+  "declarations": []
 }
diff --git a/test/output/anonymous-function.js.json b/test/output/anonymous-function.js.json
@@ -37,5 +37,6 @@
   "references": [],
   "fileAttachments": [],
   "databaseClients": [],
-  "secrets": []
+  "secrets": [],
+  "declarations": []
 }
diff --git a/test/output/await-block-cell.js.json b/test/output/await-block-cell.js.json
@@ -38,5 +38,6 @@
   ],
   "fileAttachments": [],
   "databaseClients": [],
-  "secrets": []
+  "secrets": [],
+  "declarations": []
 }
diff --git a/test/output/await-in-arrow-function-expression.js.json b/test/output/await-in-arrow-function-expression.js.json
@@ -48,5 +48,6 @@
   ],
   "fileAttachments": [],
   "databaseClients": [],
-  "secrets": []
+  "secrets": [],
+  "declarations": []
 }
diff --git a/test/output/await-in-arrow-function.js.json b/test/output/await-in-arrow-function.js.json
@@ -74,5 +74,6 @@
   ],
   "fileAttachments": [],
   "databaseClients": [],
-  "secrets": []
+  "secrets": [],
+  "declarations": []
 }
diff --git a/test/output/await-in-class.js.json b/test/output/await-in-class.js.json
@@ -88,5 +88,6 @@
   ],
   "fileAttachments": [],
   "databaseClients": [],
-  "secrets": []
+  "secrets": [],
+  "declarations": []
 }
diff --git a/test/output/await-in-function.js.json b/test/output/await-in-function.js.json
@@ -60,5 +60,6 @@
   ],
   "fileAttachments": [],
   "databaseClients": [],
-  "secrets": []
+  "secrets": [],
+  "declarations": []
 }
diff --git a/test/output/await-in-markdown.md.json b/test/output/await-in-markdown.md.json
@@ -88,5 +88,6 @@
   ],
   "fileAttachments": [],
   "databaseClients": [],
-  "secrets": []
+  "secrets": [],
+  "declarations": []
 }
diff --git a/test/output/await-yield.js.json b/test/output/await-yield.js.json
@@ -61,5 +61,6 @@
   ],
   "fileAttachments": [],
   "databaseClients": [],
-  "secrets": []
+  "secrets": [],
+  "declarations": []
 }
diff --git a/test/output/backslash-after-dollar-markdown.md.json b/test/output/backslash-after-dollar-markdown.md.json
@@ -52,5 +52,6 @@
   "references": [],
   "fileAttachments": [],
   "databaseClients": [],
-  "secrets": []
+  "secrets": [],
+  "declarations": []
 }
diff --git a/test/output/backslash-before-dollar-markdown.md.json b/test/output/backslash-before-dollar-markdown.md.json
@@ -52,5 +52,6 @@
   "references": [],
   "fileAttachments": [],
   "databaseClients": [],
-  "secrets": []
+  "secrets": [],
+  "declarations": []
 }
diff --git a/test/output/backslash-markdown.md.json b/test/output/backslash-markdown.md.json
@@ -52,5 +52,6 @@
   "references": [],
   "fileAttachments": [],
   "databaseClients": [],
-  "secrets": []
+  "secrets": [],
+  "declarations": []
 }
diff --git a/test/output/bare-dynamic-import.js.json b/test/output/bare-dynamic-import.js.json
@@ -20,5 +20,6 @@
   "references": [],
   "fileAttachments": [],
   "databaseClients": [],
-  "secrets": []
+  "secrets": [],
+  "declarations": []
 }
diff --git a/test/output/basic.db.sql.json b/test/output/basic.db.sql.json
@@ -119,5 +119,6 @@
   ],
   "fileAttachments": [],
   "databaseClients": [],
-  "secrets": []
+  "secrets": [],
+  "declarations": []
 }
diff --git a/test/output/basic.html.json b/test/output/basic.html.json
@@ -89,5 +89,6 @@
   ],
   "fileAttachments": [],
   "databaseClients": [],
-  "secrets": []
+  "secrets": [],
+  "declarations": []
 }
diff --git a/test/output/basic.sql.json b/test/output/basic.sql.json
@@ -88,5 +88,6 @@
   ],
   "fileAttachments": [],
   "databaseClients": [],
-  "secrets": []
+  "secrets": [],
+  "declarations": []
 }
diff --git a/test/output/basic.tex.json b/test/output/basic.tex.json
@@ -110,5 +110,6 @@
   ],
   "fileAttachments": [],
   "databaseClients": [],
-  "secrets": []
+  "secrets": [],
+  "declarations": []
 }
diff --git a/test/output/bigint-zero.js.json b/test/output/bigint-zero.js.json
@@ -16,5 +16,6 @@
   "references": [],
   "fileAttachments": [],
   "databaseClients": [],
-  "secrets": []
+  "secrets": [],
+  "declarations": []
 }
diff --git a/test/output/bigint.js.json b/test/output/bigint.js.json
@@ -35,5 +35,6 @@
   ],
   "fileAttachments": [],
   "databaseClients": [],
-  "secrets": []
+  "secrets": [],
+  "declarations": []
 }
diff --git a/test/output/binary-expression.js.json b/test/output/binary-expression.js.json
@@ -34,5 +34,6 @@
   ],
   "fileAttachments": [],
   "databaseClients": [],
-  "secrets": []
+  "secrets": [],
+  "declarations": []
 }
diff --git a/test/output/block-leading-comment.js.json b/test/output/block-leading-comment.js.json
@@ -32,5 +32,13 @@
   "references": [],
   "fileAttachments": [],
   "databaseClients": [],
-  "secrets": []
+  "secrets": [],
+  "declarations": [
+    {
+      "type": "Identifier",
+      "start": 21,
+      "end": 24,
+      "name": "foo"
+    }
+  ]
 }
diff --git a/test/output/block-trailing-comment.js.json b/test/output/block-trailing-comment.js.json
@@ -32,5 +32,13 @@
   "references": [],
   "fileAttachments": [],
   "databaseClients": [],
-  "secrets": []
+  "secrets": [],
+  "declarations": [
+    {
+      "type": "Identifier",
+      "start": 0,
+      "end": 3,
+      "name": "foo"
+    }
+  ]
 }
diff --git a/test/output/catch-clause.js.json b/test/output/catch-clause.js.json
@@ -125,5 +125,6 @@
   ],
   "fileAttachments": [],
   "databaseClients": [],
-  "secrets": []
+  "secrets": [],
+  "declarations": []
 }
diff --git a/test/output/comment.js.json b/test/output/comment.js.json
@@ -9,5 +9,6 @@
   "references": [],
   "fileAttachments": [],
   "databaseClients": [],
-  "secrets": []
+  "secrets": [],
+  "declarations": []
 }
diff --git a/test/output/computed-property-name.js.json b/test/output/computed-property-name.js.json
@@ -60,5 +60,6 @@
   ],
   "fileAttachments": [],
   "databaseClients": [],
-  "secrets": []
+  "secrets": [],
+  "declarations": []
 }
diff --git a/test/output/database-client.js.json b/test/output/database-client.js.json
@@ -72,5 +72,6 @@
       ]
     ]
   ],
-  "secrets": []
+  "secrets": [],
+  "declarations": []
 }
diff --git a/test/output/destructure-array-literal.js.json b/test/output/destructure-array-literal.js.json
@@ -59,5 +59,19 @@
   "references": [],
   "fileAttachments": [],
   "databaseClients": [],
-  "secrets": []
+  "secrets": [],
+  "declarations": [
+    {
+      "type": "Identifier",
+      "start": 2,
+      "end": 5,
+      "name": "foo"
+    },
+    {
+      "type": "Identifier",
+      "start": 10,
+      "end": 13,
+      "name": "bar"
+    }
+  ]
 }