Refactor code-style

Author: wooorm

.prettierignore

@@ -0,0 +1,3 @@
+coverage/
+mdast-util-heading-range.js
+mdast-util-heading-range.min.js

index.js

@@ -1,81 +1,82 @@
-'use strict';
+'use strict'
 
-var toString = require('mdast-util-to-string');
+var toString = require('mdast-util-to-string')
 
-module.exports = headingRange;
+module.exports = headingRange
 
-var splice = [].splice;
+var splice = [].splice
 
-/* Search `node` with `options` and invoke `callback`. */
+// Search `node` with `options` and invoke `callback`.
 function headingRange(node, options, callback) {
-  var test = options;
-  var ignoreFinalDefinitions = false;
+  var test = options
+  var ignoreFinalDefinitions = false
 
-  /* Object, not regex. */
+  // Object, not regex.
   if (test && typeof test === 'object' && !('exec' in test)) {
-    ignoreFinalDefinitions = test.ignoreFinalDefinitions === true;
-    test = test.test;
+    ignoreFinalDefinitions = test.ignoreFinalDefinitions === true
+    test = test.test
   }
 
   if (typeof test === 'string') {
-    test = toExpression(test);
+    test = toExpression(test)
   }
 
-  /* Regex */
+  // Regex
   if (test && 'exec' in test) {
-    test = wrapExpression(test);
+    test = wrapExpression(test)
   }
 
   if (typeof test !== 'function') {
     throw new Error(
-      'Expected `string`, `regexp`, or `function` for `test`, ' +
-      'not `' + test + '`'
-    );
+      'Expected `string`, `regexp`, or `function` for `test`, not `' +
+        test +
+        '`'
+    )
   }
 
-  search(node, test, ignoreFinalDefinitions, callback);
+  search(node, test, ignoreFinalDefinitions, callback)
 }
 
-/* Search a node for heading range. */
+// Search a node for heading range.
 function search(root, test, skip, callback) {
-  var index = -1;
-  var children = root.children;
-  var length = children.length;
-  var depth = null;
-  var start = null;
-  var end = null;
-  var nodes;
-  var clean;
-  var child;
+  var index = -1
+  var children = root.children
+  var length = children.length
+  var depth = null
+  var start = null
+  var end = null
+  var nodes
+  var clean
+  var child
 
   while (++index < length) {
-    child = children[index];
+    child = children[index]
 
     if (closing(child, depth)) {
-      end = index;
-      break;
+      end = index
+      break
     }
 
     if (opening(child, depth, test)) {
-      start = index;
-      depth = child.depth;
+      start = index
+      depth = child.depth
     }
   }
 
   if (start !== null) {
     if (end === null) {
-      end = length;
+      end = length
     }
 
     if (skip) {
       while (end > start) {
-        child = children[end - 1];
+        child = children[end - 1]
 
         if (!definition(child)) {
-          break;
+          break
         }
 
-        end--;
+        end--
       }
     }
 
@@ -88,57 +89,56 @@ function search(root, test, skip, callback) {
         start: start,
         end: children[end] ? end : null
       }
-    );
+    )
 
-    clean = [];
-    index = -1;
-    length = nodes && nodes.length;
+    clean = []
+    index = -1
+    length = nodes && nodes.length
 
-    /* Ensure no empty nodes are inserted. This could
-     * be the case if `end` is in `nodes` but no `end`
-     * node exists. */
+    // Ensure no empty nodes are inserted.  This could be the case if `end` is
+    // in `nodes` but no `end` node exists.
     while (++index < length) {
       if (nodes[index]) {
-        clean.push(nodes[index]);
+        clean.push(nodes[index])
       }
     }
 
     if (nodes) {
-      splice.apply(children, [start, end - start + 1].concat(clean));
+      splice.apply(children, [start, end - start + 1].concat(clean))
     }
   }
 }
 
-/* Transform a string into an applicable expression. */
+// Transform a string into an applicable expression.
 function toExpression(value) {
-  return new RegExp('^(' + value + ')$', 'i');
+  return new RegExp('^(' + value + ')$', 'i')
 }
 
-/* Wrap an expression into an assertion function. */
+// Wrap an expression into an assertion function.
 function wrapExpression(expression) {
-  return assertion;
+  return assertion
 
-  /* Assert `value` matches the bound `expression`. */
+  // Assert `value` matches the bound `expression`.
   function assertion(value) {
-    return expression.test(value);
+    return expression.test(value)
   }
 }
 
-/* Check if `node` is a heading. */
+// Check if `node` is a heading.
 function heading(node) {
-  return node && node.type === 'heading';
+  return node && node.type === 'heading'
 }
 
-/* Check if `node` is the main heading. */
+// Check if `node` is the main heading.
 function opening(node, depth, test) {
-  return depth === null && heading(node) && test(toString(node), node);
+  return depth === null && heading(node) && test(toString(node), node)
 }
 
-/* Check if `node` is the next heading. */
+// Check if `node` is the next heading.
 function closing(node, depth) {
-  return depth && heading(node) && node.depth <= depth;
+  return depth && heading(node) && node.depth <= depth
 }
 
 function definition(node) {
-  return node.type === 'definition' || node.type === 'footnoteDefinition';
+  return node.type === 'definition' || node.type === 'footnoteDefinition'
 }

package.json

@@ -24,40 +24,48 @@
   },
   "devDependencies": {
     "browserify": "^16.0.0",
-    "esmangle": "^1.0.0",
     "nyc": "^13.0.0",
+    "prettier": "^1.14.3",
     "remark": "^10.0.0",
     "remark-cli": "^6.0.0",
     "remark-preset-wooorm": "^4.0.0",
     "tape": "^4.4.0",
+    "tinyify": "^2.4.3",
     "xo": "^0.23.0"
   },
   "scripts": {
-    "build-md": "remark . --quiet --frail --output",
-    "build-bundle": "browserify index.js --no-builtins -s mdastUtilHeadingRange > mdast-util-heading-range.js",
-    "build-mangle": "esmangle mdast-util-heading-range.js > mdast-util-heading-range.min.js",
-    "build": "npm run build-md && npm run build-bundle && npm run build-mangle",
-    "lint": "xo",
-    "test-api": "node test.js",
+    "format": "remark . -qfo && prettier --write '**/*.js' && xo --fix",
+    "build-bundle": "browserify . -s mdastUtilHeadingRange > mdast-util-heading-range.js",
+    "build-mangle": "browserify . -s mdastUtilHeadingRange -p tinyify > mdast-util-heading-range.min.js",
+    "build": "npm run build-bundle && npm run build-mangle",
+    "test-api": "node test",
     "test-coverage": "nyc --reporter lcov tape test.js",
-    "test": "npm run build && npm run lint && npm run test-coverage"
+    "test": "npm run format && npm run build && npm run test-coverage"
+  },
+  "nyc": {
+    "check-coverage": true,
+    "lines": 100,
+    "functions": 100,
+    "branches": 100
+  },
+  "prettier": {
+    "tabWidth": 2,
+    "useTabs": false,
+    "singleQuote": true,
+    "bracketSpacing": false,
+    "semi": false,
+    "trailingComma": "none"
   },
   "xo": {
-    "space": true,
+    "prettier": true,
     "esnext": false,
     "rules": {
       "unicorn/prefer-type-error": "off"
     },
-    "ignore": [
+    "ignores": [
       "mdast-util-heading-range.js"
     ]
   },
-  "nyc": {
-    "check-coverage": true,
-    "lines": 100,
-    "functions": 100,
-    "branches": 100
-  },
   "remarkConfig": {
     "plugins": [
       "preset-wooorm"

readme.md

@@ -25,28 +25,30 @@ Bar.
 And our script, `example.js`, looks as follows:
 
 ```javascript
-var vfile = require('to-vfile');
-var remark = require('remark');
-var heading = require('mdast-util-heading-range');
+var vfile = require('to-vfile')
+var remark = require('remark')
+var heading = require('mdast-util-heading-range')
 
 remark()
   .use(plugin)
-  .process(vfile.readSync('example.md'), function (err, file) {
-    if (err) throw err;
-    console.log(String(file));
-  });
+  .process(vfile.readSync('example.md'), function(err, file) {
+    if (err) throw err
+    console.log(String(file))
+  })
 
 function plugin() {
-  return transformer;
-  function transformer(tree) {
-    heading(tree, 'foo', mutate);
+  return transform
+
+  function transform(tree) {
+    heading(tree, 'foo', mutate)
   }
+
   function mutate(start, nodes, end) {
     return [
       start,
       {type: 'paragraph', children: [{type: 'text', value: 'Qux.'}]},
       end
-    ];
+    ]
   }
 }
 ```
@@ -71,14 +73,17 @@ A Section is a heading that passes `test`, until the next heading of the same
 or lower depth, or the end of the document.  If `ignoreFinalDefinitions: true`,
 final definitions “in” the section are excluded.
 
-###### `options`
+##### `options`
+
+###### `options.test`
 
-*   `test` (`string`, `RegExp`, [`Function`][test])
-    — Heading to look for.
-    When `string`, wrapped in `new RegExp('^(' + value + ')$', 'i')`;
-    when `RegExp`, wrapped in `function (value) {expression.test(value)}`
-*   `ignoreFinalDefinitions` (`boolean`, default: `false`)
-    — Ignore final definitions otherwise in the section
+Heading to look for (`string`, `RegExp`, [`Function`][test]).
+When `string`, wrapped in `new RegExp('^(' + value + ')$', 'i')`;
+when `RegExp`, wrapped in `function (value) {expression.test(value)}`
+
+###### `options.ignoreFinalDefinitions`
+
+Ignore final definitions otherwise in the section (`boolean`, default: `false`).
 
 #### `function test(value, node)`
 
@@ -93,16 +98,27 @@ itself ([`Heading`][heading]) to check if it’s the one to look for.
 
 Callback invoked when a range is found.
 
-###### Parameters
+##### Parameters
+
+###### `start`
+
+Start of range ([`Heading`][heading]).
+
+###### `nodes`
+
+Nodes between `start` and `end` ([`Array.<Node>`][node]).
+
+###### `end`
+
+End of range, if any ([`Node?`][node]).
+
+###### `scope`
 
-*   `start` ([`Heading`][heading]) — Start of range
-*   `nodes` ([`Array.<Node>`][node]) — Nodes between `start` and `end`
-*   `end` ([`Node?`][node]) — End of range, if any
-*   `scope` (`Object`):
+Extra info (`Object`):
 
-    *   `parent` ([`Node`][node]) — Parent of the range
-    *   `start` (`number`) — Index of `start` in `parent`
-    *   `end` (`number?`) — Index of `end` in `parent`
+*   `parent` ([`Node`][node]) — Parent of the range
+*   `start` (`number`) — Index of `start` in `parent`
+*   `end` (`number?`) — Index of `end` in `parent`
 
 ## Contribute