material-icon-theme 4.26.0 → 4.28.0

package/src/icons/generator/constants.ts

@@ -1,29 +0,0 @@
-/**
- * Path where the icons are located.
- */
-export const iconFolderPath: string = './../icons/';
-
-/**
- * File name of the JSON file that will be generated to the out folder.
- */
-export const iconJsonName: string = 'material-icons.json';
-
-/**
- * File ending for opened folders.
- */
-export const openedFolder: string = '-open';
-
-/**
- * File ending for light icons.
- */
-export const lightColorFileEnding: string = '_light';
-
-/**
- * File ending for high contrast icons.
- */
-export const highContrastColorFileEnding: string = '_highContrast';
-
-/**
- * Pattern to match wildcards for custom file icon mappings.
- */
-export const wildcardPattern = new RegExp(/^\*{1,2}\./);

package/src/icons/generator/fileGenerator.ts

@@ -1,233 +0,0 @@
-import merge from 'lodash.merge';
-import { getFileConfigHash } from '../../helpers/fileConfig';
-import {
-  FileIcon,
-  FileIcons,
-  IconAssociations,
-  IconConfiguration,
-  IconJsonOptions,
-} from '../../models/index';
-import {
-  highContrastColorFileEnding,
-  iconFolderPath,
-  lightColorFileEnding,
-  wildcardPattern,
-} from './constants';
-import {
-  validateHEXColorCode,
-  writeSVGFiles,
-  getSVG,
-  getPath,
-} from './folderGenerator';
-
-/**
- * Get all file icons that can be used in this theme.
- */
-export const loadFileIconDefinitions = (
-  fileIcons: FileIcons,
-  config: IconConfiguration,
-  options: IconJsonOptions
-): IconConfiguration => {
-  config = merge({}, config);
-  const enabledIcons = disableIconsByPack(
-    fileIcons,
-    options.activeIconPack ?? ''
-  );
-  const customIcons = getCustomIcons(options.files?.associations);
-  const allFileIcons = [...enabledIcons, ...customIcons];
-
-  allFileIcons.forEach((icon) => {
-    if (icon.disabled) return;
-    config = merge({}, config, setIconDefinition(config, icon.name));
-
-    if (icon.light) {
-      config = merge(
-        {},
-        config,
-        setIconDefinition(config, icon.name, lightColorFileEnding)
-      );
-    }
-    if (icon.highContrast) {
-      config = merge(
-        {},
-        config,
-        setIconDefinition(config, icon.name, highContrastColorFileEnding)
-      );
-    }
-
-    if (icon.fileExtensions) {
-      config = merge(
-        {},
-        config,
-        mapSpecificFileIcons(icon, FileMappingType.FileExtensions)
-      );
-    }
-    if (icon.fileNames) {
-      config = merge(
-        {},
-        config,
-        mapSpecificFileIcons(
-          icon,
-          FileMappingType.FileNames,
-          options.files?.associations
-        )
-      );
-    }
-  });
-
-  // set default file icon
-  config = merge(
-    {},
-    config,
-    setIconDefinition(config, fileIcons.defaultIcon.name)
-  );
-  config.file = fileIcons.defaultIcon.name;
-
-  if (fileIcons.defaultIcon.light && config.light) {
-    config = merge(
-      {},
-      config,
-      setIconDefinition(
-        config,
-        fileIcons.defaultIcon.name,
-        lightColorFileEnding
-      )
-    );
-    if (config.light) {
-      config.light.file = fileIcons.defaultIcon.name + lightColorFileEnding;
-    }
-  }
-
-  if (fileIcons.defaultIcon.highContrast) {
-    config = merge(
-      {},
-      config,
-      setIconDefinition(
-        config,
-        fileIcons.defaultIcon.name,
-        highContrastColorFileEnding
-      )
-    );
-    if (config.highContrast) {
-      config.highContrast.file =
-        fileIcons.defaultIcon.name + highContrastColorFileEnding;
-    }
-  }
-
-  return config;
-};
-
-/**
- * Map the file extensions and the filenames to the related icons.
- */
-const mapSpecificFileIcons = (
-  icon: FileIcon,
-  mappingType: FileMappingType,
-  customFileAssociation: IconAssociations = {}
-) => {
-  const config = new IconConfiguration();
-  const iconMappingType = icon[mappingType as keyof FileIcon] as string[];
-  if (iconMappingType === undefined) {
-    return;
-  }
-  iconMappingType.forEach((name) => {
-    // if the custom file extension should also overwrite the file names
-    const shouldOverwriteFileNames = Object.keys(customFileAssociation).some(
-      (key) => {
-        // overwrite is enabled if there are two asterisks in the wildcard
-        if (!/^\*{2}\./.test(key)) return false;
-        const fileExtension = key.replace(wildcardPattern, '.');
-
-        // check if the file name contains the particular file extension
-        // (e.g. extension ".md" in "Readme.md" -> then overwrite it with the *.md icon)
-        return name.toLowerCase().indexOf(fileExtension.toLowerCase()) !== -1;
-      }
-    );
-
-    // if overwrite is enabled then do not continue to set the icons for file names containing the file extension
-    const configMappingType = config[mappingType];
-    const configLightMappingType = config.light?.[mappingType];
-    const configHighContrastMappingType = config.highContrast?.[mappingType];
-
-    if (
-      shouldOverwriteFileNames ||
-      !configMappingType ||
-      !configLightMappingType ||
-      !configHighContrastMappingType
-    )
-      return;
-
-    configMappingType[name] = icon.name;
-    if (icon.light) {
-      configLightMappingType[name] = `${icon.name}${lightColorFileEnding}`;
-    }
-    if (icon.highContrast) {
-      configHighContrastMappingType[
-        name
-      ] = `${icon.name}${highContrastColorFileEnding}`;
-    }
-  });
-  return config;
-};
-
-/**
- * Disable all file icons that are in a pack which is disabled.
- */
-const disableIconsByPack = (
-  fileIcons: FileIcons,
-  activatedIconPack: string
-): FileIcon[] => {
-  return fileIcons.icons.filter((icon) => {
-    return !icon.enabledFor
-      ? true
-      : icon.enabledFor.some((p) => p === activatedIconPack);
-  });
-};
-
-const setIconDefinition = (
-  config: IconConfiguration,
-  iconName: string,
-  appendix: string = ''
-) => {
-  const obj: Partial<IconConfiguration> = { iconDefinitions: {} };
-  if (config.options) {
-    const fileConfigHash = getFileConfigHash(config.options);
-    obj.iconDefinitions![`${iconName}${appendix}`] = {
-      iconPath: `${iconFolderPath}${iconName}${appendix}${fileConfigHash}.svg`,
-    };
-  }
-  return obj;
-};
-
-export const generateFileIcons = (color: string | undefined) => {
-  if (!color || !validateHEXColorCode(color)) {
-    return console.error('Invalid color code for file icons');
-  }
-
-  const fileIcon =
-    'M13 9h5.5L13 3.5V9M6 2h8l6 6v12a2 2 0 0 1-2 2H6a2 2 0 0 1-2-2V4c0-1.11.89-2 2-2m5 2H6v16h12v-9h-7V4z';
-
-  writeSVGFiles('file', getSVG(getPath(fileIcon, color)));
-};
-
-const getCustomIcons = (fileAssociations: IconAssociations | undefined) => {
-  if (!fileAssociations) return [];
-
-  const icons: FileIcon[] = Object.keys(fileAssociations).map((fa) => {
-    const icon: Partial<FileIcon> = {
-      name: fileAssociations[fa].toLowerCase(),
-    };
-    if (wildcardPattern.test(fa)) {
-      icon.fileExtensions = [fa.toLowerCase().replace(wildcardPattern, '')];
-    } else {
-      icon.fileNames = [fa.toLowerCase()];
-    }
-    return icon as FileIcon;
-  });
-  return icons;
-};
-
-const enum FileMappingType {
-  FileExtensions = 'fileExtensions',
-  FileNames = 'fileNames',
-}

package/src/icons/generator/folderGenerator.ts

@@ -1,340 +0,0 @@
-import { writeFileSync } from 'fs';
-import merge from 'lodash.merge';
-import { basename, join } from 'path';
-import { getFileConfigHash } from '../../helpers/fileConfig';
-import {
-  DefaultIcon,
-  FolderIcon,
-  FolderTheme,
-  IconAssociations,
-  IconConfiguration,
-  IconJsonOptions,
-} from '../../models/index';
-import {
-  highContrastColorFileEnding,
-  iconFolderPath,
-  lightColorFileEnding,
-  openedFolder,
-} from './constants';
-
-/**
- * Get the folder icon definitions as object.
- */
-export const loadFolderIconDefinitions = (
-  folderThemes: FolderTheme[],
-  config: IconConfiguration,
-  options: IconJsonOptions
-): IconConfiguration => {
-  config = merge({}, config);
-  config.hidesExplorerArrows = options.hidesExplorerArrows;
-  const activeTheme = getEnabledFolderTheme(
-    folderThemes,
-    options.folders?.theme
-  );
-  if (!activeTheme) {
-    return {};
-  }
-  const enabledIcons = disableIconsByPack(activeTheme, options.activeIconPack);
-  const customIcons = getCustomIcons(options.folders?.associations);
-  const allIcons = [...enabledIcons, ...customIcons];
-
-  if (options.folders?.theme === 'none') {
-    return config;
-  }
-
-  allIcons.forEach((icon) => {
-    if (icon.disabled) return;
-    config = setIconDefinitions(config, icon);
-    config = merge({}, config, setFolderNames(icon.name, icon.folderNames));
-    config.light = icon.light
-      ? merge(
-          {},
-          config.light,
-          setFolderNames(icon.name, icon.folderNames, lightColorFileEnding)
-        )
-      : config.light;
-    config.highContrast = icon.highContrast
-      ? merge(
-          {},
-          config.highContrast,
-          setFolderNames(
-            icon.name,
-            icon.folderNames,
-            highContrastColorFileEnding
-          )
-        )
-      : config.highContrast;
-  });
-
-  config = setDefaultFolderIcons(activeTheme, config);
-  return config;
-};
-
-/**
- * Set the default folder icons for the theme.
- */
-const setDefaultFolderIcons = (
-  theme: FolderTheme,
-  config: IconConfiguration
-): IconConfiguration => {
-  config = merge({}, config);
-  const hasFolderIcons =
-    !!theme.defaultIcon.name && theme.defaultIcon.name.length > 0;
-  if (hasFolderIcons) {
-    config = setIconDefinitions(config, theme.defaultIcon);
-  }
-  config = merge(
-    {},
-    config,
-    createDefaultIconConfigObject(hasFolderIcons, theme, '')
-  );
-  config.light = theme.defaultIcon.light
-    ? merge(
-        {},
-        config.light,
-        createDefaultIconConfigObject(
-          hasFolderIcons,
-          theme,
-          lightColorFileEnding
-        )
-      )
-    : config.light;
-  config.highContrast = theme.defaultIcon.highContrast
-    ? merge(
-        {},
-        config.highContrast,
-        createDefaultIconConfigObject(
-          hasFolderIcons,
-          theme,
-          highContrastColorFileEnding
-        )
-      )
-    : config.highContrast;
-
-  config = merge(
-    {},
-    config,
-    createRootIconConfigObject(hasFolderIcons, theme, '')
-  );
-  if (theme.rootFolder) {
-    config = setIconDefinitions(config, theme.rootFolder);
-    config.light = theme.rootFolder.light
-      ? merge(
-          {},
-          config.light,
-          createRootIconConfigObject(
-            hasFolderIcons,
-            theme,
-            lightColorFileEnding
-          )
-        )
-      : config.light;
-    config.highContrast = theme.rootFolder.highContrast
-      ? merge(
-          {},
-          config.highContrast,
-          createRootIconConfigObject(
-            hasFolderIcons,
-            theme,
-            highContrastColorFileEnding
-          )
-        )
-      : config.highContrast;
-  }
-
-  return config;
-};
-
-/**
- * Get the object of the current enabled theme.
- */
-const getEnabledFolderTheme = (
-  themes: FolderTheme[],
-  enabledTheme: string | undefined
-): FolderTheme | undefined => {
-  return themes.find((theme) => theme.name === enabledTheme);
-};
-
-/**
- * Disable all file icons that are in a pack which is disabled.
- */
-const disableIconsByPack = (
-  folderIcons: FolderTheme | undefined,
-  activatedIconPack: string | undefined
-): FolderIcon[] => {
-  if (!folderIcons?.icons || folderIcons.icons.length === 0) {
-    return [];
-  }
-  return folderIcons.icons.filter((icon) => {
-    return !icon.enabledFor
-      ? true
-      : icon.enabledFor.some((p) => p === activatedIconPack);
-  });
-};
-
-const setIconDefinitions = (
-  config: IconConfiguration,
-  icon: FolderIcon | DefaultIcon
-) => {
-  config = merge({}, config);
-  config = createIconDefinitions(config, icon.name);
-  if (icon.light) {
-    config = merge(
-      {},
-      config,
-      createIconDefinitions(config, icon.name, lightColorFileEnding)
-    );
-  }
-  if (icon.highContrast) {
-    config = merge(
-      {},
-      config,
-      createIconDefinitions(config, icon.name, highContrastColorFileEnding)
-    );
-  }
-  return config;
-};
-
-const createIconDefinitions = (
-  config: IconConfiguration,
-  iconName: string,
-  appendix: string = ''
-) => {
-  config = merge({}, config);
-  const fileConfigHash = getFileConfigHash(config.options ?? {});
-  const configIconDefinitions = config.iconDefinitions;
-  if (configIconDefinitions) {
-    configIconDefinitions[iconName + appendix] = {
-      iconPath: `${iconFolderPath}${iconName}${appendix}${fileConfigHash}.svg`,
-    };
-    configIconDefinitions[`${iconName}${openedFolder}${appendix}`] = {
-      iconPath: `${iconFolderPath}${iconName}${openedFolder}${appendix}${fileConfigHash}.svg`,
-    };
-  }
-  return config;
-};
-
-const setFolderNames = (
-  iconName: string,
-  folderNames: string[],
-  appendix: string = ''
-) => {
-  const obj: Partial<IconConfiguration> = {
-    folderNames: {},
-    folderNamesExpanded: {},
-  };
-  folderNames.forEach((name) => {
-    if (obj.folderNames) {
-      obj.folderNames[name as keyof IconConfiguration] = iconName + appendix;
-    }
-    if (obj.folderNamesExpanded) {
-      obj.folderNamesExpanded[
-        name as keyof IconConfiguration
-      ] = `${iconName}${openedFolder}${appendix}`;
-    }
-  });
-  return obj;
-};
-
-const createDefaultIconConfigObject = (
-  hasFolderIcons: boolean,
-  theme: FolderTheme,
-  appendix: string = ''
-) => {
-  const obj = {
-    folder: '',
-    folderExpanded: '',
-  };
-  obj.folder = hasFolderIcons ? theme.defaultIcon.name + appendix : '';
-  obj.folderExpanded = hasFolderIcons
-    ? `${theme.defaultIcon.name}${openedFolder}${appendix}`
-    : '';
-  return obj;
-};
-
-const createRootIconConfigObject = (
-  hasFolderIcons: boolean,
-  theme: FolderTheme,
-  appendix: string = ''
-) => {
-  const obj = {
-    rootFolder: '',
-    rootFolderExpanded: '',
-  };
-  obj.rootFolder = hasFolderIcons
-    ? theme.rootFolder
-      ? theme.rootFolder.name + appendix
-      : theme.defaultIcon.name + appendix
-    : '';
-  obj.rootFolderExpanded = hasFolderIcons
-    ? theme.rootFolder
-      ? `${theme.rootFolder.name}${openedFolder}${appendix}`
-      : `${theme.defaultIcon.name}${openedFolder}${appendix}`
-    : '';
-  return obj;
-};
-
-const getCustomIcons = (folderAssociations: IconAssociations | undefined) => {
-  if (!folderAssociations) return [];
-
-  const icons: FolderIcon[] = Object.keys(folderAssociations).map((fa) => ({
-    // use default folder if icon name is empty
-    name:
-      folderAssociations[fa].length > 0
-        ? 'folder-' + folderAssociations[fa].toLowerCase()
-        : 'folder',
-    folderNames: [fa.toLowerCase()],
-  }));
-
-  return icons;
-};
-
-export const generateFolderIcons = (color: string | undefined) => {
-  if (!color || !validateHEXColorCode(color)) {
-    return console.error('Invalid color code for folder icons');
-  }
-
-  const folderIcon =
-    'M10 4H4c-1.11 0-2 .89-2 2v12a2 2 0 0 0 2 2h16a2 2 0 0 0 2-2V8c0-1.11-.9-2-2-2h-8l-2-2z';
-  const folderIconOpen =
-    'M19 20H4c-1.11 0-2-.9-2-2V6c0-1.11.89-2 2-2h6l2 2h7a2 2 0 0 1 2 2H4v10l2.14-8h17.07l-2.28 8.5c-.23.87-1.01 1.5-1.93 1.5z';
-  const rootFolderIcon =
-    'M12 20a8 8 0 0 1-8-8 8 8 0 0 1 8-8 8 8 0 0 1 8 8 8 8 0 0 1-8 8m0-18A10 10 0 0 0 2 12a10 10 0 0 0 10 10 10 10 0 0 0 10-10A10 10 0 0 0 12 2m0 5a5 5 0 0 0-5 5 5 5 0 0 0 5 5 5 5 0 0 0 5-5 5 5 0 0 0-5-5z';
-  const rootFolderIconOpen =
-    'M12 20a8 8 0 0 1-8-8 8 8 0 0 1 8-8 8 8 0 0 1 8 8 8 8 0 0 1-8 8m0-18A10 10 0 0 0 2 12a10 10 0 0 0 10 10 10 10 0 0 0 10-10A10 10 0 0 0 12 2z';
-
-  writeSVGFiles('folder', getSVG(getPath(folderIcon, color)));
-  writeSVGFiles('folder-open', getSVG(getPath(folderIconOpen, color)));
-  writeSVGFiles('folder-root', getSVG(getPath(rootFolderIcon, color)));
-  writeSVGFiles('folder-root-open', getSVG(getPath(rootFolderIconOpen, color)));
-};
-
-export const getPath = (d: string, color: string) =>
-  `<path d="${d}" fill="${color}" />`;
-export const getSVG = (path: string) =>
-  `<svg viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">${path}</svg>`;
-
-export const writeSVGFiles = (iconName: string, svg: string) => {
-  let iconsPath;
-  if (basename(__dirname) === 'dist') {
-    iconsPath = join(__dirname, '..', 'icons');
-  } else {
-    // executed via script
-    iconsPath = join(__dirname, '..', '..', '..', 'icons');
-  }
-  const iconsFolderPath = join(iconsPath, `${iconName}.svg`);
-  try {
-    writeFileSync(iconsFolderPath, svg);
-  } catch (error) {
-    console.error(error);
-  }
-};
-
-/**
- * Validate the HEX color code
- * @param color HEX code
- */
-export const validateHEXColorCode = (color: string = '') => {
-  const hexPattern = new RegExp(/^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$/);
-  return color.length > 0 && hexPattern.test(color);
-};

package/src/icons/generator/iconOpacity.ts

@@ -1,111 +0,0 @@
-import { readdirSync, readFileSync, writeFileSync } from 'fs';
-import { basename, join } from 'path';
-import { getCustomIconPaths } from '../../helpers/customIcons';
-import { IconJsonOptions } from '../../models';
-
-/**
- * Changes the opacity of all icons in the set.
- * @param options Icon JSON options which include the opacity value.
- * @param fileNames Only change the opacity of certain file names.
- */
-export const setIconOpacity = (
-  options: IconJsonOptions,
-  fileNames?: string[]
-) => {
-  if (!validateOpacityValue(options.opacity)) {
-    return console.error(
-      'Invalid opacity value! Opacity must be a decimal number between 0 and 1!'
-    );
-  }
-
-  let iconsPath = '';
-  if (basename(__dirname) === 'dist') {
-    iconsPath = join(__dirname, '..', 'icons');
-  } else {
-    // executed via script
-    iconsPath = join(__dirname, '..', '..', '..', 'icons');
-  }
-
-  const customIconPaths = getCustomIconPaths(options);
-  const iconFiles = readdirSync(iconsPath);
-
-  try {
-    // read all icon files from the icons folder
-    (fileNames || iconFiles).forEach(adjustOpacity(iconsPath, options));
-
-    customIconPaths.forEach((iconPath) => {
-      const customIcons = readdirSync(iconPath);
-      customIcons.forEach(adjustOpacity(iconPath, options));
-    });
-  } catch (error) {
-    console.error(error);
-  }
-};
-
-/**
- * Validate the opacity value.
- * @param opacity Opacity value
- */
-export const validateOpacityValue = (opacity: number | undefined) => {
-  return opacity !== undefined && opacity <= 1 && opacity >= 0;
-};
-
-/**
- * Get the SVG root element.
- * @param svg SVG file as string.
- */
-const getSVGRootElement = (svg: string) => {
-  const result = new RegExp(/<svg[^>]*>/).exec(svg);
-  return result?.[0];
-};
-
-/**
- * Add an opacity attribute to the SVG icon to control the opacity of the icon.
- * @param svgRoot Root element of the SVG icon.
- * @param opacity Opacity value.
- */
-const addOpacityAttribute = (svgRoot: string, opacity: number) => {
-  const pattern = new RegExp(/\sopacity="[\d.]+"/);
-  // if the opacity attribute already exists
-  if (pattern.test(svgRoot)) {
-    return svgRoot.replace(pattern, ` opacity="${opacity}"`);
-  } else {
-    return svgRoot.replace(/^<svg/, `<svg opacity="${opacity}"`);
-  }
-};
-
-/**
- * Remove the opacity attribute of the SVG icon.
- * @param svgRoot Root element of the SVG icon.
- */
-const removeOpacityAttribute = (svgRoot: string) => {
-  const pattern = new RegExp(/\sopacity="[\d.]+"/);
-  return svgRoot.replace(pattern, '');
-};
-
-const adjustOpacity = (
-  iconPath: string,
-  options: IconJsonOptions
-): ((value: string, index: number, array: string[]) => void) => {
-  return (iconFileName) => {
-    const svgFilePath = join(iconPath, iconFileName);
-
-    // Read SVG file
-    const svg = readFileSync(svgFilePath, 'utf-8');
-
-    // Get the root element of the SVG file
-    const svgRootElement = getSVGRootElement(svg);
-    if (!svgRootElement) return;
-
-    let updatedRootElement: string;
-
-    if (options.opacity !== undefined && options.opacity < 1) {
-      updatedRootElement = addOpacityAttribute(svgRootElement, options.opacity);
-    } else {
-      updatedRootElement = removeOpacityAttribute(svgRootElement);
-    }
-    const updatedSVG = svg.replace(/<svg[^>]*>/, updatedRootElement);
-
-    writeFileSync(svgFilePath, updatedSVG);
-  };
-};