material-icon-theme 4.26.0 → 4.27.0

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

@@ -1,215 +0,0 @@
-import { readdir } from 'fs';
-import { join, parse } from 'path';
-import {
-  DefaultIcon,
-  FileIcon,
-  FolderIcon,
-  FolderTheme,
-} from '../../../models/index';
-import { green, red } 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 = 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 = parse(file).name;
-    availableIcons[iconName] = fileName;
-  });
-
-  // check icon configurations
-  checkFileIcons();
-  checkFolderIcons();
-  checkLanguageIcons();
-
-  // show error messages
-  handleErrors();
-};
-
-// read from the file system
-export const check = () => 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:',
-      red(`Found ${amountOfErrors} error(s) in the icon configuration!`)
-    );
-  } else {
-    console.log(
-      '> Material Icon Theme:',
-      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 ${green(suggestion)}?)`
-      : '';
-    const isWrongLightVersion = icon.endsWith(lightColorFileEnding);
-    const isWrongLightVersionString = isWrongLightVersion
-      ? ` (There is no light icon for ${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 ${green(
-          icon.slice(0, -13)
-        )}! Set the highContrast option to false!)`
-      : '';
-    console.log(
-      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,152 +0,0 @@
-import { green, red } 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:', red('Icon conflicts:'));
-    console.log(red('--------------------------------------'));
-
-    printErrorMessage(allConflicts.fileIcons.fileExtensions, 'fileExtension');
-    printErrorMessage(allConflicts.fileIcons.fileNames, 'fileName');
-    printErrorMessage(allConflicts.folderIcons, 'folderName');
-    printErrorMessage(allConflicts.languageIcons, 'languageId');
-
-    console.log('\n' + red('Please check the wrong icon configurations!\n'));
-    process.exit(1);
-  } else {
-    console.log(
-      '> Material Icon Theme:',
-      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(
-      red(
-        `For ${definitionType} "${key}" are ${
-          conflictIcons.length
-        } icons defined: [${conflictIcons.join(', ')}]`
-      )
-    );
-  });
-};

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

@@ -1,137 +0,0 @@
-import { readdir } from 'fs';
-import { join, parse } from 'path';
-import { DefaultIcon, FolderIcon, FolderTheme } from '../../../models/index';
-import { green, red } from '../../helpers/painter';
-import {
-  fileIcons,
-  folderIcons,
-  highContrastColorFileEnding,
-  languageIcons,
-  lightColorFileEnding,
-  openedFolder,
-} from './../../../icons';
-
-/**
- * Defines the folder where all icon files are located.
- */
-const folderPath = join('icons');
-
-/**
- * Defines an array with all icons that can be found in the file system.
- */
-const availableIcons: { [s: string]: string } = {};
-
-/**
- * Get all icon file names from the file system.
- */
-const fsReadAllIconFiles = (
-  error: NodeJS.ErrnoException | null,
-  files: string[]
-) => {
-  if (error) {
-    throw Error(error.message);
-  }
-
-  files.forEach((file) => {
-    const fileName = file;
-    const iconName = parse(file).name;
-    availableIcons[iconName] = fileName;
-  });
-
-  checkUsageOfAllIcons();
-  handleErrors();
-};
-
-const checkUsageOfAllIcons = () => {
-  const usedFileIcons: string[] = getAllUsedFileIcons();
-  const usedFolderIcons: string[] = getAllUsedFolderIcons();
-  const usedLanguageIcons: string[] = getAllUsedLanguageIcons();
-
-  [...usedFileIcons, ...usedFolderIcons, ...usedLanguageIcons].forEach(
-    (icon) => {
-      delete availableIcons[icon];
-    }
-  );
-};
-
-const handleErrors = () => {
-  const amountOfUnusedIcons = Object.keys(availableIcons).length;
-  if (amountOfUnusedIcons === 0) {
-    console.log('> Material Icon Theme:', green('Passed icon usage checks!'));
-  } else {
-    console.log(
-      '> Material Icon Theme: ' + red(`${amountOfUnusedIcons} unused icon(s):`)
-    );
-    Object.keys(availableIcons).forEach((icon) => {
-      console.log(red(`- ${availableIcons[icon]}`));
-    });
-    throw new Error('Found unused icon files!');
-  }
-};
-
-// read from the file system
-export const check = () => readdir(folderPath, fsReadAllIconFiles);
-
-const getAllUsedFileIcons = (): string[] => {
-  return [
-    fileIcons.defaultIcon.name,
-    fileIcons.defaultIcon.light
-      ? fileIcons.defaultIcon.name + lightColorFileEnding
-      : '',
-    fileIcons.defaultIcon.highContrast
-      ? fileIcons.defaultIcon.name + highContrastColorFileEnding
-      : '',
-    ...fileIcons.icons.map((icon) => icon.name),
-    ...fileIcons.icons
-      .filter((icon) => icon.light)
-      .map((icon) => icon.name + lightColorFileEnding),
-    ...fileIcons.icons
-      .filter((icon) => icon.highContrast)
-      .map((icon) => icon.name + highContrastColorFileEnding),
-  ].filter((f) => f !== '');
-};
-
-const getAllUsedFolderIcons = (): string[] => {
-  const icons = folderIcons
-    .map((theme) => (theme.name === 'none' ? [] : getAllFolderIcons(theme)))
-    .reduce((a, b) => a.concat(b));
-  return icons
-    .map((icon) => {
-      return [
-        icon.name,
-        icon.name + openedFolder,
-        icon.light ? icon.name + lightColorFileEnding : '',
-        icon.light ? icon.name + openedFolder + lightColorFileEnding : '',
-        icon.highContrast ? icon.name + highContrastColorFileEnding : '',
-        icon.highContrast
-          ? icon.name + openedFolder + highContrastColorFileEnding
-          : '',
-      ];
-    })
-    .filter((icon) => icon !== undefined)
-    .reduce((a, b) => a.concat(b));
-};
-
-const getAllFolderIcons = (
-  theme: FolderTheme
-): (FolderIcon | DefaultIcon)[] => {
-  const icons = theme.icons || [];
-  const allFolderIcons = [theme.defaultIcon, ...icons];
-  if (theme.rootFolder) {
-    allFolderIcons.push(theme.rootFolder);
-  }
-  return allFolderIcons;
-};
-
-const getAllUsedLanguageIcons = (): string[] => {
-  const icons = [
-    ...languageIcons.map((lang) => lang.icon.name),
-    ...languageIcons
-      .filter((lang) => lang.icon.light)
-      .map((lang) => lang.icon.name + lightColorFileEnding),
-    ...languageIcons
-      .filter((lang) => lang.icon.highContrast)
-      .map((lang) => lang.icon.name + highContrastColorFileEnding),
-  ];
-  return icons;
-};

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

@@ -1,7 +0,0 @@
-import { check as checkAvailability } from './checkIconAvailability';
-import { check as checkIconConflicts } from './checkIconConflicts';
-import { check as checkIconUsage } from './checkIconUsage';
-
-checkAvailability();
-checkIconUsage();
-checkIconConflicts();

package/src/scripts/icons/generateJson.ts

@@ -1,11 +0,0 @@
-/**
- * This file is meant to be executed exclusively by npm scripts.
- */
-import { createIconFile } from './../../icons/index';
-
-try {
-  createIconFile();
-} catch (error) {
-  console.error(error);
-  throw Error('Could not create icon file!');
-}

package/src/scripts/preview/index.ts

@@ -1,40 +0,0 @@
-import { fileIcons } from './../../icons/fileIcons';
-import { folderIcons } from './../../icons/folderIcons';
-import { languageIcons } from './../../icons/languageIcons';
-import { generatePreview } from './preview';
-
-const filterDuplicates = (icons: string[]) => {
-  return [...new Set(icons)];
-};
-
-const basicFileIcons = filterDuplicates(
-  fileIcons.icons
-    .map((i) => i.name)
-    // merge language icons
-    .concat(languageIcons.map((i) => i.icon.name))
-).map((i) => ({ iconName: i, label: i }));
-
-const folderThemes = filterDuplicates(
-  folderIcons
-    .map((theme) => {
-      const folders = [];
-      if (theme.icons && theme.icons.length > 0) {
-        folders.push(...theme.icons.map((i) => i.name));
-      }
-      return [...folders];
-    })
-    .reduce((a, b) => a.concat(b))
-).map((i) => ({ iconName: i, label: i.replace('folder-', '') }));
-
-generatePreview('fileIcons', basicFileIcons, 5, [
-  'virtual',
-  'powerpoint',
-  'word',
-  'credits',
-]);
-generatePreview('folderIcons', folderThemes, 5, [
-  'folder-aurelia',
-  'folder-phpmailer',
-  'folder-syntax',
-  'folder-ansible',
-]);