cspell-lib/dist/lib/wordListHelper.js

A library of useful functions used across various cspell tools.

// cSpell:enableCompoundWords
import { readLines } from './util/fileReader.js';
import { concatIterables, toIterableIterator } from './util/iterableIteratorLib.js';
import { logError } from './util/logger.js';
import * as Text from './util/text.js';
import { toFileUrl } from './util/url.js';
const regExpWordsWithSpaces = /^\s*\p{L}+(?:\s+\p{L}+){0,3}$/u;
/**
 * Reads words from a file. It will not throw and error.
 * @param filename the file to read
 */
export function loadWordsNoError(filename) {
    const url = toFileUrl(filename);
    return readLines(url).catch((e) => (logError(e), toIterableIterator([])));
}
export function splitLine(line) {
    return [...Text.extractWordsFromText(line)].map(({ text }) => text);
}
export function splitCodeWords(words) {
    return words.flatMap(Text.splitCamelCaseWord);
}
export function splitLineIntoCodeWords(line) {
    const asMultiWord = regExpWordsWithSpaces.test(line) ? [line] : [];
    const asWords = splitLine(line);
    const splitWords = splitCodeWords(asWords);
    const wordsToAdd = new Set(concatIterables(asMultiWord, asWords, splitWords));
    return toIterableIterator(wordsToAdd);
}
export function splitLineIntoWords(line) {
    const asWords = splitLine(line);
    return concatIterables([line], asWords);
}
//# sourceMappingURL=wordListHelper.js.map