material-icon-theme 3.7.1 → 4.15.0

package/src/scripts/icons/checks/checkIconAvailability.ts

@@ -1,151 +1,215 @@
-import * as fs from 'fs';
-import * as path from 'path';
-import { DefaultIcon, FileIcon, FolderIcon, FolderTheme } from '../../../models/index';
-import * as painter from '../../helpers/painter';
-import { similarity } from '../../helpers/similarity';
-import { fileIcons, folderIcons, highContrastVersion, languageIcons, lightVersion, openedFolder } from './../../../icons';
-
-/**
- * Defines the folder where all icon files are located.
- */
-const folderPath = path.join('icons');
-
-/**
- * Defines an array with all icons that can be found in the file system.
- */
-const availableIcons: { [s: string]: string } = {};
-
-/**
- * Save the misconfigured icons.
- */
-const wrongIconNames: { [s: string]: string[] } = { fileIcons: [], folderIcons: [], languageIcons: [] };
-
-/**
- * Get all icon file names from the file system.
- */
-const fsReadAllIconFiles = (err: Error, files: string[]) => {
-    if (err) {
-        throw Error(err.message);
-    }
-
-    files.forEach(file => {
-        const fileName = file;
-        const iconName = path.parse(file).name;
-        availableIcons[iconName] = fileName;
-    });
-
-    // check icon configurations
-    checkFileIcons();
-    checkFolderIcons();
-    checkLanguageIcons();
-
-    // show error messages
-    handleErrors();
-};
-
-// read from the file system
-export const check = () => fs.readdir(folderPath, fsReadAllIconFiles);
-
-/**
- * Check if the file icons from the configuration are available on the file system.
- */
-const checkFileIcons = () => {
-    fileIcons.icons.concat([fileIcons.defaultIcon]).forEach(icon => {
-        isIconAvailable(icon, IconType.fileIcons, IconColor.default);
-        isIconAvailable(icon, IconType.fileIcons, IconColor.light);
-        isIconAvailable(icon, IconType.fileIcons, IconColor.highContrast);
-    });
-};
-
-const isIconAvailable = (icon: FileIcon | FolderIcon | DefaultIcon, iconType: IconType, iconColor: IconColor, hasOpenedFolder?: boolean) => {
-    const iconName = `${icon.name}${hasOpenedFolder ? openedFolder : ''}${icon[iconColor] ? iconColor === IconColor.light ? lightVersion : highContrastVersion ? highContrastVersion : '' : ''}`;
-    if (!availableIcons[iconName] && wrongIconNames[iconType].indexOf(iconName) === -1) {
-        wrongIconNames[iconType].push(iconName);
-    }
-};
-
-/**
- * Check if the folder icons from the configuration are available on the file system.
- */
-const checkFolderIcons = () => {
-    folderIcons.map(
-        theme => theme.name === 'none' ? [] : getAllFolderIcons(theme)
-    )
-        .reduce((a, b) => a.concat(b))
-        .forEach(icon => {
-            isIconAvailable(icon, IconType.folderIcons, IconColor.default);
-            isIconAvailable(icon, IconType.folderIcons, IconColor.default, true);
-            isIconAvailable(icon, IconType.folderIcons, IconColor.light);
-            isIconAvailable(icon, IconType.folderIcons, IconColor.light, true);
-            isIconAvailable(icon, IconType.folderIcons, IconColor.highContrast);
-            isIconAvailable(icon, IconType.folderIcons, IconColor.highContrast, true);
-        });
-};
-
-const getAllFolderIcons = (theme: FolderTheme) => {
-    const icons = theme.icons ? theme.icons : [];
-    return [
-        theme.defaultIcon,
-        theme.rootFolder,
-        ...icons
-    ].filter(icon => icon !== undefined); // filter undefined root folder icons
-};
-
-/**
- * Check if the language icons from the configuration are available on the file system.
- */
-const checkLanguageIcons = () => {
-    languageIcons.forEach(lang => {
-        const icon = lang.icon;
-        isIconAvailable(icon, IconType.languageIcons, IconColor.default);
-        isIconAvailable(icon, IconType.languageIcons, IconColor.light);
-        isIconAvailable(icon, IconType.languageIcons, IconColor.highContrast);
-    });
-};
-
-/**
- * Show error messages in the terminal.
- */
-const handleErrors = () => {
-    const amountOfErrors = wrongIconNames.fileIcons.length + wrongIconNames.folderIcons.length + wrongIconNames.languageIcons.length;
-    if (amountOfErrors > 0) {
-        console.log('> Material Icon Theme:', painter.red(`Found ${amountOfErrors} error(s) in the icon configuration!`));
-    } else {
-        console.log('> Material Icon Theme:', painter.green(`Passed icon availability checks!`));
-    }
-    logIconInformation(wrongIconNames.fileIcons, 'File icons');
-    logIconInformation(wrongIconNames.folderIcons, 'Folder icons');
-    logIconInformation(wrongIconNames.languageIcons, 'Language icons');
-
-    if (amountOfErrors > 0) {
-        throw new Error('Found some wrong file definitions in the icon configuration.');
-    }
-};
-
-const logIconInformation = (wrongIcons: string[], title: string) => {
-    if (wrongIcons.length === 0) return;
-    console.log(`\n${title}:\n--------------------------------`);
-    wrongIcons.forEach(icon => {
-        const suggestion = Object.keys(availableIcons).find((i) => {
-            return similarity(icon, i) > 0.75;
-        });
-        const suggestionString = suggestion ? ` (Did you mean ${painter.green(suggestion)}?)` : '';
-        const isWrongLightVersion = icon.endsWith(lightVersion);
-        const isWrongLightVersionString = isWrongLightVersion ? ` (There is no light icon for ${painter.green(icon.slice(0, -6))}! Set the light option to false!)` : '';
-        const isWrongHighContrastVersion = icon.endsWith(highContrastVersion);
-        const isWrongHighContrastVersionString = isWrongHighContrastVersion ? ` (There is no high contrast icon for ${painter.green(icon.slice(0, -13))}! Set the highContrast option to false!)` : '';
-        console.log(painter.red(`Icon not found: ${icon}.svg`) + `${suggestionString}${isWrongLightVersionString}${isWrongHighContrastVersionString}`);
-    });
-};
-
-enum IconType {
-    fileIcons = 'fileIcons',
-    folderIcons = 'folderIcons',
-    languageIcons = 'languageIcons'
-}
-
-enum IconColor {
-    default = 'default',
-    light = 'light',
-    highContrast = 'highContrast'
-}
+import * as fs from 'fs';
+import * as path from 'path';
+import {
+  DefaultIcon,
+  FileIcon,
+  FolderIcon,
+  FolderTheme,
+} from '../../../models/index';
+import * as painter from '../../helpers/painter';
+import { similarity } from '../../helpers/similarity';
+import {
+  fileIcons,
+  folderIcons,
+  highContrastColorFileEnding,
+  languageIcons,
+  lightColorFileEnding,
+  openedFolder,
+} from './../../../icons';
+
+/**
+ * Defines the folder where all icon files are located.
+ */
+const folderPath = path.join('icons');
+
+/**
+ * Defines an array with all icons that can be found in the file system.
+ */
+const availableIcons: Record<string, string> = {};
+
+/**
+ * Save the misconfigured icons.
+ */
+const wrongIconNames: Record<string, string[]> = {
+  fileIcons: [],
+  folderIcons: [],
+  languageIcons: [],
+};
+
+/**
+ * Get all icon file names from the file system.
+ */
+const fsReadAllIconFiles = (
+  err: NodeJS.ErrnoException | null,
+  files: string[]
+) => {
+  if (err) {
+    throw Error(err.message);
+  }
+
+  files.forEach((file) => {
+    const fileName = file;
+    const iconName = path.parse(file).name;
+    availableIcons[iconName] = fileName;
+  });
+
+  // check icon configurations
+  checkFileIcons();
+  checkFolderIcons();
+  checkLanguageIcons();
+
+  // show error messages
+  handleErrors();
+};
+
+// read from the file system
+export const check = () => fs.readdir(folderPath, fsReadAllIconFiles);
+
+/**
+ * Check if the file icons from the configuration are available on the file system.
+ */
+const checkFileIcons = () => {
+  [...fileIcons.icons, fileIcons.defaultIcon].forEach((icon) => {
+    isIconAvailable(icon, IconType.fileIcons, IconColor.default);
+    isIconAvailable(icon, IconType.fileIcons, IconColor.light);
+    isIconAvailable(icon, IconType.fileIcons, IconColor.highContrast);
+  });
+};
+
+const isIconAvailable = (
+  icon: FileIcon | FolderIcon | DefaultIcon,
+  iconType: IconType,
+  iconColor: IconColor,
+  hasOpenedFolder?: boolean
+) => {
+  let iconName = `${icon.name}${hasOpenedFolder ? openedFolder : ''}`;
+  if (icon.light && iconColor === IconColor.light) {
+    iconName += lightColorFileEnding;
+  }
+  if (icon.highContrast && iconColor === IconColor.highContrast) {
+    iconName += highContrastColorFileEnding;
+  }
+
+  if (
+    !availableIcons[iconName] &&
+    wrongIconNames[iconType].indexOf(iconName) === -1
+  ) {
+    wrongIconNames[iconType].push(iconName);
+  }
+};
+
+/**
+ * Check if the folder icons from the configuration are available on the file system.
+ */
+const checkFolderIcons = () => {
+  folderIcons
+    .map((theme) => (theme.name === 'none' ? [] : getAllFolderIcons(theme)))
+    .reduce((a, b) => a.concat(b))
+    .forEach((icon) => {
+      if (icon) {
+        isIconAvailable(icon, IconType.folderIcons, IconColor.default);
+        isIconAvailable(icon, IconType.folderIcons, IconColor.default, true);
+        isIconAvailable(icon, IconType.folderIcons, IconColor.light);
+        isIconAvailable(icon, IconType.folderIcons, IconColor.light, true);
+        isIconAvailable(icon, IconType.folderIcons, IconColor.highContrast);
+        isIconAvailable(
+          icon,
+          IconType.folderIcons,
+          IconColor.highContrast,
+          true
+        );
+      }
+    });
+};
+
+const getAllFolderIcons = (theme: FolderTheme) => {
+  const icons = theme.icons ? theme.icons : [];
+  return [theme.defaultIcon, theme.rootFolder, ...icons].filter(
+    (icon) => icon !== undefined
+  ); // filter undefined root folder icons
+};
+
+/**
+ * Check if the language icons from the configuration are available on the file system.
+ */
+const checkLanguageIcons = () => {
+  languageIcons.forEach((lang) => {
+    const icon = lang.icon;
+    isIconAvailable(icon, IconType.languageIcons, IconColor.default);
+    isIconAvailable(icon, IconType.languageIcons, IconColor.light);
+    isIconAvailable(icon, IconType.languageIcons, IconColor.highContrast);
+  });
+};
+
+/**
+ * Show error messages in the terminal.
+ */
+const handleErrors = () => {
+  const amountOfErrors =
+    wrongIconNames.fileIcons.length +
+    wrongIconNames.folderIcons.length +
+    wrongIconNames.languageIcons.length;
+  if (amountOfErrors > 0) {
+    console.log(
+      '> Material Icon Theme:',
+      painter.red(`Found ${amountOfErrors} error(s) in the icon configuration!`)
+    );
+  } else {
+    console.log(
+      '> Material Icon Theme:',
+      painter.green('Passed icon availability checks!')
+    );
+  }
+  logIconInformation(wrongIconNames.fileIcons, 'File icons');
+  logIconInformation(wrongIconNames.folderIcons, 'Folder icons');
+  logIconInformation(wrongIconNames.languageIcons, 'Language icons');
+
+  if (amountOfErrors > 0) {
+    throw new Error(
+      'Found some wrong file definitions in the icon configuration.'
+    );
+  }
+};
+
+const logIconInformation = (wrongIcons: string[], title: string) => {
+  if (wrongIcons.length === 0) return;
+  console.log(`\n${title}:\n--------------------------------`);
+  wrongIcons.forEach((icon) => {
+    const suggestion = Object.keys(availableIcons).find((i) => {
+      return similarity(icon, i) > 0.75;
+    });
+    const suggestionString = suggestion
+      ? ` (Did you mean ${painter.green(suggestion)}?)`
+      : '';
+    const isWrongLightVersion = icon.endsWith(lightColorFileEnding);
+    const isWrongLightVersionString = isWrongLightVersion
+      ? ` (There is no light icon for ${painter.green(
+          icon.slice(0, -6)
+        )}! Set the light option to false!)`
+      : '';
+    const isWrongHighContrastVersion = icon.endsWith(
+      highContrastColorFileEnding
+    );
+    const isWrongHighContrastVersionString = isWrongHighContrastVersion
+      ? ` (There is no high contrast icon for ${painter.green(
+          icon.slice(0, -13)
+        )}! Set the highContrast option to false!)`
+      : '';
+    console.log(
+      painter.red(`Icon not found: ${icon}.svg`) +
+        `${suggestionString}${isWrongLightVersionString}${isWrongHighContrastVersionString}`
+    );
+  });
+};
+
+enum IconType {
+  fileIcons = 'fileIcons',
+  folderIcons = 'folderIcons',
+  languageIcons = 'languageIcons',
+}
+
+enum IconColor {
+  default = 'default',
+  light = 'light',
+  highContrast = 'highContrast',
+}

package/src/scripts/icons/checks/checkIconConflicts.ts

@@ -1,115 +1,154 @@
-import * as painter from '../../helpers/painter';
-import { fileIcons, folderIcons, languageIcons } from './../../../icons';
-
-/**
- * Store all icons that are wrong configured
- */
-const allConflicts = {
-    fileIcons: {
-        fileExtensions: {},
-        fileNames: {}
-    },
-    folderIcons: {},
-    languageIcons: {}
-};
-
-export const check = () => {
-    checkFolderIcons();
-    checkFileIcons();
-    checkLanguageIcons();
-
-    handleErrors();
-};
-
-const checkFileIcons = () => {
-    checkForConflictsInFileIcons('fileExtensions');
-    checkForConflictsInFileIcons('fileNames');
-};
-
-const checkForConflictsInFileIcons = (fileIconDefinitionType: string) => {
-    const icons = {};
-    fileIcons.icons.forEach(icon => {
-        if (!icon[fileIconDefinitionType]) return {};
-        icon[fileIconDefinitionType].forEach(ext => {
-            if (!icons[ext] || icon.enabledFor && icon.enabledFor.length > 0) {
-                icons[ext] = icon.name;
-            }
-            else {
-                if (!allConflicts.fileIcons[fileIconDefinitionType][ext]) {
-                    allConflicts.fileIcons[fileIconDefinitionType][ext] = [icons[ext], icon.name];
-                } else {
-                    allConflicts.fileIcons[fileIconDefinitionType][ext].push(icon.name);
-                }
-            }
-        });
-    });
-};
-
-const checkFolderIcons = () => {
-    folderIcons.forEach(theme => {
-        if (!theme.icons) return;
-        const icons = {};
-        theme.icons.forEach(icon => {
-            icon.folderNames.forEach(folderName => {
-                if (!icons[folderName] || icon.enabledFor && icon.enabledFor.length > 0) {
-                    icons[folderName] = icon.name;
-                }
-                else {
-                    if (!allConflicts.folderIcons[folderName]) {
-                        allConflicts.folderIcons[folderName] = [icons[folderName], icon.name];
-                    } else {
-                        allConflicts.folderIcons[folderName].push(icon.name);
-                    }
-                }
-            });
-        });
-    });
-};
-
-const checkLanguageIcons = () => {
-    const icons = {};
-    languageIcons.forEach(langIcon => {
-        langIcon.ids.forEach(id => {
-            if (!icons[id]) {
-                icons[id] = langIcon.icon.name;
-            }
-            else {
-                if (!allConflicts.languageIcons[id]) {
-                    allConflicts.languageIcons[id] = [icons[id], langIcon.icon.name];
-                } else {
-                    allConflicts.languageIcons[id].push(langIcon.icon.name);
-                }
-            }
-        });
-    });
-};
-
-const handleErrors = () => {
-    if ([
-        ...Object.keys(allConflicts.fileIcons.fileExtensions),
-        ...Object.keys(allConflicts.fileIcons.fileNames),
-        ...Object.keys(allConflicts.folderIcons),
-        ...Object.keys(allConflicts.languageIcons)].length > 0
-    ) {
-        console.log('> Material Icon Theme:', painter.red('Icon conflicts:'));
-        console.log(painter.red('--------------------------------------'));
-
-        printErrorMessage(allConflicts.fileIcons.fileExtensions, 'fileExtension');
-        printErrorMessage(allConflicts.fileIcons.fileNames, 'fileName');
-        printErrorMessage(allConflicts.folderIcons, 'folderName');
-        printErrorMessage(allConflicts.languageIcons, 'languageId');
-
-        console.log('\n' + painter.red('Please check the wrong icon configurations!\n'));
-    }
-    else {
-        console.log('> Material Icon Theme:', painter.green(`Passed icon conflict checks!`));
-    }
-};
-
-const printErrorMessage = (icons: any, definitionType: string) => {
-    const keys = Object.keys(icons);
-    keys.forEach(key => {
-        const conflictIcons = icons[key];
-        console.log(painter.red(`For ${definitionType} "${key}" are ${conflictIcons.length} icons defined: [${conflictIcons.join(', ')}]`));
-    });
-};
+import * as painter from '../../helpers/painter';
+import { fileIcons, folderIcons, languageIcons } from './../../../icons';
+
+/**
+ * Store all icons that are wrong configured
+ */
+const allConflicts: {
+  fileIcons: {
+    fileExtensions: Record<string, string[]>;
+    fileNames: Record<string, string[]>;
+  };
+  folderIcons: Record<string, string[]>;
+  languageIcons: Record<string, string[]>;
+} = {
+  fileIcons: {
+    fileExtensions: {},
+    fileNames: {},
+  },
+  folderIcons: {},
+  languageIcons: {},
+};
+
+export const check = () => {
+  checkFolderIcons();
+  checkFileIcons();
+  checkLanguageIcons();
+
+  handleErrors();
+};
+
+const checkFileIcons = () => {
+  checkForConflictsInFileIcons('fileExtensions');
+  checkForConflictsInFileIcons('fileNames');
+};
+
+const checkForConflictsInFileIcons = (
+  fileIconDefinitionType: 'fileExtensions' | 'fileNames'
+) => {
+  const icons: Record<string, string> = {};
+  fileIcons.icons.forEach((icon) => {
+    if (!icon[fileIconDefinitionType]) return;
+    (icon[fileIconDefinitionType] ?? [])
+      .map((d) => d.toLowerCase())
+      .forEach((definition) => {
+        if (
+          !icons[definition] ||
+          (icon.enabledFor && icon.enabledFor.length > 0)
+        ) {
+          icons[definition] = icon.name;
+        } else {
+          if (!allConflicts.fileIcons[fileIconDefinitionType][definition]) {
+            allConflicts.fileIcons[fileIconDefinitionType][definition] = [
+              icons[definition],
+              icon.name,
+            ];
+          } else {
+            allConflicts.fileIcons[fileIconDefinitionType][definition].push(
+              icon.name
+            );
+          }
+        }
+      });
+  });
+};
+
+const checkFolderIcons = () => {
+  folderIcons.forEach((theme) => {
+    if (!theme.icons) return;
+    const icons: Record<string, string> = {};
+    theme.icons.forEach((icon) => {
+      icon.folderNames
+        .map((f) => f.toLowerCase())
+        .forEach((folderName) => {
+          if (
+            !icons[folderName] ||
+            (icon.enabledFor && icon.enabledFor.length > 0)
+          ) {
+            icons[folderName] = icon.name;
+          } else {
+            if (!allConflicts.folderIcons[folderName]) {
+              allConflicts.folderIcons[folderName] = [
+                icons[folderName],
+                icon.name,
+              ];
+            } else {
+              allConflicts.folderIcons[folderName].push(icon.name);
+            }
+          }
+        });
+    });
+  });
+};
+
+const checkLanguageIcons = () => {
+  const icons: Record<string, string> = {};
+  languageIcons.forEach((langIcon) => {
+    langIcon.ids
+      .map((id) => id.toLowerCase())
+      .forEach((id) => {
+        if (!icons[id]) {
+          icons[id] = langIcon.icon.name;
+        } else {
+          if (!allConflicts.languageIcons[id]) {
+            allConflicts.languageIcons[id] = [icons[id], langIcon.icon.name];
+          } else {
+            allConflicts.languageIcons[id].push(langIcon.icon.name);
+          }
+        }
+      });
+  });
+};
+
+const handleErrors = () => {
+  if (
+    [
+      ...Object.keys(allConflicts.fileIcons.fileExtensions),
+      ...Object.keys(allConflicts.fileIcons.fileNames),
+      ...Object.keys(allConflicts.folderIcons),
+      ...Object.keys(allConflicts.languageIcons),
+    ].length > 0
+  ) {
+    console.log('> Material Icon Theme:', painter.red('Icon conflicts:'));
+    console.log(painter.red('--------------------------------------'));
+
+    printErrorMessage(allConflicts.fileIcons.fileExtensions, 'fileExtension');
+    printErrorMessage(allConflicts.fileIcons.fileNames, 'fileName');
+    printErrorMessage(allConflicts.folderIcons, 'folderName');
+    printErrorMessage(allConflicts.languageIcons, 'languageId');
+
+    console.log(
+      '\n' + painter.red('Please check the wrong icon configurations!\n')
+    );
+    process.exit(1);
+  } else {
+    console.log(
+      '> Material Icon Theme:',
+      painter.green('Passed icon conflict checks!')
+    );
+  }
+};
+
+const printErrorMessage = (icons: any, definitionType: string) => {
+  const keys = Object.keys(icons);
+  keys.forEach((key) => {
+    const conflictIcons = icons[key];
+    console.log(
+      painter.red(
+        `For ${definitionType} "${key}" are ${
+          conflictIcons.length
+        } icons defined: [${conflictIcons.join(', ')}]`
+      )
+    );
+  });
+};