Add JSDoc based types

Closes GH-1.

Author: remcohaszing

.gitignore

@@ -1,5 +1,7 @@
 .DS_Store
+*.d.ts
 *.log
+*.tgz
 .nyc_output/
 coverage/
 node_modules/

index.js

@@ -6,17 +6,32 @@ exports.name = name
 
 var id = require('./regex')
 
+/**
+ * Checks if the given character code can start an identifier.
+ *
+ * @param {number} code
+ */
 // To do: support astrals.
 function start(code) {
   return id.start.test(String.fromCharCode(code))
 }
 
+/**
+ * Checks if the given character code can continue an identifier.
+ *
+ * @param {number} code
+ */
 // To do: support astrals.
 function cont(code) {
   var character = String.fromCharCode(code)
   return id.start.test(character) || id.cont.test(character)
 }
 
+/**
+ * Checks if the given string is a valid identifier name.
+ *
+ * @param {string} name
+ */
 function name(name) {
   var index = -1
 

package.json

@@ -24,25 +24,31 @@
   ],
   "files": [
     "index.js",
-    "regex.js"
+    "regex.js",
+    "*.d.ts"
   ],
-  "dependencies": {},
   "devDependencies": {
+    "@types/tape": "^4.0.0",
     "@unicode/unicode-13.0.0": "^1.0.0",
     "nyc": "^15.0.0",
     "prettier": "^2.0.0",
     "regenerate": "^1.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.36.0"
   },
   "scripts": {
     "generate": "node build",
     "format": "remark . -qfo && prettier . -w --loglevel warn && xo --fix",
     "test-api": "node test",
     "test-coverage": "nyc --reporter lcov tape test.js",
-    "test": "npm run generate && npm run format && npm run test-coverage"
+    "build": "rimraf \"*.d.ts\" && tsc && type-coverage",
+    "test": "npm run generate && npm run format && npm run test-coverage && npm run build",
+    "prepack": "npm run build && npm run format"
   },
   "prettier": {
     "tabWidth": 2,
@@ -73,5 +79,10 @@
     "plugins": [
       "preset-wooorm"
     ]
+  },
+  "typeCoverage": {
+    "atLeast": 100,
+    "detail": true,
+    "strict": true
   }
 }

tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "files": ["index.js"],
+  "compilerOptions": {
+    "target": "ES2020",
+    "lib": ["ES2020"],
+    "module": "ES2020",
+    "moduleResolution": "node",
+    "allowJs": true,
+    "checkJs": true,
+    "declaration": true,
+    "emitDeclarationOnly": true,
+    "skipLibCheck": true
+  }
+}