Move all utils for working with iterables to a separate module

LeaVerou · DmitrySharabin · commit 07ae50527a22 · 2025-06-20T17:45:54.000+02:00
Remove unused utils
diff --git a/scripts/build.ts b/scripts/build.ts
@@ -10,7 +10,7 @@ import MagicString from 'magic-string';
 import { rollup } from 'rollup';
 import ts from 'typescript';
 import { webfont } from 'webfont';
-import { toArray } from '../src/shared/util';
+import { toArray } from '../src/util/iterables';
 import { components } from './components';
 import { parallel, runTask, series } from './tasks';
 import type { ComponentProto } from '../src/types';
diff --git a/src/core/registry.ts b/src/core/registry.ts
@@ -1,5 +1,6 @@
 import { extend } from '../shared/language-util';
-import { forEach, kebabToCamelCase } from '../shared/util';
+import { kebabToCamelCase } from '../shared/util';
+import { forEach } from '../util/iterables';
 import type { ComponentProto, Grammar } from '../types';
 import type { Prism } from './prism';
 
diff --git a/src/languages/chaiscript.ts b/src/languages/chaiscript.ts
@@ -1,5 +1,5 @@
 import { insertBefore } from '../shared/language-util';
-import { toArray } from '../shared/util';
+import { toArray } from '../util/iterables';
 import clike from './clike';
 import cpp from './cpp';
 import type { LanguageProto } from '../types';
diff --git a/src/languages/crystal.ts b/src/languages/crystal.ts
@@ -1,5 +1,5 @@
 import { insertBefore } from '../shared/language-util';
-import { toArray } from '../shared/util';
+import { toArray } from '../util/iterables';
 import ruby from './ruby';
 import type { LanguageProto } from '../types';
 
diff --git a/src/languages/flow.ts b/src/languages/flow.ts
@@ -1,5 +1,5 @@
 import { insertBefore } from '../shared/language-util';
-import { toArray } from '../shared/util';
+import { toArray } from '../util/iterables';
 import javascript from './javascript';
 import type { GrammarToken, LanguageProto } from '../types';
 
diff --git a/src/languages/hlsl.ts b/src/languages/hlsl.ts
@@ -1,4 +1,4 @@
-import { toArray } from '../shared/util';
+import { toArray } from '../util/iterables';
 import c from './c';
 import type { LanguageProto } from '../types';
 
diff --git a/src/languages/java.ts b/src/languages/java.ts
@@ -1,5 +1,5 @@
 import { insertBefore } from '../shared/language-util';
-import { toArray } from '../shared/util';
+import { toArray } from '../util/iterables';
 import clike from './clike';
 import type { LanguageProto } from '../types';
 
diff --git a/src/languages/javascript.ts b/src/languages/javascript.ts
@@ -1,7 +1,7 @@
 import { insertBefore } from '../shared/language-util';
 import { JS_TEMPLATE, JS_TEMPLATE_INTERPOLATION } from '../shared/languages/patterns';
 import { rest } from '../shared/symbols';
-import { toArray } from '../shared/util';
+import { toArray } from '../util/iterables';
 import clike from './clike';
 import type { LanguageProto } from '../types';
 
diff --git a/src/languages/squirrel.ts b/src/languages/squirrel.ts
@@ -1,5 +1,5 @@
 import { insertBefore } from '../shared/language-util';
-import { toArray } from '../shared/util';
+import { toArray } from '../util/iterables';
 import clike from './clike';
 import type { LanguageProto } from '../types';
 
diff --git a/src/languages/typescript.ts b/src/languages/typescript.ts
@@ -1,5 +1,5 @@
 import { insertBefore } from '../shared/language-util';
-import { toArray } from '../shared/util';
+import { toArray } from '../util/iterables';
 import javascript from './javascript';
 import type { Grammar, LanguageProto } from '../types';
 
diff --git a/src/load-languages.ts b/src/load-languages.ts
@@ -1,6 +1,6 @@
 import { resolveAlias } from './shared/meta/alias-data';
 import { knownLanguages } from './shared/meta/all-languages-data';
-import { toArray } from './shared/util';
+import { toArray } from './util/iterables';
 import type { Prism } from './core';
 import type { ComponentProto } from './types';
 
diff --git a/src/plugins/autoloader/prism-autoloader.ts b/src/plugins/autoloader/prism-autoloader.ts
@@ -1,6 +1,6 @@
 import { getParentPre } from '../../shared/dom-util';
 import { resolveAlias } from '../../shared/meta/alias-data';
-import { toArray } from '../../shared/util';
+import { toArray } from '../../util/iterables';
 import type { Prism } from '../../core';
 import type { ComponentProto, PluginProto } from '../../types';
 
diff --git a/src/plugins/previewers/prism-previewers.ts b/src/plugins/previewers/prism-previewers.ts
@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
 import cssExtras from '../../languages/css-extras';
-import { forEach } from '../../shared/util';
+import { forEach } from '../../util/iterables';
 import type { PluginProto } from '../../types';
 
 /**
diff --git a/src/shared/util.ts b/src/shared/util.ts
@@ -42,44 +42,6 @@ export function regexEscape (string: string): string {
 	return string.replace(/([\\[\](){}+*?|^$.])/g, '\\$1');
 }
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-const isReadonlyArray: (arg: unknown) => arg is readonly any[] = Array.isArray;
-
-/**
- * Converts the given value to an array.
- *
- * If the given value is already an error, it will be returned as is.
- */
-export function toArray<T extends {}> (value: T | readonly T[] | undefined | null): readonly T[] {
-	if (isReadonlyArray(value)) {
-		return value;
-	}
-	else if (value == null) {
-		return [];
-	}
-	else {
-		return [value];
-	}
-}
-
-/**
- * Invokes the given callback for all elements of the given value.
- *
- * If the given value is an array, the callback will be invokes for all elements. If the given value is `null` or
- * `undefined`, the callback will not be invoked. In all other cases, the callback will be invoked with the given
- * value as parameter.
- */
-export function forEach<T extends {}> (
-	value: null | undefined | T | readonly T[],
-	callbackFn: (value: T, index: number) => void
-): void {
-	if (Array.isArray(value)) {
-		value.forEach(callbackFn);
-	}
-	else if (value != null) {
-		callbackFn(value as T, 0);
-	}
-}
 
 export function capitalize<T extends string> (string: T): Capitalize<T> {
 	// This is the internal implementation of `Capitalize<T>` by TS.
diff --git a/src/util/iterables.ts b/src/util/iterables.ts
@@ -0,0 +1,37 @@
+const isReadonlyArray: (arg: unknown) => arg is readonly any[] = Array.isArray;
+
+/**
+ * Converts the given value to an array.
+ *
+ * If the given value is already an error, it will be returned as is.
+ */
+export function toArray<T extends {}> (value: T | readonly T[] | undefined | null): readonly T[] {
+	if (isReadonlyArray(value)) {
+		return value;
+	}
+	else if (value == null) {
+		return [];
+	}
+	else {
+		return [value];
+	}
+}
+
+/**
+ * Invokes the given callback for all elements of the given value.
+ *
+ * If the given value is an array, the callback will be invokes for all elements. If the given value is `null` or
+ * `undefined`, the callback will not be invoked. In all other cases, the callback will be invoked with the given
+ * value as parameter.
+ */
+export function forEach<T extends {}> (
+	value: null | undefined | T | readonly T[],
+	callbackFn: (value: T, index: number) => void
+): void {
+	if (Array.isArray(value)) {
+		value.forEach(callbackFn);
+	}
+	else if (value != null) {
+		callbackFn(value as T, 0);
+	}
+}
diff --git a/tests/components-test.ts b/tests/components-test.ts
@@ -2,7 +2,8 @@ import { assert } from 'chai';
 import { readFileSync } from 'fs';
 import path from 'path';
 import { fileURLToPath } from 'url';
-import { forEach, noop, toArray } from '../src/shared/util';
+import { noop } from '../src/shared/util';
+import { forEach, toArray } from '../src/util/iterables';
 import { getComponent, getComponentIds, getLanguageIds } from './helper/prism-loader';
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
diff --git a/tests/helper/prism-loader.ts b/tests/helper/prism-loader.ts
@@ -2,7 +2,8 @@ import { readdirSync } from 'fs';
 import { JSDOM } from 'jsdom';
 import path from 'path';
 import { Prism } from '../../src/core/prism';
-import { isNonNull, lazy, noop, toArray } from '../../src/shared/util';
+import { isNonNull, lazy, noop } from '../../src/shared/util';
+import { toArray } from '../../src/util/iterables';
 import type { ComponentProto, LanguageProto, PluginProto } from '../../src/types';
 import type { DOMWindow } from 'jsdom';
 import { fileURLToPath } from 'url';
diff --git a/tests/identifier-test.ts b/tests/identifier-test.ts
@@ -1,5 +1,5 @@
 import { assert } from 'chai';
-import { toArray } from '../src/shared/util';
+import { toArray } from '../src/util/iterables';
 import { createInstance, getComponent, getLanguageIds } from './helper/prism-loader';
 import { prettyprint } from './helper/token-stream-transformer';
 import type { Prism, Token } from '../src/core';
diff --git a/tests/pattern-tests.ts b/tests/pattern-tests.ts
@@ -12,7 +12,8 @@ import {
 import * as RAA from 'regexp-ast-analysis';
 import { visitRegExpAST } from 'regexpp';
 import * as scslre from 'scslre';
-import { lazy, toArray } from '../src/shared/util';
+import { lazy } from '../src/shared/util';
+import { toArray } from '../src/util/iterables';
 import * as args from './helper/args';
 import { createInstance, getComponent, getLanguageIds } from './helper/prism-loader';
 import { TestCaseFile, parseLanguageNames } from './helper/test-case';

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { toArray } from '../shared/util';`
	`1`	`+import { toArray } from '../util/iterables';`
`2`	`2`	`import c from './c';`
`3`	`3`	`import type { LanguageProto } from '../types';`
`4`	`4`