chore: clean up README

Remove external references from dictionary info.
streetsidesoftware · Jan 3, 2025 · 99dcf07 · 99dcf07
1 parent 94c55c6
commit 99dcf07
Show file tree

Hide file tree

Showing 4 changed files with 156 additions and 625 deletions.
diff --git a/scripts/lib/dictionaryInfo.mjs b/scripts/lib/dictionaryInfo.mjs
@@ -61,6 +61,10 @@ export async function fetchDictionaryInfo(dictURL) {
     /** @type {CSpellSettings} */
     const cspellExt = extConfigFile.settings;
     const isBundle = extractImports(cspellExt).filter((i) => i.startsWith('@cspell/')).length > 2 || undefined;
+    // Remove package imports from the list of imports.
+    extConfigFile.settings.import = Array.isArray(extConfigFile.settings.import)
+        ? extConfigFile.settings.import.filter((i) => i.startsWith('./'))
+        : extConfigFile.settings.import;
     const dictionaries = await extractDictionaryInfo(extConfigFile);
     const hasEnabledByDefault = dictionaries.some((d) => d.enabled) || undefined;
     return {

diff --git a/scripts/lib/packageInfoToMarkdown.mjs b/scripts/lib/packageInfoToMarkdown.mjs
@@ -90,7 +90,7 @@ function listDictionaryIds(packages) {
         const cspell = dict.pkg.cspell ? ' <sup>1</sup>' : '';
         const enabled = dict.enabled ? ' <sup>2</sup>' : '';
         const locales = dict.locales ? `${dict.locales.sort().join('<br>')}` : '-';
-        const fileTypes = dict.fileTypes ? `${dict.fileTypes.sort().join('<br>')}` : '-';
+        const fileTypes = dict.fileTypes ? `${take(4, dict.fileTypes.sort()).join('<br>')}` : '-';
         // | Name | Description | Locale | File Type |
         md += `| [\`${dict.name}\`](${dict.pkg.dir})${cspell}${enabled} | ${dict.description} | ${locales} | ${fileTypes} |\n`;
     }
@@ -179,3 +179,17 @@ function groupByCategory(packages) {
     }
     return byCategory;
 }
+
+/**
+ *
+ * @param {number} n
+ * @param {string[]} arr
+ * @returns {string[]}
+ */
+function take(n, arr) {
+    const result = arr.slice(0, n);
+    if (result.length < arr.length) {
+        result.push('...');
+    }
+    return result;
+}