Initial import with skill sheet working

node_modules/are-docs-informative/lib/index.cjs

@@ -0,0 +1,56 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  areDocsInformative: () => areDocsInformative
+});
+module.exports = __toCommonJS(src_exports);
+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);
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  areDocsInformative
+});

node_modules/are-docs-informative/lib/index.d.cts

@@ -0,0 +1,57 @@
+interface InformativeDocsOptions {
+    /**
+     * Words that can be considered synonyms (aliases) of each other.
+     *
+     * @default
+     * ```json
+     * {
+     *   "a": ["an", "our"]
+     * }
+     * ```
+     *
+     * @example
+     * With `{ aliases: { emoji: ["smiley", "winkey"] } }`,
+     * the following comment would be considered uninformative:
+     * ```js
+     * /** Default smiley/winkey. *\/
+     * export const defaultSmiley = "🙂";
+     * ```
+     */
+    aliases?: Record<string, string[]>;
+    /**
+     * Words that are ignored when searching for one that adds meaning.
+     *
+     * @default
+     * ```json
+     * ["a", "an", "i", "in", "of", "s", "the"]
+     * ```
+     *
+     * @example
+     * With `{ uselessWords: ["our"] }`, the following comment would
+     * be considered uninformative:
+     * ```js
+     * /** Our text. *\/
+     * export const text = ":)";
+     * ```
+     */
+    uselessWords?: string[];
+}
+
+/**
+ * @param docs - Any amount of docs text, such as from a JSDoc description.
+ * @param name - Name of the entity the docs text is describing.
+ * @param options - Additional options to customize informativity checking.
+ * @returns Whether the docs include at least one word with new information.
+ *
+ * @example
+ * ```js
+ * areDocsInformative("The user id.", "userId"); // false
+ * ```
+ * @example
+ * ```js
+ * areDocsInformative("Retrieved user id.", "userId"); // true
+ * ```
+ */
+declare function areDocsInformative(docs: string | string[], name: string | string[], { aliases, uselessWords, }?: InformativeDocsOptions): boolean;
+
+export { InformativeDocsOptions, areDocsInformative };

node_modules/are-docs-informative/lib/index.d.ts

@@ -0,0 +1,57 @@
+interface InformativeDocsOptions {
+    /**
+     * Words that can be considered synonyms (aliases) of each other.
+     *
+     * @default
+     * ```json
+     * {
+     *   "a": ["an", "our"]
+     * }
+     * ```
+     *
+     * @example
+     * With `{ aliases: { emoji: ["smiley", "winkey"] } }`,
+     * the following comment would be considered uninformative:
+     * ```js
+     * /** Default smiley/winkey. *\/
+     * export const defaultSmiley = "🙂";
+     * ```
+     */
+    aliases?: Record<string, string[]>;
+    /**
+     * Words that are ignored when searching for one that adds meaning.
+     *
+     * @default
+     * ```json
+     * ["a", "an", "i", "in", "of", "s", "the"]
+     * ```
+     *
+     * @example
+     * With `{ uselessWords: ["our"] }`, the following comment would
+     * be considered uninformative:
+     * ```js
+     * /** Our text. *\/
+     * export const text = ":)";
+     * ```
+     */
+    uselessWords?: string[];
+}
+
+/**
+ * @param docs - Any amount of docs text, such as from a JSDoc description.
+ * @param name - Name of the entity the docs text is describing.
+ * @param options - Additional options to customize informativity checking.
+ * @returns Whether the docs include at least one word with new information.
+ *
+ * @example
+ * ```js
+ * areDocsInformative("The user id.", "userId"); // false
+ * ```
+ * @example
+ * ```js
+ * areDocsInformative("Retrieved user id.", "userId"); // true
+ * ```
+ */
+declare function areDocsInformative(docs: string | string[], name: string | string[], { aliases, uselessWords, }?: InformativeDocsOptions): boolean;
+
+export { InformativeDocsOptions, areDocsInformative };

node_modules/are-docs-informative/lib/index.js

@@ -0,0 +1,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
+};