summaryrefslogtreecommitdiff
path: root/tools/node_modules/eslint/node_modules/are-docs-informative/lib/index.js
blob: 41ff25e42d020dd588bb31dd342971990f6cc472 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
// src/index.ts
var defaultAliases = {
  a: ["an", "our"]
};
var defaultUselessWords = ["a", "an", "i", "in", "of", "s", "the"];
function areDocsInformative(docs, name, {
  aliases = defaultAliases,
  uselessWords = defaultUselessWords
} = {}) {
  const docsWords = new Set(splitTextIntoWords(docs));
  const nameWords = splitTextIntoWords(name);
  for (const nameWord of nameWords) {
    docsWords.delete(nameWord);
  }
  for (const uselessWord of uselessWords) {
    docsWords.delete(uselessWord);
  }
  return !!docsWords.size;
  function normalizeWord(word) {
    const wordLower = word.toLowerCase();
    return aliases[wordLower] ?? wordLower;
  }
  function splitTextIntoWords(text) {
    return (typeof text === "string" ? [text] : text).flatMap((name2) => {
      return name2.replace(/\W+/gu, " ").replace(/([a-z])([A-Z])/gu, "$1 $2").trim().split(" ");
    }).flatMap(normalizeWord).filter(Boolean);
  }
}
export {
  areDocsInformative
};