Add heading option to match custom headings

Closes GH-17.

Author: nnmrts

fixtures/match-heading/expected.md

@@ -0,0 +1,8 @@
+# Example
+
+## Mitwirkende
+
+| Name      | Website                 |
+| --------- | ----------------------- |
+| **Sara**  | <https://example.com#1> |
+| **Alice** | <https://example.com#2> |

fixtures/match-heading/index.md

@@ -0,0 +1,3 @@
+# Example
+
+## Mitwirkende

fixtures/match-heading/package.json

@@ -0,0 +1,6 @@
+{
+  "contributors": [
+    "Sara (https://example.com#1)",
+    "Alice (https://example.com#2)"
+  ]
+}

index.js

@@ -16,6 +16,7 @@ function contributors(options) {
   var align = settings.align || null
   var defaultContributors = settings.contributors
   var formatters = createFormatters(settings.formatters)
+  var contributorsHeading = settings.heading || 'contributors'
 
   return transform
 
@@ -88,7 +89,7 @@ function contributors(options) {
       var table = createTable(contributors, formatters, align)
       var headingFound = false
 
-      heading(tree, 'contributors', onheading)
+      heading(tree, contributorsHeading, onheading)
 
       // Add the section if not found but with `appendIfMissing`.
       if (!headingFound && settings.appendIfMissing) {

readme.md

@@ -84,7 +84,7 @@ MIT
 
 Inject a given list of contributors.
 
-*   Looks for the first heading containing `'Contributors'` (case insensitive)
+*   Looks for the first heading matching `/^contributors$/i` or `options.heading`
 *   If no heading is found and `appendIfMissing` is set, inject such a heading
 *   Replaces the table in that section if there is one, or injects it otherwise
 
@@ -107,6 +107,10 @@ default: `null`).
 
 Inject the section if there is none (`boolean`, default: `false`).
 
+###### `options.heading`
+
+Heading to look for (`string` (case-insensitive) or `RegExp`, default: `'contributors'`).
+
 ###### `options.formatters`
 
 Map of fields found in `contributors` to formatters (`Object.<Formatter>`).

test.js

@@ -16,7 +16,7 @@ try {
 test.onFinish(ondone)
 
 test('remark-contributors', function (t) {
-  t.plan(15)
+  t.plan(17)
 
   remark()
     .use(gfm)
@@ -393,6 +393,44 @@ test('remark-contributors', function (t) {
         )
       }
     )
+
+  remark()
+    .use(gfm)
+    .use(contributors, {
+      heading: /^mitwirkende$/i
+    })
+    .process(
+      read(path.join('fixtures', 'match-heading', 'index.md')),
+      function (err, file) {
+        t.deepEqual(
+          [err, String(file)],
+          [
+            null,
+            String(read(path.join('fixtures', 'match-heading', 'expected.md')))
+          ],
+          'should match custom heading if `heading` option is passed a regex'
+        )
+      }
+    )
+
+  remark()
+    .use(gfm)
+    .use(contributors, {
+      heading: 'mitwirkende'
+    })
+    .process(
+      read(path.join('fixtures', 'match-heading', 'index.md')),
+      function (err, file) {
+        t.deepEqual(
+          [err, String(file)],
+          [
+            null,
+            String(read(path.join('fixtures', 'match-heading', 'expected.md')))
+          ],
+          'should match custom heading if `heading` option is passed a string'
+        )
+      }
+    )
 })
 
 function read(fp) {