Add JSDoc based types

Author: wooorm

.gitignore

@@ -1,5 +1,6 @@
 coverage/
 node_modules/
 .DS_Store
+*.d.ts
 *.log
 yarn.lock

index.js

@@ -1,3 +1,14 @@
+/**
+ * @typedef Options
+ *   Configuration.
+ * @property {boolean} [allowLiterals=false]
+ *   Suggest straight (`'`) instead of smart (`’`) apostrophes.
+ *   Use `retext-quotes` if you want to properly check that though.
+ * @property {boolean} [straight=false]
+ *   Include literal phrases.
+ *   The default is to ignore them.
+ */
+
 import {visit} from 'unist-util-visit'
 import {toString} from 'nlcst-to-string'
 import {isLiteral} from 'nlcst-is-literal'
@@ -10,7 +21,11 @@ const own = {}.hasOwnProperty
 
 const data = initialize()
 
-// Check contractions use.
+/**
+ * Plugin to check contractions use.
+ *
+ * @type {import('unified').Plugin<[Options?]>}
+ */
 export default function retextContractions(options = {}) {
   const ignore = options.allowLiterals
   const straight = options.straight
@@ -32,7 +47,7 @@ export default function retextContractions(options = {}) {
           // Perfect.
           actual === expected ||
           // Ignore literal misspelt words: `like this: “hasnt”`.
-          (!ignore && isLiteral(parent, index))
+          (parent && index !== null && !ignore && isLiteral(parent, index))
         ) {
           return
         }
@@ -66,8 +81,11 @@ export default function retextContractions(options = {}) {
   }
 }
 
+/** @returns {Record<string, string>} */
 function initialize() {
+  /** @type {Record<string, string>} */
   const result = {}
+  /** @type {string} */
   let key
 
   for (key in list) {

list.js

@@ -1,3 +1,4 @@
+/** @type {Record<string, string>} */
 export const list = {
   aint: "ain't",
   arent: "aren't",

package.json

@@ -26,29 +26,38 @@
   "sideEffects": false,
   "type": "module",
   "main": "index.js",
+  "types": "index.d.ts",
   "files": [
+    "index.d.ts",
     "index.js",
+    "list.d.ts",
     "list.js"
   ],
   "dependencies": {
     "nlcst-is-literal": "^2.0.0",
     "nlcst-to-string": "^3.0.0",
+    "unified": "^10.0.0",
     "unist-util-visit": "^3.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",
     "retext": "^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": {
+    "build": "rimraf \"*.d.ts\" && tsc && type-coverage",
     "format": "remark . -qfo && prettier . -w --loglevel warn && xo --fix",
     "test-api": "node --conditions development test.js",
     "test-coverage": "c8 --check-coverage --branches 100 --functions 100 --lines 100 --statements 100 --reporter lcov node --conditions development test.js",
-    "test": "npm run format && npm run test-coverage"
+    "test": "npm run build && npm run format && npm run test-coverage"
   },
   "prettier": {
     "tabWidth": 2,
@@ -75,5 +84,11 @@
         }
       ]
     ]
+  },
+  "typeCoverage": {
+    "atLeast": 100,
+    "detail": true,
+    "strict": true,
+    "ignoreCatch": true
   }
 }

tsconfig.json

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