Refactor code-style

Author: wooorm

lib/index.js

@@ -2,13 +2,13 @@
  * @typedef {import('mdast').Nodes} MdastNodes
  * @typedef {import('mdast').Parents} MdastParents
  *
+ * @typedef {import('nlcst').Paragraph} NlcstParagraph
+ * @typedef {import('nlcst').Parents} NlcstParents
  * @typedef {import('nlcst').Root} NlcstRoot
  * @typedef {import('nlcst').RootContent} NlcstRootContent
- * @typedef {import('nlcst').Parents} NlcstParents
+ * @typedef {import('nlcst').Sentence} NlcstSentence
  * @typedef {import('nlcst').SentenceContent} NlcstSentenceContent
  * @typedef {import('nlcst').WhiteSpace} NlcstWhiteSpace
- * @typedef {import('nlcst').Sentence} NlcstSentence
- * @typedef {import('nlcst').Paragraph} NlcstParagraph
  *
  * @typedef {import('unist').Point} Point
  *
@@ -19,9 +19,9 @@
 
 /**
  * @typedef {{
- *   tokenizeSentencePlugins: Array<(node: NlcstSentence) => void>,
- *   tokenizeParagraphPlugins: Array<(node: NlcstParagraph) => void>,
- *   tokenizeRootPlugins: Array<(node: NlcstRoot) => void>,
+ *   tokenizeSentencePlugins: Array<(node: NlcstSentence) => undefined | void>,
+ *   tokenizeParagraphPlugins: Array<(node: NlcstParagraph) => undefined | void>,
+ *   tokenizeRootPlugins: Array<(node: NlcstRoot) => undefined | void>,
  *   parse(value: string | null | undefined): NlcstRoot
  *   tokenize(value: string | null | undefined): Array<NlcstSentenceContent>
  * }} ParserInstance
@@ -46,18 +46,18 @@
  *   Info passed around.
  * @property {string} doc
  *   Whole document.
+ * @property {Array<string>} ignore
+ *   List of mdast node types to ignore.
  * @property {Location} place
  *   Location info.
  * @property {ParserInstance} parser
  *   Parser.
- * @property {Array<string>} ignore
- *   List of mdast node types to ignore.
  * @property {Array<string>} source
  *   List of mdast node types to mark as source.
  */
 
 import {toString} from 'nlcst-to-string'
-import {pointStart, pointEnd} from 'unist-util-position'
+import {pointEnd, pointStart} from 'unist-util-position'
 import {location} from 'vfile-location'
 
 const defaultIgnore = ['table', 'tableRow', 'tableCell']
@@ -78,10 +78,10 @@ const terminalMarker = /^([!.?\u2026\u203D]+)$/
  *   mdast tree to transform.
  * @param {VFile} file
  *   Virtual file.
- * @param {ParserInstance | ParserConstructor} Parser
+ * @param {ParserConstructor | ParserInstance} Parser
  *   Parser to use.
  * @param {Options | null | undefined} [options]
- *   Configuration.
+ *   Configuration (optional).
  * @returns {NlcstRoot}
  *   nlcst tree.
  */
@@ -293,7 +293,7 @@ function all(state, parent) {
  *   nlcst sentence content.
  * @param {number | undefined} offset
  *   Offset.
- * @returns {void}
+ * @returns {undefined}
  *   Nothing.
  */
 function patch(state, nodes, offset) {
@@ -310,11 +310,11 @@ function patch(state, nodes, offset) {
     const end =
       typeof start === 'number' ? start + toString(node).length : undefined
 
-    // @ts-expect-error: to do: fix this.
+    const startPoint = state.place.toPoint(start)
+    const endPoint = state.place.toPoint(end)
+
     node.position =
-      start !== undefined && end !== undefined
-        ? {start: state.place.toPoint(start), end: state.place.toPoint(end)}
-        : undefined
+      startPoint && endPoint ? {start: startPoint, end: endPoint} : undefined
 
     start = end
   }

readme.md

@@ -233,9 +233,9 @@ For example, [`parse-dutch`][parse-dutch], [`parse-english`][parse-english], or
 
 ```ts
 type ParserInstance = {
-  tokenizeSentencePlugins: ((node: NlcstSentence) => void)[]
-  tokenizeParagraphPlugins: ((node: NlcstParagraph) => void)[]
-  tokenizeRootPlugins: ((node: NlcstRoot) => void)[]
+  tokenizeSentencePlugins: ((node: NlcstSentence) => undefined)[]
+  tokenizeParagraphPlugins: ((node: NlcstParagraph) => undefined)[]
+  tokenizeRootPlugins: ((node: NlcstRoot) => undefined)[]
   parse(value: string | null | undefined): NlcstRoot
   tokenize(value: string | null | undefined): Array<NlcstSentenceContent>
 }