cspell/src/wordListHelper.ts

A Spelling Checker for Code!

// cSpell:enableCompoundWords
import { Observable, from } from 'rxjs';
import { catchError } from 'rxjs/operators';
import * as Text from './util/text';
import { lineReader } from './util/fileReader';
import * as XRegExp from 'xregexp';


const regExpWordsWithSpaces = XRegExp('^\\s*\\p{L}+(?:\\s+\\p{L}+){0,3}$');

export interface WordDictionary {
    [index: string]: boolean;
}

export type WordSet = Set<string>;

export function loadWordsRx(filename: string): Observable<string> {
    return lineReader(filename).pipe(catchError((e: any) => {
        logError(e);
        return from<string>([]);
    }));
}

function logError(e: any) {
    console.log(e);
}

export function splitLine(line: string) {
    return Text.extractWordsFromText(line).map(({text}) => text).toArray();
}

export function splitCodeWords(words: string[]) {
    return words
        .map(Text.splitCamelCaseWord)
        .reduce((a, b) => a.concat(b), []);
}

export function splitLineIntoCodeWordsRx(line: string): Observable<string> {
    const asMultiWord = regExpWordsWithSpaces.test(line) ? [ line ] : [];
    const asWords = splitLine(line);
    const splitWords = splitCodeWords(asWords);
    const wordsToAdd = new Set([...asMultiWord, ...asWords, ...splitWords]);
    return from([...wordsToAdd]);
}

export function splitLineIntoWordsRx(line: string): Observable<string> {
    const asWords = splitLine(line);
    const wordsToAdd = [line, ...asWords];
    return from(wordsToAdd);
}