Use @types/nlcst

retextjs · Aug 27, 2021 · 9d49357 · 9d49357
1 parent 9fb54fa
commit 9d49357
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 6 deletions.
diff --git a/index.js b/index.js
@@ -1,4 +1,6 @@
 /**
+ * @typedef {import('nlcst').Root} Root
+ *
  * @typedef {0|1|2|'newline'|'space'|'double-space'|null|undefined} Preferred
  *
  * @typedef Options
@@ -21,13 +23,9 @@ const source = 'retext-sentence-spacing'
  * Plugin to check spacing between sentences.
  * Emit warnings when the spacing does not adhere to the preferred style.
  *
- * @type {import('unified').Plugin<[Options?]>}
+ * @type {import('unified').Plugin<[Options?], Root>}
  */
 export default function retextSentenceSpacing(options = {}) {
-  /**
-   * @typedef {import('unist').Parent} Parent
-   */
-
   let preferred = options.preferred
 
   if (preferred === 'newline') {
@@ -55,7 +53,7 @@ export default function retextSentenceSpacing(options = {}) {
   }
 
   return (tree, file) => {
-    visit(tree, 'ParagraphNode', (/** @type {Parent} */ node) => {
+    visit(tree, 'ParagraphNode', (node) => {
       let index = -1
 
       while (++index < node.children.length) {

diff --git a/package.json b/package.json
@@ -31,6 +31,7 @@
     "index.js"
   ],
   "dependencies": {
+    "@types/nlcst": "^1.0.0",
     "@types/unist": "^2.0.0",
     "nlcst-to-string": "^3.0.0",
     "unified": "^10.0.0",