Add JSDoc based types

Author: wooorm

.gitignore

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

index.js

@@ -1,12 +1,27 @@
+/**
+ * @typedef {import('hast').Properties} Properties
+ * @typedef {import('hast').Element} Element
+ */
+
 var search = /[#.]/g
 
-// Create a hast element from a simple CSS selector.
+/**
+ * Create a hast element from a simple CSS selector.
+ *
+ * @param {string} [selector]
+ * @param {string} [name='div']
+ * @returns {Element}
+ */
 export function parseSelector(selector, name = 'div') {
   var value = selector || ''
+  /** @type {Properties} */
   var props = {}
   var start = 0
+  /** @type {string} */
   var subvalue
+  /** @type {string} */
   var previous
+  /** @type {RegExpMatchArray} */
   var match
 
   while (start < value.length) {
@@ -19,7 +34,7 @@ export function parseSelector(selector, name = 'div') {
         name = subvalue
       } else if (previous === '#') {
         props.id = subvalue
-      } else if (props.className) {
+      } else if (Array.isArray(props.className)) {
         props.className.push(subvalue)
       } else {
         props.className = [subvalue]

package.json

@@ -27,22 +27,33 @@
   "sideEffects": false,
   "type": "module",
   "main": "index.js",
+  "types": "index.d.ts",
   "files": [
+    "index.d.ts",
     "index.js"
   ],
+  "dependencies": {
+    "@types/hast": "^2.0.0"
+  },
   "devDependencies": {
+    "@types/tape": "^4.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.39.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",
-    "test": "npm run format && npm run test-coverage"
+    "test": "npm run build && npm run format && npm run test-coverage"
   },
   "prettier": {
     "tabWidth": 2,
@@ -63,5 +74,10 @@
     "plugins": [
       "preset-wooorm"
     ]
+  },
+  "typeCoverage": {
+    "atLeast": 100,
+    "detail": true,
+    "strict": true
   }
 }

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
+  }
+}