Add support for hiding positions

Closes GH-10.
Closes GH-12.

Reviewed-by: Christian Murphy <christian.murphy.42@gmail.com>

Author: wooorm

index.js

@@ -29,7 +29,14 @@ function noColor(node) {
 }
 
 // Inspects a node.
-function inspect(node) {
+function inspect(node, options) {
+  var settings = options || {}
+  var showPositions = settings.showPositions
+
+  if (showPositions === null || showPositions === undefined) {
+    showPositions = true
+  }
+
   return inspectValue(node, '')
 
   function inspectValue(node, pad) {
@@ -85,7 +92,9 @@ function inspect(node) {
     var result = [node.type]
     var kind = node.tagName || node.name
     var position = node.position || {}
-    var location = stringifyPosition(position.start, position.end)
+    var location = showPositions
+      ? stringifyPosition(position.start, position.end)
+      : ''
     var attributes = []
     var key
     var value

package.json

@@ -62,8 +62,8 @@
     "build": "npm run build-bundle && npm run build-mangle",
     "test-api": "node test",
     "test-coverage": "nyc --reporter lcov tape test.js",
-    "test": "npm run format && npm run build && npm run test-coverage",
-    "dtslint": "dtslint types"
+    "test-types": "dtslint types",
+    "test": "npm run format && npm run build && npm run test-coverage && npm run test-types"
   },
   "prettier": {
     "tabWidth": 2,

readme.md

@@ -49,25 +49,26 @@ root[2]
 
 ## API
 
-### `inspect(node)`
+### `inspect(node[, options])`
 
-By default, color support is enabled in Node.js and turned off anywhere else.
+Inspect the given [`node`][node].
+By default, colors are added in Node, and not in other places.
 See below on how to change that.
 
-###### Parameters
+###### `options.showPositions`
 
-*   `node` ([`Node`][node]).
+Whether to include positional information (`boolean`, default: `true`).
 
 ###### Returns
 
 `string` — String representing `node`.
 
-### `inspect.<style>[.<style>…](node)`
+### `inspect.<style>[.<style>…](node[, options])`
 
 Where `<style>` is either `color` or `noColor`.
 
-To explicitly add or remove ANSI sequences, use either `inspect.color(node)`
-or `inspect.noColor(node)`.
+To explicitly add or remove ANSI sequences, use `inspect.color(node)` or
+`inspect.noColor(node)`.
 
 ## Contribute
 

test.js

@@ -235,6 +235,35 @@ test('inspect()', function (t) {
     'should work with just `offset` in `position`'
   )
 
+  t.equal(
+    strip(inspect(retext().parse(paragraph), {showPositions: false})),
+    [
+      'RootNode[1]',
+      '└─ ParagraphNode[3]',
+      '   ├─ SentenceNode[6]',
+      '   │  ├─ WordNode[1]',
+      '   │  │  └─ TextNode: "Some"',
+      '   │  ├─ WhiteSpaceNode: " "',
+      '   │  ├─ WordNode[1]',
+      '   │  │  └─ TextNode: "simple"',
+      '   │  ├─ WhiteSpaceNode: " "',
+      '   │  ├─ WordNode[1]',
+      '   │  │  └─ TextNode: "text"',
+      '   │  └─ PunctuationNode: "."',
+      '   ├─ WhiteSpaceNode: " "',
+      '   └─ SentenceNode[6]',
+      '      ├─ WordNode[1]',
+      '      │  └─ TextNode: "Other"',
+      '      ├─ WhiteSpaceNode: " "',
+      '      ├─ PunctuationNode: "“"',
+      '      ├─ WordNode[1]',
+      '      │  └─ TextNode: "sentence"',
+      '      ├─ PunctuationNode: "”"',
+      '      └─ PunctuationNode: "."'
+    ].join('\n'),
+    'should support `showPositions: false`'
+  )
+
   t.end()
 })
 

types/index.d.ts

@@ -1,27 +1,45 @@
 // TypeScript Version: 3.0
 import {Node} from 'unist'
 
-export = inpect
+declare namespace unistUtilInspect {
+  interface UnistUtilInspectOptions {
+    /**
+     * Whether to include position information.
+     *
+     * @defaultValue true
+     */
+    showPositions?: boolean
+  }
 
-/*
- * Unist utility to inspect the details of a Unist Node
- *
- * @param node Node to inspect
- */
-declare function inpect(node: Node): string
-
-declare namespace inpect {
   /**
    * Inspect the given Node and include colors from the results
    *
    * @param node Node to inspect
+   * @param options Configuration
    */
-  function color(node: Node): string
+  function color(node: Node, options?: Partial<UnistUtilInspectOptions>): string
 
   /**
    * Inspect the given Node and exclude colors from the results
    *
    * @param node Node to inspect
+   * @param options Configuration
    */
-  function noColor(node: Node): string
+  function noColor(
+    node: Node,
+    options?: Partial<UnistUtilInspectOptions>
+  ): string
 }
+
+/*
+ * Unist utility to inspect the details of a Unist Node
+ *
+ * @param node Node to inspect
+ * @param options Configuration
+ */
+declare function unistUtilInspect(
+  node: Node,
+  options?: Partial<unistUtilInspect.UnistUtilInspectOptions>
+): string
+
+export = unistUtilInspect

types/tsconfig.json

@@ -1,10 +1,12 @@
 {
   "compilerOptions": {
-      "lib": ["es2015"],
-      "strict": true,
-      "baseUrl": ".",
-      "paths": {
-          "unist-util-inspect": ["index.d.ts"]
-      }
+    "lib": ["es2015"],
+    "strict": true,
+    "baseUrl": ".",
+    "paths": {
+      "unist-util-inspect": [
+        "index.d.ts"
+      ]
+    }
   }
 }

types/tslint.json

@@ -1,3 +1,7 @@
 {
-  "extends": "dtslint/dtslint.json"
+  "extends": "dtslint/dtslint.json",
+  "rules": {
+    "semicolon": false,
+    "whitespace": false
+  }
 }

types/unist-util-inspect-tests.ts

@@ -28,3 +28,7 @@ const node = {
 }
 
 const result: string = inspect(node)
+
+const noColor: string = inspect.noColor(node)
+
+const noPositions: string = inspect(node, {showPositions: false})