Add JSDoc based types

Author: wooorm

.gitignore

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

index.js

@@ -1,10 +1,26 @@
+/**
+ * @typedef {import('vfile').VFile} VFile
+ * @typedef {import('js-yaml').LoadOptions} LoadOptions
+ *
+ * @typedef Options VFile matter options
+ * @property {boolean} [strip=false] Remove the YAML front matter from the file
+ * @property {Omit<LoadOptions, 'filename'>} [yaml] Options for the YAML parser
+ */
+
 import buffer from 'is-buffer'
 import {load} from 'js-yaml'
 
-export function matter(file, options) {
-  var settings = options || {}
-  var strip = settings.strip
-  var yamlOptions = settings.yaml || {}
+/**
+ * Parse the YAML front matter in a [`vfile`](https://github.com/vfile/vfile), and add it as `file.data.matter`.
+ *
+ * If no matter is found in the file, nothing happens, except that `file.data.matter` is set to an empty object (`{}`).
+ * @param {VFile} file Virtual file
+ * @param {Options} [options] Options
+ * @returns The given `file`
+ */
+export function matter(file, options = {}) {
+  var strip = options.strip
+  var yamlOptions = options.yaml || {}
   var doc = String(file)
   var match = /^---(?:\r?\n|\r)(?:([\s\S]*)(?:\r?\n|\r))?---(?:\r?\n|\r|$)/.exec(
     doc

package.json

@@ -27,31 +27,37 @@
   "sideEffects": false,
   "type": "module",
   "main": "index.js",
-  "types": "types/index.d.ts",
+  "types": "index.d.ts",
   "files": [
-    "types/index.d.ts",
+    "index.d.ts",
     "index.js"
   ],
   "dependencies": {
+    "@types/js-yaml": "^4.0.0",
     "is-buffer": "^2.0.0",
     "js-yaml": "^4.0.0"
   },
   "devDependencies": {
-    "@types/js-yaml": "^4.0.0",
+    "@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",
     "to-vfile": "^7.0.0",
+    "type-coverage": "^2.0.0",
+    "typescript": "^4.0.0",
     "vfile": "^5.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,
@@ -66,14 +72,16 @@
     "rules": {
       "no-var": "off",
       "prefer-arrow-callback": "off"
-    },
-    "ignores": [
-      "types/"
-    ]
+    }
   },
   "remarkConfig": {
     "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
+  }
+}