material-icon-theme 4.18.0 → 4.20.0

package/src/extension.ts

@@ -1,42 +1,42 @@
-'use strict';
-
-import * as vscode from 'vscode';
-import * as commands from './commands';
-import { detectConfigChanges } from './helpers/changeDetection';
-import { checkThemeStatus, versionKey } from './helpers/versioning';
-import * as i18n from './i18n';
-import { showStartMessages } from './messages/start';
-
-/**
- * This method is called when the extension is activated.
- * It initializes the core functionality of the extension.
- */
-export const activate = async (context: vscode.ExtensionContext) => {
-  try {
-    await i18n.initTranslations();
-    context.globalState.setKeysForSync([versionKey]);
-    const status = await checkThemeStatus(context.globalState);
-    showStartMessages(status);
-
-    // Subscribe to the extension commands
-    context.subscriptions.push(...commands.registered);
-
-    // Initially trigger the config change detection
-    detectConfigChanges();
-
-    // Observe changes in the config
-    vscode.workspace.onDidChangeConfiguration(detectConfigChanges);
-
-    // Observe if the window got focused to trigger config changes
-    vscode.window.onDidChangeWindowState((state) => {
-      if (state.focused) {
-        detectConfigChanges();
-      }
-    });
-  } catch (error) {
-    console.error(error);
-  }
-};
-
-/** This method is called when the extension is deactivated */
-export const deactivate = () => {};
+'use strict';
+
+import * as vscode from 'vscode';
+import * as commands from './commands';
+import { detectConfigChanges } from './helpers/changeDetection';
+import { checkThemeStatus, versionKey } from './helpers/versioning';
+import * as i18n from './i18n';
+import { showStartMessages } from './messages/start';
+
+/**
+ * This method is called when the extension is activated.
+ * It initializes the core functionality of the extension.
+ */
+export const activate = async (context: vscode.ExtensionContext) => {
+  try {
+    await i18n.initTranslations();
+    context.globalState.setKeysForSync([versionKey]);
+    const status = await checkThemeStatus(context.globalState);
+    showStartMessages(status);
+
+    // Subscribe to the extension commands
+    context.subscriptions.push(...commands.registered);
+
+    // Initially trigger the config change detection
+    detectConfigChanges();
+
+    // Observe changes in the config
+    vscode.workspace.onDidChangeConfiguration(detectConfigChanges);
+
+    // Observe if the window got focused to trigger config changes
+    vscode.window.onDidChangeWindowState((state) => {
+      if (state.focused) {
+        detectConfigChanges();
+      }
+    });
+  } catch (error) {
+    console.error(error);
+  }
+};
+
+/** This method is called when the extension is deactivated */
+export const deactivate = () => {};

package/src/helpers/changeDetection.ts

@@ -1,73 +1,109 @@
-import { getConfigProperties, getMaterialIconsJSON, getThemeConfig } from '.';
-import { createIconFile } from '../icons/index';
-import { IconJsonOptions } from '../models';
-import { getObjectPropertyValue, setObjectPropertyValue } from './objects';
-
-/** Compare the workspace and the user configurations with the current setup of the icons. */
-export const detectConfigChanges = () => {
-  const changes = compareConfigs();
-
-  // if there's nothing to update
-  if (Object.keys(changes.updatedConfigs).length === 0) return;
-
-  try {
-    // update icon json file with new options
-    createIconFile(changes.updatedConfigs, changes.updatedJSONConfig);
-  } catch (error) {
-    console.error(error);
-  }
-};
-
-/**
- * Compares a specific configuration in the settings with a current configuration state.
- * The current configuration state is read from the icons json file.
- * @returns List of configurations that needs to be updated.
- */
-const compareConfigs = (): {
-  updatedConfigs: IconJsonOptions;
-  updatedJSONConfig: IconJsonOptions;
-} => {
-  const configPropertyNames = Object.keys(getConfigProperties())
-    .map((c) => c.split('.').slice(1).join('.'))
-    // remove configurable notification messages
-    .filter((c) => !/show(Welcome|Update|Reload)Message/g.test(c));
-
-  const json = getMaterialIconsJSON();
-  return configPropertyNames.reduce(
-    (result, configName) => {
-      try {
-        const themeConfig = getThemeConfig(configName) ?? {
-          globalValue: '',
-          workspaceValue: '',
-          defaultValue: '',
-        };
-        const configValue =
-          themeConfig.workspaceValue ??
-          themeConfig.globalValue ??
-          themeConfig.defaultValue;
-
-        const currentState = getObjectPropertyValue(
-          json.options ?? {},
-          configName
-        );
-
-        if (JSON.stringify(configValue) !== JSON.stringify(currentState)) {
-          setObjectPropertyValue(json.options as {}, configName, configValue);
-          setObjectPropertyValue(
-            result.updatedConfigs,
-            configName,
-            configValue
-          );
-        }
-      } catch (error) {
-        console.error(error);
-      }
-
-      return result;
-    },
-    {
-      updatedConfigs: {} as IconJsonOptions,
-      updatedJSONConfig: json.options as IconJsonOptions,
-    }
-  );
-};
+import merge from 'lodash.merge';
+import { getConfigProperties, getMaterialIconsJSON, getThemeConfig } from '.';
+import { createIconFile } from '../icons/index';
+import { IconJsonOptions } from '../models';
+import { getObjectPropertyValue, setObjectPropertyValue } from './objects';
+
+/** Compare the workspace and the user configurations with the current setup of the icons. */
+export const detectConfigChanges = () => {
+  const changes = compareConfigs();
+
+  // if there's nothing to update
+  if (Object.keys(changes.updatedConfigs).length === 0) return;
+
+  try {
+    // update icon json file with new options
+    createIconFile(changes.updatedConfigs, changes.updatedJSONConfig);
+  } catch (error) {
+    console.error(error);
+  }
+};
+
+/**
+ * Compares a specific configuration in the settings with a current configuration state.
+ * The current configuration state is read from the icons json file.
+ * @returns List of configurations that needs to be updated.
+ */
+const compareConfigs = (): {
+  updatedConfigs: IconJsonOptions;
+  updatedJSONConfig: IconJsonOptions;
+} => {
+  const configPropertyNames = Object.keys(getConfigProperties())
+    .map((c) => c.split('.').slice(1).join('.'))
+    // remove configurable notification messages
+    .filter((c) => !/show(Welcome|Update|Reload)Message/g.test(c));
+
+  const json = getMaterialIconsJSON();
+  return configPropertyNames.reduce(
+    (result, configName) => {
+      try {
+        const themeConfig = getThemeConfig(configName) ?? {
+          globalValue: '',
+          workspaceValue: '',
+          defaultValue: '',
+        };
+
+        const configValue = getConfigValue(
+          themeConfig as {
+            globalValue: unknown;
+            workspaceValue: unknown;
+            defaultValue: unknown;
+          }
+        );
+
+        const currentState = getObjectPropertyValue(
+          json.options ?? {},
+          configName
+        );
+
+        if (JSON.stringify(configValue) !== JSON.stringify(currentState)) {
+          setObjectPropertyValue(json.options as {}, configName, configValue);
+          setObjectPropertyValue(
+            result.updatedConfigs,
+            configName,
+            configValue
+          );
+        }
+      } catch (error) {
+        console.error(error);
+      }
+
+      return result;
+    },
+    {
+      updatedConfigs: {} as IconJsonOptions,
+      updatedJSONConfig: json.options as IconJsonOptions,
+    }
+  );
+};
+
+/**
+ * Returns the value of a specific configuration by checking the workspace and the user configuration and fallback to the default value.
+ *
+ * @param themeConfig Theme configuration
+ * @returns Actual theme configuration value
+ */
+const getConfigValue = (themeConfig: {
+  globalValue: unknown;
+  workspaceValue: unknown;
+  defaultValue: unknown;
+}) => {
+  let configValue;
+  if (
+    typeof themeConfig.workspaceValue === 'object' &&
+    themeConfig.workspaceValue &&
+    themeConfig.globalValue
+  ) {
+    configValue = merge(
+      {},
+      themeConfig.workspaceValue,
+      themeConfig.globalValue
+    );
+  } else {
+    configValue =
+      themeConfig.workspaceValue ??
+      themeConfig.globalValue ??
+      themeConfig.defaultValue;
+  }
+  return configValue;
+};

package/src/helpers/customIcons.ts

@@ -1,8 +1,8 @@
-import { IconJsonOptions } from '../models';
-import * as path from 'path';
-
-export const getCustomIconPaths = (options: IconJsonOptions) => {
-  return Object.values(options?.files?.associations ?? {})
-    .filter((v) => v.match(/^[.\/]+/)) // <- custom dirs have a relative path to the dist folder
-    .map((v) => path.dirname(path.join(__dirname, v)));
-};
+import { IconJsonOptions } from '../models';
+import * as path from 'path';
+
+export const getCustomIconPaths = (options: IconJsonOptions) => {
+  return Object.values(options?.files?.associations ?? {})
+    .filter((v) => v.match(/^[.\/]+/)) // <- custom dirs have a relative path to the dist folder
+    .map((v) => path.dirname(path.join(__dirname, v)));
+};

package/src/helpers/fileConfig.ts

@@ -1,37 +1,37 @@
-import { getDefaultIconOptions } from '../icons';
-import { IconJsonOptions } from '../models';
-
-/**
- * Generate a config hashed string that is appended to each icon file name.
- * @param config Icon Configuration object
- */
-export const getFileConfigHash = (options: IconJsonOptions): string => {
-  try {
-    const defaults = getDefaultIconOptions();
-    let fileConfigString = '';
-    if (
-      options.saturation !== defaults.saturation ||
-      options.opacity !== defaults.opacity ||
-      options.folders?.color !== defaults.folders.color
-    ) {
-      fileConfigString += `~${getHash(JSON.stringify(options))}`;
-    }
-    return fileConfigString;
-  } catch (error) {
-    console.error(error);
-    return '';
-  }
-};
-
-const getHash = (value: string) => {
-  let hash = 0;
-  let chr = 0;
-
-  if (value.length === 0) return hash;
-  for (let i = 0; i < value.length; i++) {
-    chr = value.charCodeAt(i);
-    hash = (hash << 5) - hash + chr;
-    hash |= 0; // Convert to 32bit integer
-  }
-  return hash;
-};
+import { getDefaultIconOptions } from '../icons';
+import { IconJsonOptions } from '../models';
+
+/**
+ * Generate a config hashed string that is appended to each icon file name.
+ * @param config Icon Configuration object
+ */
+export const getFileConfigHash = (options: IconJsonOptions): string => {
+  try {
+    const defaults = getDefaultIconOptions();
+    let fileConfigString = '';
+    if (
+      options.saturation !== defaults.saturation ||
+      options.opacity !== defaults.opacity ||
+      options.folders?.color !== defaults.folders.color
+    ) {
+      fileConfigString += `~${getHash(JSON.stringify(options))}`;
+    }
+    return fileConfigString;
+  } catch (error) {
+    console.error(error);
+    return '';
+  }
+};
+
+const getHash = (value: string) => {
+  let hash = 0;
+  let chr = 0;
+
+  if (value.length === 0) return hash;
+  for (let i = 0; i < value.length; i++) {
+    chr = value.charCodeAt(i);
+    hash = (hash << 5) - hash + chr;
+    hash |= 0; // Convert to 32bit integer
+  }
+  return hash;
+};

package/src/helpers/index.ts

@@ -1,100 +1,100 @@
-import * as fs from 'fs';
-import * as path from 'path';
-import * as vscode from 'vscode';
-import { iconJsonName } from '../icons/index';
-import { IconConfiguration } from '../models/index';
-import * as reloadMessages from './../messages/reload';
-
-/** Get configuration of vs code. */
-export const getConfig = (section?: string) => {
-  return vscode.workspace.getConfiguration(section);
-};
-
-/** Get list of configuration entries of package.json */
-export const getConfigProperties = (): { [config: string]: unknown } => {
-  return vscode.extensions.getExtension('PKief.material-icon-theme')
-    ?.packageJSON?.contributes?.configuration?.properties;
-};
-
-/** Update configuration of vs code. */
-export const setConfig = (
-  section: string,
-  value: any,
-  global: boolean = false
-) => {
-  return getConfig().update(section, value, global);
-};
-
-export const getThemeConfig = (section: string) => {
-  return getConfig('material-icon-theme').inspect(section);
-};
-
-/** Set the config of the theme. */
-export const setThemeConfig = (
-  section: string,
-  value: any,
-  global: boolean = false
-) => {
-  return getConfig('material-icon-theme').update(section, value, global);
-};
-
-/**
- * Checks if the theme is the active icon theme
- * @param{boolean} global false by default
- */
-export const isThemeActivated = (global: boolean = false): boolean => {
-  return global
-    ? getConfig().inspect('workbench.iconTheme')?.globalValue ===
-        'material-icon-theme'
-    : getConfig().inspect('workbench.iconTheme')?.workspaceValue ===
-        'material-icon-theme';
-};
-
-/** Checks if the theme is not the active icon theme */
-export const isThemeNotVisible = (): boolean => {
-  const config = getConfig().inspect('workbench.iconTheme');
-  return (
-    (!isThemeActivated(true) && !config?.workspaceValue) || // no workspace and not global
-    (!isThemeActivated() && !!config?.workspaceValue)
-  );
-};
-
-/** Return the path of the extension in the file system. */
-export const getExtensionPath = () =>
-  vscode.extensions.getExtension('PKief.material-icon-theme')?.extensionPath ??
-  '';
-
-/** Get the configuration of the icons as JSON Object */
-export const getMaterialIconsJSON = (): IconConfiguration => {
-  const iconJSONPath = path.join(getExtensionPath(), 'dist', iconJsonName);
-
-  try {
-    const data = fs.readFileSync(iconJSONPath, 'utf8');
-    return JSON.parse(data);
-  } catch (error) {
-    console.error(error);
-    return {};
-  }
-};
-
-/** Reload vs code window */
-export const promptToReload = async () => {
-  const result = await reloadMessages.showConfirmToReloadMessage();
-  if (result) reloadWindow();
-};
-
-const reloadWindow = () => {
-  return vscode.commands.executeCommand('workbench.action.reloadWindow');
-};
-
-/** Capitalize the first letter of a string */
-export const capitalizeFirstLetter = (name: string): string =>
-  name.charAt(0).toUpperCase() + name.slice(1);
-
-/** TitleCase all words in a string */
-export const toTitleCase = (value: string) => {
-  return value.replace(
-    /\w\S*/g,
-    (text) => text.charAt(0).toUpperCase() + text.substr(1).toLowerCase()
-  );
-};
+import * as fs from 'fs';
+import * as path from 'path';
+import * as vscode from 'vscode';
+import { iconJsonName } from '../icons/index';
+import { IconConfiguration } from '../models/index';
+import * as reloadMessages from './../messages/reload';
+
+/** Get configuration of vs code. */
+export const getConfig = (section?: string) => {
+  return vscode.workspace.getConfiguration(section);
+};
+
+/** Get list of configuration entries of package.json */
+export const getConfigProperties = (): { [config: string]: unknown } => {
+  return vscode.extensions.getExtension('PKief.material-icon-theme')
+    ?.packageJSON?.contributes?.configuration?.properties;
+};
+
+/** Update configuration of vs code. */
+export const setConfig = (
+  section: string,
+  value: any,
+  global: boolean = false
+) => {
+  return getConfig().update(section, value, global);
+};
+
+export const getThemeConfig = (section: string) => {
+  return getConfig('material-icon-theme').inspect(section);
+};
+
+/** Set the config of the theme. */
+export const setThemeConfig = (
+  section: string,
+  value: any,
+  global: boolean = false
+) => {
+  return getConfig('material-icon-theme').update(section, value, global);
+};
+
+/**
+ * Checks if the theme is the active icon theme
+ * @param{boolean} global false by default
+ */
+export const isThemeActivated = (global: boolean = false): boolean => {
+  return global
+    ? getConfig().inspect('workbench.iconTheme')?.globalValue ===
+        'material-icon-theme'
+    : getConfig().inspect('workbench.iconTheme')?.workspaceValue ===
+        'material-icon-theme';
+};
+
+/** Checks if the theme is not the active icon theme */
+export const isThemeNotVisible = (): boolean => {
+  const config = getConfig().inspect('workbench.iconTheme');
+  return (
+    (!isThemeActivated(true) && !config?.workspaceValue) || // no workspace and not global
+    (!isThemeActivated() && !!config?.workspaceValue)
+  );
+};
+
+/** Return the path of the extension in the file system. */
+export const getExtensionPath = () =>
+  vscode.extensions.getExtension('PKief.material-icon-theme')?.extensionPath ??
+  '';
+
+/** Get the configuration of the icons as JSON Object */
+export const getMaterialIconsJSON = (): IconConfiguration => {
+  const iconJSONPath = path.join(getExtensionPath(), 'dist', iconJsonName);
+
+  try {
+    const data = fs.readFileSync(iconJSONPath, 'utf8');
+    return JSON.parse(data);
+  } catch (error) {
+    console.error(error);
+    return {};
+  }
+};
+
+/** Reload vs code window */
+export const promptToReload = async () => {
+  const result = await reloadMessages.showConfirmToReloadMessage();
+  if (result) reloadWindow();
+};
+
+const reloadWindow = () => {
+  return vscode.commands.executeCommand('workbench.action.reloadWindow');
+};
+
+/** Capitalize the first letter of a string */
+export const capitalizeFirstLetter = (name: string): string =>
+  name.charAt(0).toUpperCase() + name.slice(1);
+
+/** TitleCase all words in a string */
+export const toTitleCase = (value: string) => {
+  return value.replace(
+    /\w\S*/g,
+    (text) => text.charAt(0).toUpperCase() + text.substr(1).toLowerCase()
+  );
+};