Change to default to tight: true

Author: wooorm

lib/index.js

@@ -5,9 +5,6 @@
 
 import {toc} from 'mdast-util-toc'
 
-/** @type {Readonly<Options>} */
-const emptyOptions = {}
-
 /**
  * Generate a table of contents (TOC).
  *
@@ -22,10 +19,10 @@ const emptyOptions = {}
  *   Transform.
  */
 export default function remarkToc(options) {
-  let settings = options || emptyOptions
-
-  if (!settings.heading) {
-    settings = {...settings, heading: 'toc|table[ -]of[ -]contents?'}
+  const settings = {
+    ...options,
+    heading: (options && options.heading) || 'toc|table[ -]of[ -]contents?',
+    tight: options && typeof options.tight === 'boolean' ? options.tight : true
   }
 
   /**

readme.md

@@ -122,7 +122,7 @@ import remarkToc from 'remark-toc'
 import {read} from 'to-vfile'
 
 const file = await remark()
-  .use(remarkToc, {heading: 'contents', tight: true})
+  .use(remarkToc, {heading: 'contents'})
   .process(await read('example.md'))
 
 console.error(String(file))
@@ -206,7 +206,7 @@ Configuration (TypeScript type).
 *   `parents` ([`Test` from `unist-util-is`][unist-util-is-test], default:
     `tree`)
     — allow headings to be children of certain node types
-*   `tight` (`boolean`, default: `false`)
+*   `tight` (`boolean`, default: `true`)
     — whether to compile list items tightly, otherwise space is added around
     items
 *   `ordered` (`boolean`, default: `false`)
@@ -259,11 +259,15 @@ so:
 …that would generate the following list:
 
 ```markdown
-1. [Bravo](#bravo)
+1. [History](#history)
 
-   1. [Charlie](#charlie)
+   1. [Discovery](#discovery)
 
-2. [Delta](#delta)
+   2. [Name and symbol](#name-and-symbol)
+
+   3. [Planet X disproved](#planet-x-disproved)
+
+2. [Orbit](#orbit)
 ```
 
 ### Example: including and excluding headings
@@ -306,9 +310,11 @@ generated list:
 …that would generate the following list:
 
 ```markdown
-* [Bravo](#user-content-bravo)
-  * [Charlie](#user-content-charlie)
-* [Delta](#user-content-delta)
+* [History](#user-content-history)
+  * [Discovery](#user-content-discovery)
+  * [Name and symbol](#user-content-name-and-symbol)
+  * [Planet X disproved](#user-content-planet-x-disproved)
+* [Orbit](#user-content-orbit)
 ```
 
 ## Types

test/fixtures/custom-heading/output.md

@@ -3,10 +3,8 @@
 ## Fooooo
 
 * [Something if](#something-if)
-
   * [Something else](#something-else)
   * [Something elsefi](#something-elsefi)
-
 * [Something iffi](#something-iffi)
 
 # Something if

test/fixtures/loose/config.json

@@ -0,0 +1,3 @@
+{
+  "tight": false
+}

test/fixtures/loose/input.md

@@ -0,0 +1,17 @@
+# Normal
+
+## Table of Contents
+
+# Something if
+
+## Something else
+
+Text.
+
+## Something elsefi
+
+### Yet Another Thing
+
+### And another thing
+
+# Something iffi

test/fixtures/loose/output.md

@@ -0,0 +1,28 @@
+# Normal
+
+## Table of Contents
+
+* [Something if](#something-if)
+
+  * [Something else](#something-else)
+
+  * [Something elsefi](#something-elsefi)
+
+    * [Yet Another Thing](#yet-another-thing)
+    * [And another thing](#and-another-thing)
+
+* [Something iffi](#something-iffi)
+
+# Something if
+
+## Something else
+
+Text.
+
+## Something elsefi
+
+### Yet Another Thing
+
+### And another thing
+
+# Something iffi

test/fixtures/maximum-depth-3/output.md

@@ -3,9 +3,7 @@
 # Table of Contents
 
 * [Alpha](#alpha)
-
   * [Bravo](#bravo)
-
     * [Charlie](#charlie)
 
 # Alpha

test/fixtures/maximum-depth-6/output.md

@@ -3,15 +3,10 @@
 # Table of Contents
 
 * [Alpha](#alpha)
-
   * [Bravo](#bravo)
-
     * [Charlie](#charlie)
-
       * [Delta](#delta)
-
         * [Echo](#echo)
-
           * [Foxtrot](#foxtrot)
 
 # Alpha

test/fixtures/normal-content/output.md

@@ -3,10 +3,8 @@
 ## Table of Contents
 
 * [Something if](#something-if)
-
   * [Something else](#something-else)
   * [Something elsefi](#something-elsefi)
-
 * [Something iffi](#something-iffi)
 
 # Something if

test/fixtures/normal-dashes/output.md

@@ -3,10 +3,8 @@
 ## Table-of-contents
 
 * [Something if](#something-if)
-
   * [Something else](#something-else)
   * [Something elsefi](#something-elsefi)
-
 * [Something iffi](#something-iffi)
 
 # Something if