[tests] Allow type check (#4015)

- Restore `tsconfig.json` for tests
- Adjust types and fix TS errors
- Add corresponding NPM scripts

Author: DmitrySharabin

package.json

@@ -49,7 +49,9 @@
 		"test:plugins": "mocha tests/plugins/**/*.js",
 		"test:runner": "mocha tests/testrunner-tests.js",
 		"test": "npm-run-all test:*",
-		"typecheck": "tsc"
+		"typecheck:core": "tsc",
+		"typecheck:tests": "tsc -p tests/tsconfig.json",
+		"typecheck": "npm-run-all typecheck:*"
 	},
 	"repository": {
 		"type": "git",

src/shared/util.js

@@ -42,7 +42,7 @@ export const noop = () => {
 
 /**
  * @param {any} value
- * @returns {boolean}
+ * @returns {value is T & {}}
  */
 export function isNonNull (value) {
 	return value != null;

tests/components-test.js

@@ -14,9 +14,9 @@ describe('Components', () => {
 
 		for (const id of getComponentIds()) {
 			const proto = await getComponent(id).catch(noop);
-			const require = new Set(toArray(proto?.require).map(p => p.id));
+			const require = new Set(toArray(/** @type any */ (proto)?.require).map(p => p.id));
 
-			forEach(proto?.optional, opt => {
+			forEach(/** @type any */ (proto?.optional), opt => {
 				if (require.has(opt)) {
 					assert.fail(
 						`The optional dependency ${opt} is redundant because ${id} already requires it. Remove the optional dependency.`
@@ -47,7 +47,8 @@ describe('Components', () => {
 		for (const id of getComponentIds()) {
 			const proto = await getComponent(id).catch(noop);
 			add(id, 'a component id');
-			forEach(proto?.alias, a => add(a, `an alias of ${id}`));
+			forEach(/** @type {string | string[] | null | undefined} */ (proto?.alias), a =>
+				add(a, `an alias of ${id}`));
 		}
 	});
 });
@@ -74,15 +75,22 @@ describe('components.json', () => {
 		}
 
 		for (const id in entries) {
-			consumeFn(entries[id], id, entries);
+			consumeFn(entries[id], id, /** @type {Record<string, ComponentEntry>} */ (entries));
 		}
 	}
 
 	describe('- should have valid alias titles', () => {
 		for (const lang of getLanguageIds()) {
 			it(`- ${lang} should have all alias titles registered as alias`, async () => {
-				const aliases = new Set(toArray((await getComponent(lang)).alias));
-				const aliasTitles = components.languages[lang]?.aliasTitles ?? {};
+				const aliases = new Set(
+					toArray(
+						/** @type {string | string[] | null | undefined} */ (
+							(await getComponent(lang)).alias
+						)
+					)
+				);
+				const aliasTitles =
+					/** @type {ComponentEntry} */ (components.languages[lang])?.aliasTitles ?? {};
 
 				Object.keys(aliasTitles).forEach(id => {
 					if (!aliases.has(id)) {
@@ -103,7 +111,7 @@ describe('components.json', () => {
 			.map(key => {
 				return {
 					id: key,
-					title: components.languages[key].title,
+					title: /** @type {ComponentEntry} */ (components.languages[key]).title,
 				};
 			});
 
@@ -119,12 +127,16 @@ describe('components.json', () => {
 		}
 
 		const sorted = [...languages].sort((a, b) => {
-			const comp = transformTitle(a.title).localeCompare(transformTitle(b.title));
+			const comp = transformTitle(/** @type {string} */ (a.title)).localeCompare(
+				transformTitle(/** @type {string} */ (b.title))
+			);
 			if (comp !== 0) {
 				return comp;
 			}
 			// a and b have the same intermediate form (e.g. "C" => "C", "C++" => "C", "C#" => "C").
-			return a.title.toLowerCase().localeCompare(b.title.toLowerCase());
+			return /** @type {string} */ (a.title)
+				.toLowerCase()
+				.localeCompare(/** @type {string} */ (b.title).toLowerCase());
 		});
 
 		assert.sameOrderedMembers(languages, sorted);

tests/helper/args.js

@@ -1,10 +1,7 @@
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
 
-/**
- * @type {Args}
- */
-const args = yargs(hideBin(process.argv)).argv;
+const args = /** @type {Args} */ (yargs(hideBin(process.argv)).argv);
 
 export const language = args.language;
 export const update = !!args.update;

tests/helper/prism-dom-util.js

@@ -81,7 +81,7 @@ export function createTestSuite (options) {
 						await dom.loadLanguages(options.languages);
 					}
 					if (options.plugins) {
-						await dom.loadPlugins(options.plugins);
+						await dom.loadPlugins(/** @type {string | string[]} */ (options.plugins));
 					}
 
 					dom.withGlobals(() => {
@@ -101,7 +101,7 @@ export function createTestSuite (options) {
  */
 
 /**
- * @template T
+ * @template {string} T
  * @typedef {import('../types.d.ts').TestSuiteDom<T>} TestSuiteDom
  */
 

tests/helper/prism-loader.js

@@ -143,7 +143,7 @@ export function createPrismDOM () {
 		finally {
 			undo?.();
 			// Clean up navigator property
-			delete g.navigator;
+			delete (/** @type {Partial<typeof global>} */ (g).navigator);
 		}
 	};
 

tests/helper/token-stream-transformer.js

@@ -498,15 +498,15 @@ function prettyGlueTogetherAll (prettyStream, slice) {
 /**
  *
  * @param {PrettyTokenStreamItem} item
- * @returns {boolean}
+ * @returns {item is SimplifiedToken}
  */
 function isToken (item) {
 	return typeof item === 'string' || Array.isArray(item);
 }
 /**
  *
  * @param {PrettyTokenStreamItem} item
- * @returns {boolean}
+ * @returns {item is [string, SimplifiedToken[]]}
  */
 function isNested (item) {
 	return Array.isArray(item) && Array.isArray(item[1]);
@@ -515,7 +515,7 @@ function isNested (item) {
 /**
  *
  * @param {PrettyTokenStreamItem} item
- * @returns {boolean}
+ * @returns {item is [string, [string]]}
  */
 function isTriviallyNested (item) {
 	return isNested(item) && item[1].length === 1 && typeof item[1][0] === 'string';

tests/identifier-test.js

@@ -78,7 +78,9 @@ for (const lang of getLanguageIds()) {
 	describe(`Patterns of '${lang}' with optional dependencies`, () => {
 		const getPrism = async () => {
 			const component = await getComponent(lang);
-			const optional = toArray(component.optional);
+			const optional = toArray(
+				/** @type {string | string[] | null | undefined} */ (component.optional)
+			);
 			const Prism = await createInstance([lang, ...optional]);
 			return Prism;
 		};

tests/pattern-tests.js

@@ -54,7 +54,9 @@ for (const lang of getLanguageIds()) {
 	describe(`Patterns of '${lang}' with optional dependencies`, () => {
 		const create = lazy(async () => {
 			const component = await getComponent(lang);
-			const optional = toArray(component.optional);
+			const optional = toArray(
+				/** @type {string | string[] | null | undefined} */ (component.optional)
+			);
 			if (optional.length === 0) {
 				return undefined;
 			}
@@ -517,7 +519,7 @@ function getResultCache (cacheName) {
 }
 
 /**
- * @template T
+ * @template {Node} T
  * @param {string} cacheName
  * @param {T} cacheKey
  * @param {(node: T) => void} compute
@@ -752,7 +754,10 @@ function checkPolynomialBacktracking (path, pattern, ast) {
 		ast = parseRegex(pattern);
 	}
 
-	const result = scslre.analyse(ast, { maxReports: 1, reportTypes: { 'Move': false } });
+	const result = scslre.analyse(/** @type {scslre.ParsedLiteral} */ (ast), {
+		maxReports: 1,
+		reportTypes: { 'Move': false },
+	});
 	if (result.reports.length > 0) {
 		const report = result.reports[0];
 
@@ -927,3 +932,16 @@ async function replaceRegExpProto (execSupplier, fn) {
  * @property {CapturingGroup} group
  * @property {number} number - Note: Starts at 1.
  */
+
+/**
+ * @typedef {object} ForEachPatternCallbackValue
+ * @property {RegExp} pattern
+ * @property {LiteralAST} ast
+ * @property {string} tokenPath
+ * @property {string} name
+ * @property {any} parent
+ * @property {boolean} lookbehind
+ * @property {CapturingGroup | undefined} lookbehindGroup
+ * @property {PathItem[]} path
+ * @property {(message: string) => void} reportError
+ */

tests/plugins/copy-to-clipboard/basic-functionality.js

@@ -20,7 +20,7 @@ class DummyClipboard {
 	 * @param {Navigator} navigator
 	 */
 	assign (navigator) {
-		navigator.clipboard = this;
+		/** @type {any} */ (navigator).clipboard = this;
 	}
 }