Fix handling of images to match GitHub

Author: wooorm

lib/search.js

@@ -1,5 +1,5 @@
 import Slugger from 'github-slugger'
-import toString from 'mdast-util-to-string'
+import {toString} from 'mdast-util-to-string'
 import {visit} from 'unist-util-visit'
 import {convert} from 'unist-util-is'
 import {toExpression} from './to-expression.js'
@@ -30,7 +30,7 @@ export function search(root, expression, settings) {
   }
 
   function onheading(node, position, parent) {
-    const value = toString(node)
+    const value = toString(node, {includeImageAlt: false})
     // Remove this when `remark-attr` is up to date w/ micromark.
     /* c8 ignore next */
     const id = node.data && node.data.hProperties && node.data.hProperties.id
@@ -52,9 +52,8 @@ export function search(root, expression, settings) {
       endIndex = position
     }
 
-    // A non-empty heading after the closing (if we were looking for one).
+    // A heading after the closing (if we were looking for one).
     if (
-      value &&
       (endIndex || !expression) &&
       (!settings.maxDepth || node.depth <= settings.maxDepth) &&
       (!skip || !skip.test(value))

package.json

@@ -39,7 +39,7 @@
     "@types/unist": "^2.0.3",
     "extend": "^3.0.2",
     "github-slugger": "^1.2.1",
-    "mdast-util-to-string": "^2.0.0",
+    "mdast-util-to-string": "^3.1.0",
     "unist-util-is": "^5.0.0",
     "unist-util-visit": "^3.0.0"
   },

readme.md

@@ -67,9 +67,8 @@ There is no default export.
 
 Generate a Table of Contents from a [tree][].
 
-Looks for the first [heading][] matching `options.heading` (case insensitive,
-supports alt/title attributes for links and images too), and returns a table
-of contents ([list][]) for all following headings.
+Looks for the first [heading][] matching `options.heading` (case insensitive),
+and returns a table of contents ([list][]) for all following headings.
 If no `heading` is specified, creates a table of contents for all headings in
 `tree`.
 `tree` is not changed.

test/fixtures/empty-headings/output.json

@@ -1,5 +1,52 @@
 {
   "index": null,
   "endIndex": null,
-  "map": null
+  "map": {
+    "type": "list",
+    "ordered": false,
+    "spread": false,
+    "children": [
+      {
+        "type": "listItem",
+        "spread": false,
+        "children": [
+          {
+            "type": "paragraph",
+            "children": [
+              {
+                "type": "link",
+                "title": null,
+                "url": "#",
+                "children": []
+              }
+            ]
+          }
+        ]
+      },
+      {
+        "type": "listItem",
+        "spread": false,
+        "children": [
+          {
+            "type": "paragraph",
+            "children": [
+              {
+                "type": "link",
+                "title": null,
+                "url": "#-1",
+                "children": [
+                  {
+                    "type": "image",
+                    "title": null,
+                    "url": "an-image.svg",
+                    "alt": ""
+                  }
+                ]
+              }
+            ]
+          }
+        ]
+      }
+    ]
+  }
 }

test/fixtures/phrasing-content/output.json

@@ -215,7 +215,7 @@
               {
                 "type": "link",
                 "title": null,
-                "url": "#image",
+                "url": "#",
                 "children": [
                   {
                     "type": "image",
@@ -239,14 +239,14 @@
               {
                 "type": "link",
                 "title": null,
-                "url": "#image-reference",
+                "url": "#-1",
                 "children": [
                   {
                     "type": "imageReference",
+                    "alt": "image reference",
                     "identifier": "image",
                     "label": "image",
-                    "referenceType": "full",
-                    "alt": "image reference"
+                    "referenceType": "full"
                   }
                 ]
               }
@@ -286,14 +286,14 @@
               {
                 "type": "link",
                 "title": null,
-                "url": "#link-reference",
+                "url": "#-2",
                 "children": [
                   {
                     "type": "imageReference",
+                    "alt": "link reference",
                     "identifier": "link",
                     "label": "link",
-                    "referenceType": "full",
-                    "alt": "link reference"
+                    "referenceType": "full"
                   }
                 ]
               }

test/fixtures/slug-for-images-and-links/output.json

@@ -41,7 +41,7 @@
                       {
                         "type": "link",
                         "title": null,
-                        "url": "#something-else",
+                        "url": "#",
                         "children": [
                           {
                             "type": "image",
@@ -65,7 +65,7 @@
                       {
                         "type": "link",
                         "title": null,
-                        "url": "#something-elsefi",
+                        "url": "#-1",
                         "children": [
                           {
                             "type": "image",
@@ -93,7 +93,7 @@
               {
                 "type": "link",
                 "title": null,
-                "url": "#another-title",
+                "url": "#-2",
                 "children": [
                   {
                     "type": "image",