Use strict types

.gitignore

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

build.js

@@ -1,37 +1,46 @@
 import fs from 'node:fs'
 import https from 'node:https'
 import {bail} from 'bail'
-import concat from 'concat-stream'
+import concatStream from 'concat-stream'
 
-https.get('https://www.w3.org/TR/html4/sgml/entities.html', onconnection)
-
-function onconnection(response) {
-  response.pipe(concat(onconcat)).on('error', bail)
-}
+https.get('https://www.w3.org/TR/html4/sgml/entities.html', (response) => {
+  response.pipe(concatStream(onconcat)).on('error', bail)
+})
 
+/**
+ * @param {Buffer} data
+ */
 function onconcat(data) {
+  const value = String(data)
+  /** @type {Record.<string, string>} */
   const entities = {}
   const re = /&lt;!ENTITY([\s\S]+?)--&gt;/g
-  let match = re.exec(data)
-  let list
+  let match = re.exec(value)
 
   while (match) {
-    list = match[1].split('--', 1)[0].split(/\s+/).filter(Boolean)
+    const list = match[1].split('--', 1)[0].split(/\s+/).filter(Boolean)
 
     if (list[1] === 'CDATA') {
       entities[list[0]] = String.fromCharCode(
         Number(list[2].split('#')[1].split(';')[0])
       )
     }
 
-    match = re.exec(data)
+    match = re.exec(value)
   }
 
   fs.writeFile(
     'index.js',
-    'export const characterEntitiesHtml4 = ' +
-      JSON.stringify(entities, null, 2) +
-      '\n',
+    [
+      '/**',
+      ' * Map of named character references from HTML 4.',
+      ' *',
+      ' * @type {Record<string, string>}',
+      ' */',
+      'export const characterEntitiesHtml4 = ' +
+        JSON.stringify(entities, null, 2),
+      ''
+    ].join('\n'),
     bail
   )
 }

index.js

@@ -1,3 +1,8 @@
+/**
+ * Map of named character references from HTML 4.
+ *
+ * @type {Record<string, string>}
+ */
 export const characterEntitiesHtml4 = {
   nbsp: ' ',
   iexcl: '¡',

package.json

@@ -41,17 +41,17 @@
     "remark-preset-wooorm": "^9.0.0",
     "rimraf": "^3.0.0",
     "tape": "^5.0.0",
+    "type-coverage": "^2.0.0",
     "typescript": "^4.0.0",
     "xo": "^0.46.0"
   },
   "scripts": {
     "prepublishOnly": "npm run build && npm run format",
     "generate": "node build",
-    "prebuild": "rimraf \"*.d.ts\"",
-    "build": "tsc",
+    "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-api": "node --conditions development test.js",
+    "test-coverage": "c8 --check-coverage --branches 100 --functions 100 --lines 100 --statements 100 --reporter lcov npm run test-api",
     "test": "npm run generate && npm run build && npm run format && npm run test-coverage"
   },
   "prettier": {
@@ -69,5 +69,11 @@
     "plugins": [
       "preset-wooorm"
     ]
+  },
+  "typeCoverage": {
+    "atLeast": 100,
+    "detail": true,
+    "strict": true,
+    "ignoreCatch": true
   }
 }

readme.md

@@ -5,7 +5,7 @@
 [![Downloads][downloads-badge]][downloads]
 [![Size][size-badge]][size]
 
-HTML4 character entity information.
+Map of named character references from HTML 4.
 
 ## Install
 

tsconfig.json

@@ -1,5 +1,4 @@
 {
-  "files": ["index.js"],
   "include": ["*.js"],
   "compilerOptions": {
     "target": "ES2020",
@@ -11,6 +10,7 @@
     "declaration": true,
     "emitDeclarationOnly": true,
     "allowSyntheticDefaultImports": true,
-    "skipLibCheck": true
+    "skipLibCheck": true,
+    "strict": true
   }
 }