Refactor to shout less

Author: wooorm

index.js

@@ -9,15 +9,13 @@ var whitespace = require('hast-util-whitespace')
 var textContent = require('hast-util-to-string')
 var is = require('hast-util-is-element')
 
-module.exports = toNLCST
+module.exports = toNlcst
 
-// Elements representing source.
-var SOURCE = ['code']
-var IGNORE = ['script', 'style', 'svg', 'math', 'del']
-var EXPLICIT = ['p', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6']
+var source = ['code']
+var ignore = ['script', 'style', 'svg', 'math', 'del']
+var explicit = ['p', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6']
 
-// Constants.
-var FLOW_ACCEPTING = [
+var flowAccepting = [
   'body',
   'article',
   'section',
@@ -43,8 +41,8 @@ var FLOW_ACCEPTING = [
   'dialog'
 ]
 
-// Transform `tree` to `nlcst`.
-function toNLCST(tree, file, Parser) {
+// Transform `tree` to nlcst.
+function toNlcst(tree, file, Parser) {
   var parser
   var location
   var results
@@ -72,8 +70,8 @@ function toNLCST(tree, file, Parser) {
   doc = String(file)
   parser = 'parse' in Parser ? Parser : new Parser()
 
-  // Transform HAST into NLCST tokens, and pass these into `parser.parse` to
-  // insert sentences, paragraphs where needed.
+  // Transform hast to nlcst, and pass these into `parser.parse` to insert
+  // sentences, paragraphs where needed.
   results = []
 
   find(tree)
@@ -93,12 +91,11 @@ function toNLCST(tree, file, Parser) {
     if (node.type === 'root') {
       findAll(children)
     } else if (is(node) && !ignored(node)) {
-      if (is(node, EXPLICIT)) {
+      if (is(node, explicit)) {
         // Explicit paragraph.
         add(node)
-      } else if (is(node, FLOW_ACCEPTING)) {
-        // Slightly simplified version of:
-        // https://html.spec.whatwg.org/#paragraphs
+      } else if (is(node, flowAccepting)) {
+        // Slightly simplified version of: <https://html.spec.whatwg.org/#paragraphs>.
         implicit(flattenAll(children))
       } else {
         // Dig deeper.
@@ -210,7 +207,7 @@ function toNLCST(tree, file, Parser) {
     return patch(replacement, location, location.toOffset(position.start(node)))
   }
 
-  // Convert all `children` (HAST) to NLCST.
+  // Convert all `children` (hast) to nlcst.
   function all(children) {
     var length = children && children.length
     var index = -1
@@ -228,10 +225,10 @@ function toNLCST(tree, file, Parser) {
     return result
   }
 
-  // Patch a position on each node in `nodes`.  `offset` is the offset in
-  // `file` this run of content starts at.
+  // Patch a position on each node in `nodes`.
+  // `offset` is the offset in `file` this run of content starts at.
   //
-  // Note that NLCST nodes are concrete, meaning that their starting and ending
+  // Note that nlcst nodes are concrete, meaning that their starting and ending
   // positions can be inferred from their content.
   function patch(nodes, location, offset) {
     var length = nodes.length
@@ -265,10 +262,10 @@ function toNLCST(tree, file, Parser) {
 
 function sourced(node) {
   var props = node.properties
-  return is(node) && (is(node, SOURCE) || props.dataNlcst === 'source')
+  return is(node) && (is(node, source) || props.dataNlcst === 'source')
 }
 
 function ignored(node) {
   var props = node.properties
-  return is(node) && (is(node, IGNORE) || props.dataNlcst === 'ignore')
+  return is(node) && (is(node, ignore) || props.dataNlcst === 'ignore')
 }

package.json

@@ -1,7 +1,7 @@
 {
   "name": "hast-util-to-nlcst",
   "version": "1.2.4",
-  "description": "Transform HAST to NLCST",
+  "description": "Transform hast to nlcst",
   "license": "MIT",
   "keywords": [
     "hast",
@@ -50,8 +50,8 @@
   },
   "scripts": {
     "format": "remark . -qfo && prettier --write \"**/*.js\" && xo --fix",
-    "build-bundle": "browserify . -s hastUtilToNLCST > hast-util-to-nlcst.js",
-    "build-mangle": "browserify . -s hastUtilToNLCST -p tinyify > hast-util-to-nlcst.min.js",
+    "build-bundle": "browserify . -s hastUtilToNlcst > hast-util-to-nlcst.js",
+    "build-mangle": "browserify . -s hastUtilToNlcst -p tinyify > hast-util-to-nlcst.min.js",
     "build": "npm run build-bundle && npm run build-mangle",
     "test-api": "node test",
     "test-coverage": "nyc --reporter lcov tape test/index.js",

readme.md

@@ -39,12 +39,12 @@ var rehype = require('rehype')
 var vfile = require('to-vfile')
 var English = require('parse-english')
 var inspect = require('unist-util-inspect')
-var toNLCST = require('hast-util-to-nlcst')
+var toNlcst = require('hast-util-to-nlcst')
 
 var file = vfile.readSync('example.html')
 var tree = rehype().parse(file)
 
-console.log(inspect(toNLCST(tree, file, English)))
+console.log(inspect(toNlcst(tree, file, English)))
 ```
 
 Which, when running, yields:

test/index.js

@@ -10,67 +10,67 @@ var Dutch = require('parse-dutch')
 var English = require('parse-english')
 var negate = require('negate')
 var hidden = require('is-hidden')
-var toNLCST = require('..')
+var toNlcst = require('..')
 
 test('hast-util-to-nlcst', function(t) {
   t.throws(
     function() {
-      toNLCST()
+      toNlcst()
     },
     /hast-util-to-nlcst expected node/,
-    'should fail when not given an AST'
+    'should fail when not given a tree'
   )
 
   t.throws(
     function() {
-      toNLCST({})
+      toNlcst({})
     },
     /hast-util-to-nlcst expected node/,
-    'should fail when not given an AST (#2)'
+    'should fail when not given a tree (#2)'
   )
 
   t.throws(
     function() {
-      toNLCST({type: 'foo'})
+      toNlcst({type: 'foo'})
     },
     /hast-util-to-nlcst expected file/,
     'should fail when not given a file'
   )
 
   t.throws(
     function() {
-      toNLCST({type: 'foo'})
+      toNlcst({type: 'foo'})
     },
     /hast-util-to-nlcst expected file/,
     'should fail when not given a file (#2)'
   )
 
   t.throws(
     function() {
-      toNLCST({type: 'text', value: 'foo'}, {foo: 'bar'})
+      toNlcst({type: 'text', value: 'foo'}, {foo: 'bar'})
     },
     /hast-util-to-nlcst expected file/,
     'should fail when not given a file (#3)'
   )
 
   t.throws(
     function() {
-      toNLCST({type: 'text', value: 'foo'}, vfile('foo'))
+      toNlcst({type: 'text', value: 'foo'}, vfile('foo'))
     },
     /hast-util-to-nlcst expected parser/,
     'should fail without parser'
   )
 
   t.throws(
     function() {
-      toNLCST({type: 'text', value: 'foo'}, vfile(), Latin)
+      toNlcst({type: 'text', value: 'foo'}, vfile(), Latin)
     },
     /hast-util-to-nlcst expected position on nodes/,
     'should fail when not given positional information'
   )
 
   t.doesNotThrow(function() {
-    toNLCST(
+    toNlcst(
       {
         type: 'text',
         value: 'foo',
@@ -85,7 +85,7 @@ test('hast-util-to-nlcst', function(t) {
   }, 'should accept a parser constructor')
 
   t.doesNotThrow(function() {
-    toNLCST(
+    toNlcst(
       {
         type: 'text',
         value: 'foo',
@@ -101,7 +101,7 @@ test('hast-util-to-nlcst', function(t) {
 
   t.throws(
     function() {
-      toNLCST(
+      toNlcst(
         {
           type: 'text',
           value: 'foo',
@@ -116,7 +116,7 @@ test('hast-util-to-nlcst', function(t) {
   )
 
   t.test('should accept nodes without offsets', function(st) {
-    var node = toNLCST(
+    var node = toNlcst(
       {
         type: 'text',
         value: 'foo',
@@ -147,7 +147,7 @@ test('Fixtures', function(t) {
       var input = path.join(root, fixture, 'input.html')
       var output = path.join(root, fixture, 'output.json')
       var file = vfile(fs.readFileSync(input))
-      var actual = toNLCST(rehype().parse(file), file, Latin)
+      var actual = toNlcst(rehype().parse(file), file, Latin)
       var expected
 
       try {