material-icon-theme 3.7.1 → 4.14.0

package/src/icons/generator/jsonGenerator.ts

@@ -1,98 +1,187 @@
-import * as merge from 'lodash.merge';
-import * as path from 'path';
-import * as fs from 'fs';
-import { IconConfiguration, IconJsonOptions } from '../../models/index';
-import { fileIcons } from '../fileIcons';
-import { folderIcons } from '../folderIcons';
-import { languageIcons } from '../languageIcons';
-import { iconJsonName } from './constants';
-import { generateFolderIcons, getFileIconDefinitions, getFolderIconDefinitions, getLanguageIconDefinitions, setIconOpacity, setIconSaturation, validateHEXColorCode, validateOpacityValue, validateSaturationValue } from './index';
-
-/**
- * Generate the complete icon configuration object that can be written as JSON file.
- */
-export const generateIconConfigurationObject = (options: IconJsonOptions): IconConfiguration => {
-    const iconConfig = merge({}, new IconConfiguration(), { options });
-    const languageIconDefinitions = getLanguageIconDefinitions(languageIcons, iconConfig, options);
-    const fileIconDefinitions = getFileIconDefinitions(fileIcons, iconConfig, options);
-    const folderIconDefinitions = getFolderIconDefinitions(folderIcons, iconConfig, options);
-
-    return merge({}, languageIconDefinitions, fileIconDefinitions, folderIconDefinitions);
-};
-
-/**
- * Create the JSON file that is responsible for the icons in the editor.
- * @param updatedConfigs Options that have been changed.
- * @param updatedJSONConfig New JSON options that already include the updatedConfigs.
- */
-export const createIconFile = (updatedConfigs?: IconJsonOptions, updatedJSONConfig: IconJsonOptions = {}) => {
-    // override the default options with the new options
-    const options: IconJsonOptions = merge({}, getDefaultIconOptions(), updatedJSONConfig);
-    const json = generateIconConfigurationObject(options);
-
-    // make sure that the opacity and saturation values must be entered correctly to trigger a reload.
-    if (updatedConfigs) {
-        if (updatedConfigs.opacity !== undefined && !validateOpacityValue(updatedConfigs.opacity)) {
-            throw Error('Material Icons: Invalid opacity value!');
-        }
-        if (updatedConfigs.saturation !== undefined && !validateSaturationValue(updatedConfigs.saturation)) {
-            throw Error('Material Icons: Invalid saturation value!');
-        }
-    }
-
-    // make sure that the value of the folder color is entered correctly to trigger a reload.
-    if (updatedConfigs && updatedConfigs.folders) {
-        if (typeof updatedConfigs.folders.color !== 'undefined') {
-            if (!validateHEXColorCode(updatedConfigs.folders.color)) {
-                throw Error('Material Icons: Invalid folder color value!');
-            }
-        }
-    }
-
-    try {
-        let iconsPath = __dirname;
-        if (path.basename(__dirname) !== 'dist') {
-            // executed via script
-            iconsPath = path.join(__dirname, '..', '..', '..', 'dist');
-        }
-        fs.writeFileSync(path.join(iconsPath, iconJsonName), JSON.stringify(json, undefined, 2), 'utf-8');
-    } catch (error) {
-        throw Error(error);
-    }
-
-    try {
-        if (!updatedConfigs || (updatedConfigs.folders || {}).color) {
-            // if updatedConfigs do not exist (because of initial setup)
-            // or new config value was detected by the change detection
-            generateFolderIcons(options.folders.color);
-            setIconOpacity(options.opacity, ['folder.svg', 'folder-open.svg', 'folder-root.svg', 'folder-root-open.svg']);
-        }
-        if (!updatedConfigs || updatedConfigs.opacity !== undefined) {
-            setIconOpacity(options.opacity);
-        }
-        if (!updatedConfigs || updatedConfigs.saturation !== undefined) {
-            setIconSaturation(options.saturation);
-        }
-    } catch (error) {
-        throw Error(error);
-    }
-
-    return iconJsonName;
-};
-
-/**
- * The options control the generator and decide which icons are disabled or not.
- */
-export const getDefaultIconOptions = (): IconJsonOptions => ({
-    folders: {
-        theme: 'specific',
-        color: '#90a4ae',
-        associations: {},
-    },
-    activeIconPack: 'angular',
-    hidesExplorerArrows: false,
-    opacity: 1,
-    saturation: 1,
-    files: { associations: {} },
-    languages: { associations: {} },
-});
+import * as fs from 'fs';
+import merge from 'lodash.merge';
+import * as path from 'path';
+import { getCustomIconPaths } from '../../helpers/customIcons';
+import { getFileConfigHash } from '../../helpers/fileConfig';
+import { IconConfiguration, IconJsonOptions } from '../../models/index';
+import { fileIcons } from '../fileIcons';
+import { folderIcons } from '../folderIcons';
+import { languageIcons } from '../languageIcons';
+import { iconJsonName } from './constants';
+import {
+  generateFolderIcons,
+  loadFileIconDefinitions,
+  loadFolderIconDefinitions,
+  loadLanguageIconDefinitions,
+  setIconOpacity,
+  setIconSaturation,
+  validateHEXColorCode,
+  validateOpacityValue,
+  validateSaturationValue,
+} from './index';
+
+/**
+ * Generate the complete icon configuration object that can be written as JSON file.
+ */
+export const generateIconConfigurationObject = (
+  options: IconJsonOptions
+): IconConfiguration => {
+  const iconConfig = merge({}, new IconConfiguration(), { options });
+  const languageIconDefinitions = loadLanguageIconDefinitions(
+    languageIcons,
+    iconConfig,
+    options
+  );
+  const fileIconDefinitions = loadFileIconDefinitions(
+    fileIcons,
+    iconConfig,
+    options
+  );
+  const folderIconDefinitions = loadFolderIconDefinitions(
+    folderIcons,
+    iconConfig,
+    options
+  );
+
+  return merge(
+    {},
+    languageIconDefinitions,
+    fileIconDefinitions,
+    folderIconDefinitions
+  );
+};
+
+/**
+ * Create the JSON file that is responsible for the icons in the editor.
+ * @param updatedConfigs Options that have been changed.
+ * @param updatedJSONConfig New JSON options that already include the updatedConfigs.
+ */
+export const createIconFile = (
+  updatedConfigs?: IconJsonOptions,
+  updatedJSONConfig: IconJsonOptions = {}
+) => {
+  // override the default options with the new options
+  const options: IconJsonOptions = merge(
+    {},
+    getDefaultIconOptions(),
+    updatedJSONConfig
+  );
+  const json = generateIconConfigurationObject(options);
+
+  // make sure that the folder color, opacity and saturation values are entered correctly
+  if (
+    updatedConfigs?.opacity &&
+    !validateOpacityValue(updatedConfigs?.opacity)
+  ) {
+    throw Error('Material Icons: Invalid opacity value!');
+  }
+  if (
+    updatedConfigs?.saturation &&
+    !validateSaturationValue(updatedConfigs?.saturation)
+  ) {
+    throw Error('Material Icons: Invalid saturation value!');
+  }
+  if (
+    updatedConfigs?.folders?.color &&
+    !validateHEXColorCode(updatedConfigs?.folders?.color)
+  ) {
+    throw Error('Material Icons: Invalid folder color value!');
+  }
+
+  try {
+    let iconJsonPath = __dirname;
+    // if executed via script
+    if (path.basename(__dirname) !== 'dist') {
+      iconJsonPath = path.join(__dirname, '..', '..', '..', 'dist');
+    }
+    if (!updatedConfigs || (updatedConfigs.folders || {}).color) {
+      // if updatedConfigs do not exist (because of initial setup)
+      // or new config value was detected by the change detection
+      generateFolderIcons(options.folders?.color);
+      setIconOpacity(options, [
+        'folder.svg',
+        'folder-open.svg',
+        'folder-root.svg',
+        'folder-root-open.svg',
+      ]);
+    }
+    if (!updatedConfigs || updatedConfigs.opacity !== undefined) {
+      setIconOpacity(options);
+    }
+    if (!updatedConfigs || updatedConfigs.saturation !== undefined) {
+      setIconSaturation(options);
+    }
+    renameIconFiles(iconJsonPath, options);
+  } catch (error) {
+    throw new Error('Failed to update icons: ' + error);
+  }
+
+  try {
+    let iconJsonPath = __dirname;
+    // if executed via script
+    if (path.basename(__dirname) !== 'dist') {
+      iconJsonPath = path.join(__dirname, '..', '..', '..', 'dist');
+    }
+    fs.writeFileSync(
+      path.join(iconJsonPath, iconJsonName),
+      JSON.stringify(json, undefined, 2),
+      'utf-8'
+    );
+  } catch (error) {
+    throw new Error('Failed to create icon file: ' + error);
+  }
+
+  return iconJsonName;
+};
+
+/**
+ * The options control the generator and decide which icons are disabled or not.
+ */
+export const getDefaultIconOptions = (): Required<IconJsonOptions> => ({
+  folders: {
+    theme: 'specific',
+    color: '#90a4ae',
+    associations: {},
+  },
+  activeIconPack: 'angular',
+  hidesExplorerArrows: false,
+  opacity: 1,
+  saturation: 1,
+  files: { associations: {} },
+  languages: { associations: {} },
+  showUpdateMessage: false,
+  showWelcomeMessage: false,
+});
+
+/**
+ * Rename all icon files according their respective config
+ * @param iconJsonPath Path of icon json folder
+ * @param options Icon Json Options
+ */
+const renameIconFiles = (iconJsonPath: string, options: IconJsonOptions) => {
+  const customPaths = getCustomIconPaths(options);
+  const defaultIconPath = path.join(iconJsonPath, '..', 'icons');
+  const iconPaths = [defaultIconPath, ...customPaths];
+
+  iconPaths.forEach((iconPath) => {
+    fs.readdirSync(iconPath)
+      .filter((f) => f.match(/\.svg/gi))
+      .forEach((f) => {
+        const filePath = path.join(iconPath, f);
+        const fileConfigHash = getFileConfigHash(options);
+
+        // append file config to file name
+        const newFilePath = path.join(
+          iconPath,
+          f.replace(/(^[^\.~]+)(.*)\.svg/, `$1${fileConfigHash}.svg`)
+        );
+
+        // if generated files are already in place, do not overwrite them
+        if (filePath !== newFilePath && fs.existsSync(newFilePath)) {
+          fs.unlinkSync(filePath);
+        } else {
+          fs.renameSync(filePath, newFilePath);
+        }
+      });
+  });
+};

package/src/icons/generator/languageGenerator.ts

@@ -1,67 +1,127 @@
-import * as merge from 'lodash.merge';
-import { DefaultIcon, IconAssociations, IconConfiguration, IconJsonOptions, LanguageIcon } from '../../models/index';
-import { highContrastVersion, iconFolderPath, lightVersion } from './constants';
-
-/**
- * Get all file icons that can be used in this theme.
- */
-export const getLanguageIconDefinitions = (languages: LanguageIcon[], config: IconConfiguration, options: IconJsonOptions): IconConfiguration => {
-    config = merge({}, config);
-    const enabledLanguages = disableLanguagesByPack(languages, options.activeIconPack);
-    const customIcons = getCustomIcons(options.languages.associations);
-    const allLanguageIcons = [...enabledLanguages, ...customIcons];
-
-    allLanguageIcons.forEach(lang => {
-        if (lang.disabled) return;
-        config = setIconDefinitions(config, lang.icon);
-        config = merge({}, config, setLanguageIdentifiers(lang.icon.name, lang.ids));
-        config.light = lang.icon.light ? merge({}, config.light, setLanguageIdentifiers(lang.icon.name + lightVersion, lang.ids)) : config.light;
-        config.highContrast = lang.icon.highContrast ? merge({}, config.highContrast, setLanguageIdentifiers(lang.icon.name + highContrastVersion, lang.ids)) : config.highContrast;
-    });
-
-    return config;
-};
-
-const setIconDefinitions = (config: IconConfiguration, icon: DefaultIcon) => {
-    config = merge({}, config);
-    config = createIconDefinitions(config, icon.name);
-    config = merge({}, config, icon.light ? createIconDefinitions(config, icon.name + lightVersion) : config.light);
-    config = merge({}, config, icon.highContrast ? createIconDefinitions(config, icon.name + highContrastVersion) : config.highContrast);
-    return config;
-};
-
-const createIconDefinitions = (config: IconConfiguration, iconName: string) => {
-    config = merge({}, config);
-    config.iconDefinitions[iconName] = {
-        iconPath: `${iconFolderPath}${iconName}.svg`
-    };
-    return config;
-};
-
-const setLanguageIdentifiers = (iconName: string, languageIds: string[]) => {
-    const obj = { languageIds: {} };
-    languageIds.forEach(id => {
-        obj.languageIds[id] = iconName;
-    });
-    return obj;
-};
-
-const getCustomIcons = (languageAssocitations: IconAssociations) => {
-    if (!languageAssocitations) return [];
-
-    const icons: LanguageIcon[] = Object.keys(languageAssocitations).map(fa => ({
-        icon: { name: languageAssocitations[fa].toLowerCase() },
-        ids: [fa.toLowerCase()]
-    }));
-
-    return icons;
-};
-
-/**
- * Disable all file icons that are in a pack which is disabled.
- */
-const disableLanguagesByPack = (languageIcons: LanguageIcon[], activatedIconPack: string) => {
-    return languageIcons.filter(language => {
-        return !language.enabledFor ? true : language.enabledFor.some(p => p === activatedIconPack);
-    });
-};
+import merge from 'lodash.merge';
+import { getFileConfigHash } from '../../helpers/fileConfig';
+import {
+  DefaultIcon,
+  IconAssociations,
+  IconConfiguration,
+  IconJsonOptions,
+  LanguageIcon,
+} from '../../models/index';
+import {
+  highContrastColorFileEnding,
+  iconFolderPath,
+  lightColorFileEnding,
+} from './constants';
+
+/**
+ * Get all file icons that can be used in this theme.
+ */
+export const loadLanguageIconDefinitions = (
+  languages: LanguageIcon[],
+  config: IconConfiguration,
+  options: IconJsonOptions
+): IconConfiguration => {
+  config = merge({}, config);
+  const enabledLanguages = disableLanguagesByPack(
+    languages,
+    options.activeIconPack
+  );
+  const customIcons = getCustomIcons(options.languages?.associations);
+  const allLanguageIcons = [...enabledLanguages, ...customIcons];
+
+  allLanguageIcons.forEach((lang) => {
+    if (lang.disabled) return;
+    config = setIconDefinitions(config, lang.icon);
+    config = merge(
+      {},
+      config,
+      setLanguageIdentifiers(lang.icon.name, lang.ids)
+    );
+    config.light = lang.icon.light
+      ? merge(
+          {},
+          config.light,
+          setLanguageIdentifiers(
+            lang.icon.name + lightColorFileEnding,
+            lang.ids
+          )
+        )
+      : config.light;
+    config.highContrast = lang.icon.highContrast
+      ? merge(
+          {},
+          config.highContrast,
+          setLanguageIdentifiers(
+            lang.icon.name + highContrastColorFileEnding,
+            lang.ids
+          )
+        )
+      : config.highContrast;
+  });
+
+  return config;
+};
+
+const setIconDefinitions = (config: IconConfiguration, icon: DefaultIcon) => {
+  config = merge({}, config);
+  config = createIconDefinitions(config, icon.name);
+  config = merge(
+    {},
+    config,
+    icon.light
+      ? createIconDefinitions(config, icon.name + lightColorFileEnding)
+      : config.light
+  );
+  config = merge(
+    {},
+    config,
+    icon.highContrast
+      ? createIconDefinitions(config, icon.name + highContrastColorFileEnding)
+      : config.highContrast
+  );
+  return config;
+};
+
+const createIconDefinitions = (config: IconConfiguration, iconName: string) => {
+  config = merge({}, config);
+  const fileConfigHash = getFileConfigHash(config.options ?? {});
+  if (config.iconDefinitions) {
+    config.iconDefinitions[iconName] = {
+      iconPath: `${iconFolderPath}${iconName}${fileConfigHash}.svg`,
+    };
+  }
+  return config;
+};
+
+const setLanguageIdentifiers = (iconName: string, languageIds: string[]) => {
+  const obj: Partial<IconConfiguration> = { languageIds: {} };
+  languageIds.forEach((id) => {
+    obj.languageIds![id as keyof IconConfiguration] = iconName;
+  });
+  return obj;
+};
+
+const getCustomIcons = (languageAssociations: IconAssociations | undefined) => {
+  if (!languageAssociations) return [];
+
+  const icons: LanguageIcon[] = Object.keys(languageAssociations).map((fa) => ({
+    icon: { name: languageAssociations[fa].toLowerCase() },
+    ids: [fa.toLowerCase()],
+  }));
+
+  return icons;
+};
+
+/**
+ * Disable all file icons that are in a pack which is disabled.
+ */
+const disableLanguagesByPack = (
+  languageIcons: LanguageIcon[],
+  activatedIconPack: string | undefined
+) => {
+  return languageIcons.filter((language) => {
+    return !language.enabledFor
+      ? true
+      : language.enabledFor.some((p) => p === activatedIconPack);
+  });
+};

package/src/icons/index.ts

@@ -1,4 +1,4 @@
-export * from './generator';
-export * from './fileIcons';
-export * from './folderIcons';
-export * from './languageIcons';
+export * from './generator';
+export * from './fileIcons';
+export * from './folderIcons';
+export * from './languageIcons';