Add JSDoc based types

Author: wooorm

.gitignore

@@ -1,4 +1,5 @@
 .DS_Store
+*.d.ts
 *.log
 coverage/
 node_modules/

index.js

@@ -1,21 +1,56 @@
+/**
+ * @typedef {string|number|boolean} MarkerParameterValue
+ * @typedef {Object.<string, MarkerParameterValue>} MarkerParameters
+ *
+ * @typedef HtmlNode
+ * @property {'html'} type
+ * @property {string} value
+ *
+ * @typedef CommentNode
+ * @property {'comment'} type
+ * @property {string} value
+ *
+ * @typedef Marker
+ * @property {string} name
+ * @property {string} attributes
+ * @property {MarkerParameters|null} parameters
+ * @property {HtmlNode|CommentNode} node
+ */
+
 var commentExpression = /\s*([a-zA-Z\d-]+)(\s+([\s\S]*))?\s*/
 
 var markerExpression = new RegExp(
   '(\\s*<!--' + commentExpression.source + '-->\\s*)'
 )
 
-// Parse a comment marker.
+/**
+ * Parse a comment marker.
+ * @param {unknown} node
+ * @returns {Marker|null}
+ */
 export function commentMarker(node) {
+  /** @type {RegExpMatchArray} */
   var match
+  /** @type {number} */
   var offset
+  /** @type {MarkerParameters} */
   var parameters
 
-  if (node && (node.type === 'html' || node.type === 'comment')) {
+  if (
+    node &&
+    typeof node === 'object' &&
+    // @ts-ignore hush
+    (node.type === 'html' || node.type === 'comment')
+  ) {
+    // @ts-ignore hush
     match = node.value.match(
+      // @ts-ignore hush
       node.type === 'comment' ? commentExpression : markerExpression
     )
 
+    // @ts-ignore hush
     if (match && match[0].length === node.value.length) {
+      // @ts-ignore hush
       offset = node.type === 'comment' ? 1 : 2
       parameters = parseParameters(match[offset + 1] || '')
 
@@ -24,6 +59,7 @@ export function commentMarker(node) {
           name: match[offset],
           attributes: match[offset + 2] || '',
           parameters,
+          // @ts-ignore hush
           node
         }
       }
@@ -33,8 +69,14 @@ export function commentMarker(node) {
   return null
 }
 
-// Parse `value` into an object.
+/**
+ * Parse `value` into an object.
+ *
+ * @param {string} value
+ * @returns {MarkerParameters|null}
+ */
 function parseParameters(value) {
+  /** @type {MarkerParameters} */
   var parameters = {}
 
   return value
@@ -46,8 +88,16 @@ function parseParameters(value) {
     ? null
     : parameters
 
+  /**
+   * @param {string} _
+   * @param {string} $1
+   * @param {string} $2
+   * @param {string} $3
+   * @param {string} $4
+   */
   // eslint-disable-next-line max-params
-  function replacer($0, $1, $2, $3, $4) {
+  function replacer(_, $1, $2, $3, $4) {
+    /** @type {MarkerParameterValue} */
     var value = $2 || $3 || $4 || ''
 
     if (value === 'true' || value === '') {

package.json

@@ -26,18 +26,27 @@
   "sideEffects": false,
   "type": "module",
   "main": "index.js",
+  "types": "index.d.ts",
   "files": [
+    "index.d.ts",
     "index.js"
   ],
   "devDependencies": {
+    "@types/tape": "^4.0.0",
+    "@types/unist": "^2.0.0",
     "c8": "^7.0.0",
     "prettier": "^2.0.0",
     "remark-cli": "^9.0.0",
     "remark-preset-wooorm": "^8.0.0",
+    "rimraf": "^3.0.0",
     "tape": "^5.0.0",
+    "type-coverage": "^2.0.0",
+    "typescript": "^4.0.0",
     "xo": "^0.38.0"
   },
   "scripts": {
+    "prepack": "npm run build && npm run format",
+    "build": "rimraf \"*.d.ts\" && tsc && type-coverage",
     "format": "remark . -qfo && prettier . -w --loglevel warn && xo --fix",
     "test-api": "node test.js",
     "test-coverage": "c8 --check-coverage --branches 100 --functions 100 --lines 100 --statements 100 --reporter lcov node test.js",
@@ -62,5 +71,10 @@
     "plugins": [
       "preset-wooorm"
     ]
+  },
+  "typeCoverage": {
+    "atLeast": 100,
+    "detail": true,
+    "strict": true
   }
 }

test.js

@@ -1,7 +1,12 @@
+/**
+ * @typedef {import('unist').Node} Node
+ */
+
 import test from 'tape'
 import {commentMarker} from './index.js'
 
 test('commentMaker(node)', function (t) {
+  /** @type {Node} */
   var node
 
   t.equal(commentMarker(), null, 'should work without node')
@@ -154,6 +159,7 @@ test('commentMaker(node)', function (t) {
 })
 
 test('comment node', function (t) {
+  /** @type {Node} */
   var node
 
   t.equal(

tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "include": ["*.js"],
+  "compilerOptions": {
+    "target": "ES2020",
+    "lib": ["ES2020"],
+    "module": "ES2020",
+    "moduleResolution": "node",
+    "allowJs": true,
+    "checkJs": true,
+    "declaration": true,
+    "emitDeclarationOnly": true,
+    "allowSyntheticDefaultImports": true,
+    "skipLibCheck": true
+  }
+}