Add strict types

wooorm · Aug 8, 2021 · b97764e · b97764e
1 parent adf903e
commit b97764e
Show file tree

Hide file tree

Showing 6 changed files with 42 additions and 35 deletions.
diff --git a/lib/core.js b/lib/core.js
@@ -40,13 +40,13 @@
 const ctx =
   typeof globalThis === 'object'
     ? globalThis
-    : // @ts-ignore
+    : // @ts-expect-error
     typeof self === 'object'
-    ? // @ts-ignore
+    ? // @ts-expect-error
       self
-    : // @ts-ignore
+    : // @ts-expect-error
     typeof window === 'object'
-    ? // @ts-ignore
+    ? // @ts-expect-error
       window
     : typeof global === 'object'
     ? global
@@ -55,7 +55,7 @@ const ctx =
 
 const restore = capture()
 
-// @ts-ignore Types are incorrect.
+// @ts-expect-error Types are incorrect.
 ctx.Prism = {manual: true, disableWorkerMessageHandler: true}
 
 /* eslint-disable import/first */
@@ -64,6 +64,7 @@ ctx.Prism = {manual: true, disableWorkerMessageHandler: true}
 // The wrapped non-leaky grammars are loaded instead of Prism’s originals.
 import {h} from 'hastscript'
 import {parseEntities} from 'parse-entities'
+// @ts-expect-error: untyped.
 import Prism from 'prismjs/components/prism-core.js'
 
 /* eslint-enable import/first */
@@ -78,6 +79,7 @@ function Refractor() {}
 Refractor.prototype = Prism
 
 /** @type {Refractor} */
+// @ts-expect-error: TS is wrong.
 export const refractor = new Refractor()
 
 // Create.
@@ -87,9 +89,9 @@ refractor.alias = alias
 refractor.registered = registered
 refractor.listLanguages = listLanguages
 
-// @ts-ignore Overwrite Prism.
+// @ts-expect-error Overwrite Prism.
 refractor.util.encode = encode
-// @ts-ignore Overwrite Prism.
+// @ts-expect-error Overwrite Prism.
 refractor.Token.stringify = stringify
 
 /**
@@ -123,11 +125,12 @@ function register(syntax) {
 function alias(name, alias) {
   const languages = refractor.languages
   /** @type {Object.<string, string|Array.<string>>} */
-  let map
+  let map = {}
 
   if (typeof name === 'string') {
-    map = {}
-    map[name] = alias
+    if (alias) {
+      map[name] = alias
+    }
   } else {
     map = name
   }
@@ -163,15 +166,13 @@ function highlight(value, nameOrGrammar) {
 
   /** @type {Grammar} */
   let grammar
-  /** @type {string} */
+  /** @type {string|undefined} */
   let name
 
   // `name` is a grammar object.
   if (nameOrGrammar && typeof nameOrGrammar === 'object') {
     grammar = nameOrGrammar
-    name = null
   } else {
-    // @ts-ignore Assume string.
     name = nameOrGrammar
 
     if (typeof name !== 'string') {
@@ -252,7 +253,7 @@ function stringify(value, language) {
         value[index] !== null &&
         value[index] !== undefined
       ) {
-        // @ts-ignore Assume no sub-arrays.
+        // @ts-expect-error Assume no sub-arrays.
         result.push(stringify(value[index], language))
       }
     }
@@ -276,10 +277,10 @@ function stringify(value, language) {
     )
   }
 
-  // @ts-ignore Prism.
+  // @ts-expect-error Prism.
   refractor.hooks.run('wrap', env)
 
-  // @ts-ignore Hush, it’s fine.
+  // @ts-expect-error Hush, it’s fine.
   return h(
     env.tag + '.' + env.classes.join('.'),
     attributes(env.attributes),
@@ -317,6 +318,7 @@ function attributes(attrs) {
  * @returns {() => void}
  */
 function capture() {
+  /** @type {boolean|undefined} */
   let defined = 'Prism' in ctx
   /* c8 ignore next */
   let current = defined ? ctx.Prism : undefined
@@ -329,9 +331,11 @@ function capture() {
   function restore() {
     /* istanbul ignore else - Clean leaks after Prism. */
     if (defined) {
+      // @ts-expect-error: hush.
       ctx.Prism = current
-      /* c8 ignore next 3 */
+      /* c8 ignore next 4 */
     } else {
+      // @ts-expect-error: hush.
       delete ctx.Prism
     }
 

diff --git a/script/data.js b/script/data.js
@@ -1,5 +1,6 @@
 import fs from 'node:fs'
 import path from 'node:path'
+// @ts-expect-error: untyped.
 import getLoader from 'prismjs/dependencies.js'
 
 /** @type {{languages: Object.<string, unknown>}} */

diff --git a/script/languages.js b/script/languages.js
@@ -23,20 +23,16 @@ const components = JSON.parse(
 
 const prefix = 'refractor-'
 
-async.map(all, generate, done)
-
-/**
- * @param {Error} error
- * @param {Array.<undefined>} [results]
- */
-function done(error, results) {
+async.map(all, generate, (error, results) => {
   bail(error)
-  console.log(chalk.green('✓') + ' wrote ' + results.length + ' languages')
-}
+  console.log(
+    chalk.green('✓') + ' wrote ' + (results || []).length + ' languages'
+  )
+})
 
 /**
  * @param {string} name
- * @param {(error: Error) => void} callback
+ * @param {(error: Error|null) => void} callback
  */
 function generate(name, callback) {
   const id = toId(name)
@@ -56,6 +52,8 @@ function generate(name, callback) {
         typeof info.alias === 'string' ? [info.alias] : info.alias || []
       ).sort(alphaSort())
 
+      /** @type {string} */
+      // @ts-expect-error: TS is wrong.
       const doc = babel.transformSync(String(buf), {
         plugins: [fixWrapHook]
       }).code
@@ -124,7 +122,7 @@ function fixWrapHook() {
             callee.matchesPattern('Prism.highlight') &&
             path.get('left').matchesPattern('env.content')
           ) {
-            // @ts-ignore Mutate.
+            // @ts-expect-error Mutate.
             path.get('left').node.ignoreValueSuffix = true
           }
         }
@@ -135,7 +133,7 @@ function fixWrapHook() {
         enter(path) {
           if (
             this.inWrapHook &&
-            // @ts-ignore Mutate.
+            // @ts-expect-error Mutate.
             !path.node.ignoreValueSuffix &&
             path.matchesPattern('env.content')
           ) {

diff --git a/script/to-id.js b/script/to-id.js
@@ -1,3 +1,4 @@
+// @ts-expect-error: untyped.
 import isKeyword from 'is-keyword'
 
 /**

diff --git a/test/index.js b/test/index.js
@@ -1,6 +1,7 @@
 /**
  * @typedef {import('../lib/core.js').Syntax} Syntax
  * @typedef {import('hast').Node} Node
+ * @typedef {import('prismjs')} Prism
  */
 
 import fs from 'node:fs'
@@ -14,7 +15,7 @@ import {refractor} from '../lib/all.js'
 test('.highlight(value, language)', (t) => {
   t.throws(
     () => {
-      // @ts-ignore runtime.
+      // @ts-expect-error runtime.
       refractor.highlight()
     },
     / Expected `string` for `value`, got `undefined`/,
@@ -23,7 +24,7 @@ test('.highlight(value, language)', (t) => {
 
   t.throws(
     () => {
-      // @ts-ignore runtime.
+      // @ts-expect-error runtime.
       refractor.highlight('')
     },
     /Expected `string` for `name`, got `undefined`/,
@@ -32,7 +33,7 @@ test('.highlight(value, language)', (t) => {
 
   t.throws(
     () => {
-      // @ts-ignore runtime.
+      // @ts-expect-error runtime.
       refractor.highlight(true, 'js')
     },
     /Expected `string` for `value`, got `true`/,
@@ -65,7 +66,7 @@ test('.highlight(value, language)', (t) => {
 test('.register(grammar)', (t) => {
   t.throws(
     () => {
-      // @ts-ignore runtime.
+      // @ts-expect-error runtime.
       refractor.register()
     },
     /Expected `function` for `syntax`, got `undefined`/,
@@ -78,7 +79,7 @@ test('.register(grammar)', (t) => {
 test('.registered(language)', (t) => {
   t.throws(
     () => {
-      // @ts-ignore runtime.
+      // @ts-expect-error runtime.
       refractor.registered()
     },
     /Expected `string` for `language`, got `undefined`/,
@@ -197,6 +198,7 @@ test('listLanguages', (t) => {
     'should return a list of registered languages'
   )
 
+  // @ts-expect-error: hush.
   refractor.register(grammar)
 
   t.deepEqual(

diff --git a/tsconfig.json b/tsconfig.json
@@ -10,6 +10,7 @@
     "declaration": true,
     "emitDeclarationOnly": true,
     "allowSyntheticDefaultImports": true,
-    "skipLibCheck": true
+    "skipLibCheck": true,
+    "strict": true
   }
 }