material-icon-theme 3.7.1 → 4.14.0

package/src/icons/generator/constants.ts

@@ -1,29 +1,29 @@
-/**
- * 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 lightVersion: string = '_light';
-
-/**
- * File ending for high contrast icons.
- */
-export const highContrastVersion: string = '_highContrast';
-
-/**
- * Pattern to match wildcards for custom file icon mappings.
- */
-export const wildcardPattern = new RegExp(/^\*{1,2}\./);
+/**
+ * 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,116 +1,216 @@
-import * as merge from 'lodash.merge';
-import { FileIcon, FileIcons, IconAssociations, IconConfiguration, IconJsonOptions } from '../../models/index';
-import { highContrastVersion, iconFolderPath, lightVersion, wildcardPattern } from './constants';
-
-/**
- * Get all file icons that can be used in this theme.
- */
-export const getFileIconDefinitions = (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(icon.name));
-
-        if (icon.light) {
-            config = merge({}, config, setIconDefinition(icon.name, lightVersion));
-        }
-        if (icon.highContrast) {
-            config = merge({}, config, setIconDefinition(icon.name, highContrastVersion));
-        }
-
-        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(fileIcons.defaultIcon.name));
-    config.file = fileIcons.defaultIcon.name;
-
-    if (fileIcons.defaultIcon.light) {
-        config = merge({}, config, setIconDefinition(fileIcons.defaultIcon.name, lightVersion));
-        config.light.file = fileIcons.defaultIcon.name + lightVersion;
-    }
-
-    if (fileIcons.defaultIcon.highContrast) {
-        config = merge({}, config, setIconDefinition(fileIcons.defaultIcon.name, highContrastVersion));
-        config.highContrast.file = fileIcons.defaultIcon.name + highContrastVersion;
-    }
-
-    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();
-    icon[mappingType].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
-        if (shouldOverwriteFileNames) return;
-
-        config[mappingType][name] = icon.name;
-        if (icon.light) {
-            config.light[mappingType][name] = `${icon.name}${lightVersion}`;
-        }
-        if (icon.highContrast) {
-            config.highContrast[mappingType][name] = `${icon.name}${highContrastVersion}`;
-        }
-    });
-    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 = (iconName: string, appendix: string = '') => {
-    const obj = { iconDefinitions: {} };
-    obj.iconDefinitions[`${iconName}${appendix}`] = {
-        iconPath: `${iconFolderPath}${iconName}${appendix}.svg`
-    };
-    return obj;
-};
-
-const getCustomIcons = (fileAssociations: IconAssociations) => {
-    if (!fileAssociations) return [];
-
-    const icons: FileIcon[] = Object.keys(fileAssociations).map(fa => {
-        const icon: FileIcon = { name: fileAssociations[fa].toLowerCase() };
-        if (wildcardPattern.test(fa)) {
-            icon.fileExtensions = [fa.toLowerCase().replace(wildcardPattern, '')];
-        } else {
-            icon.fileNames = [fa.toLowerCase()];
-        }
-        return icon;
-    });
-    return icons;
-};
-
-const enum FileMappingType {
-    FileExtensions = 'fileExtensions',
-    FileNames = 'fileNames'
-}
+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';
+
+/**
+ * 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;
+};
+
+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',
+}