Use @types/nlcst

retextjs · Aug 27, 2021 · d737c00 · d737c00
1 parent fba13b8
commit d737c00
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 2 deletions.
diff --git a/index.js b/index.js
@@ -1,3 +1,7 @@
+/**
+ * @typedef {import('nlcst').Root} Root
+ */
+
 import {matchCasing} from 'match-casing'
 import {search} from 'nlcst-search'
 import {toString} from 'nlcst-to-string'
@@ -12,7 +16,7 @@ const list = Object.keys(schema)
 /**
  * Plugin to check for proper use of diacritics.
  *
- * @type {import('unified').Plugin<[]>}
+ * @type {import('unified').Plugin<[], Root>}
  */
 export default function retextDiacritics() {
   return (tree, file) => {

diff --git a/package.json b/package.json
@@ -34,6 +34,7 @@
     "schema.js"
   ],
   "dependencies": {
+    "@types/nlcst": "^1.0.0",
     "match-casing": "^2.0.0",
     "nlcst-search": "^3.0.0",
     "nlcst-to-string": "^3.0.0",

diff --git a/script/table.js b/script/table.js
@@ -1,11 +1,17 @@
+/**
+ * @typedef {import('mdast').Root} Root
+ * @typedef {import('mdast').TableContent} TableContent
+ */
+
 import {zone} from 'mdast-zone'
 import {u} from 'unist-builder'
 import {schema} from '../schema.js'
 
-/** @type {import('unified').Plugin<[]>} */
+/** @type {import('unified').Plugin<[], Root>} */
 export default function table() {
   return (tree) => {
     zone(tree, 'messages', (start, _, end) => {
+      /** @type {TableContent[]} */
       const rows = [
         u('tableRow', [
           u('tableCell', [u('inlineCode', 'source')]),