Add JSDoc based types

Author: wooorm

.gitignore

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

index.js

@@ -2,14 +2,24 @@ import location from 'vfile-location'
 
 var search = /\r?\n|\r/g
 
+/**
+ * @param {import('unist').Node|import('unist').Position} value Value to get
+ * @param {import('vfile').VFile|string} file File in which `value` exists
+ * @returns {string|null}
+ */
 export function source(value, file) {
   var doc = String(file)
   var loc = location(file)
+  /** @type {import('unist').Position} */
+  // @ts-ignore Looks like a node.
   var position = (value && value.position) || value || {}
   var startOffset = loc.toOffset(position.start)
   var endOffset = loc.toOffset(position.end)
+  /** @type {Array.<string>} */
   var results = []
+  /** @type {RegExpMatchArray} */
   var match
+  /** @type {number} */
   var end
 
   if (startOffset === -1 || endOffset === -1) {

package.json

@@ -25,26 +25,36 @@
   "sideEffects": false,
   "type": "module",
   "main": "index.js",
+  "types": "index.d.ts",
   "files": [
+    "index.d.ts",
     "index.js"
   ],
   "dependencies": {
+    "@types/unist": "^2.0.0",
+    "vfile": "^4.0.0",
     "vfile-location": "^3.0.0"
   },
   "devDependencies": {
+    "@types/tape": "^4.0.0",
     "c8": "^7.0.0",
     "prettier": "^2.0.0",
     "remark": "^13.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,
@@ -65,5 +75,10 @@
     "plugins": [
       "preset-wooorm"
     ]
+  },
+  "typeCoverage": {
+    "atLeast": 100,
+    "detail": true,
+    "strict": true
   }
 }

readme.md

@@ -55,15 +55,15 @@ Now, running `node example` yields:
 
 ## API
 
-### `source(value, doc)`
+### `source(value, file)`
 
 This package exports the following identifiers: `source`.
 There is no default export.
 
 ###### Parameters
 
 *   `value` ([`Node`][node] or [`Position`][position]) — Value to get
-*   `doc` ([`VFile`][vfile] or `string`) — [file][] in which `value` exists
+*   `file` ([`VFile`][vfile] or `string`) — [file][] in which `value` exists
 
 ###### Returns
 

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