material-icon-theme 3.7.1 → 4.15.0

package/src/helpers/fileConfig.ts

@@ -0,0 +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;
+};

package/src/helpers/index.ts

@@ -1,87 +1,100 @@
-import * as fs from 'fs';
-import * as path from 'path';
-import * as vscode from 'vscode';
-import { iconJsonName } from '../icons/index';
-import { AdvancedWorkspaceConfiguration } from '../models';
-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) as AdvancedWorkspaceConfiguration;
-};
-
-/** Get list of configuration entries of package.json */
-export const getConfigProperties = (): { [config: string]: any } => {
-    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);
-};
-
-/** Is a folder opened? */
-export const hasWorkspace = (): boolean => {
-    return vscode.workspace.rootPath !== undefined;
-};
-
-/** 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);
-};
-
-/**
- * Is the theme already activated in the editor configuration?
- * @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';
-};
-
-/** Is the theme not visible for the user? */
-export const isThemeNotVisible = (): boolean => {
-    const config = getConfig().inspect('workbench.iconTheme');
-    return (!isThemeActivated(true) && config.workspaceValue === undefined) || // no workspace and not global
-        (!isThemeActivated() && config.workspaceValue !== undefined);
-};
-
-/** 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 undefined;
-    }
-};
-
-/** Reload vs code window */
-export const promptToReload = () => {
-    return reloadMessages.showConfirmToReloadMessage().then(result => {
-        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 = (str) => {
-    return str.replace(/\w\S*/g, (txt) => { return txt.charAt(0).toUpperCase() + txt.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()
+  );
+};

package/src/helpers/objects.ts

@@ -1,55 +1,58 @@
-/**
- * Get the nested properties of an object
- * This solution is lighter than the lodash get-version and works fine for the translations.
- * Source: http://stackoverflow.com/a/6491621/6942210
- */
-export const getObjectPropertyValue = (obj: Object, path: string) => {
-    // convert indexes to properties
-    path = path.replace(/\[(\w+)\]/g, '.$1');
-
-    // strip a leading dot
-    path = path.replace(/^\./, '');
-
-    // separate paths in array
-    let pathArray = path.split('.');
-
-    /** Avoid errors in the getValue function. */
-    const isObject = (object) => {
-        return object === Object(object);
-    };
-
-    for (let i = 0; i < pathArray.length; ++i) {
-        let k = pathArray[i];
-        if (isObject(obj) && k in obj) {
-            obj = obj[k];
-        } else {
-            return;
-        }
-    }
-    return obj;
-};
-
-/**
- * Set a value for a nested object property.
- * @param obj Object
- * @param path Properties as string e.g. `'a.b.c'`
- * @param value Value to be set for the given property
- * Source: https://stackoverflow.com/a/13719799/6942210
- */
-export const setObjectPropertyValue = (obj: Object, path, value) => {
-    if (typeof path === 'string') {
-        path = path.split('.');
-    }
-
-    if (path.length > 1) {
-        let e = path.shift();
-        setObjectPropertyValue(obj[e] =
-            Object.prototype.toString.call(obj[e]) === '[object Object]'
-                ? obj[e]
-                : {},
-            path,
-            value);
-    } else {
-        obj[path[0]] = value;
-    }
-};
+/**
+ * Get the nested properties of an object.
+ * This solution is lighter than the lodash get-version.
+ * Source: http://stackoverflow.com/a/6491621/6942210
+ */
+export const getObjectPropertyValue = (obj: Object, path: string) => {
+  const pathArray = path
+    .replace(/\[(\w+)\]/g, '.$1') // convert indexes to properties
+    .replace(/^\./, '') // strip a leading dot
+    .split('.'); // separate paths in array
+
+  /** Avoid errors in the getValue function. */
+  const isObject = (object: unknown) => {
+    return object === Object(object);
+  };
+  let result = JSON.parse(JSON.stringify(obj));
+
+  for (let i = 0; i < pathArray.length; ++i) {
+    const k = pathArray[i];
+    if (isObject(result) && k in result) {
+      result = result[k];
+    } else {
+      return;
+    }
+  }
+  return result;
+};
+
+/**
+ * Set a value for a nested object property.
+ * @param obj Object
+ * @param path Properties as string e.g. `'a.b.c'`
+ * @param value Value to be set for the given property
+ * Source: https://stackoverflow.com/a/13719799/6942210
+ */
+export const setObjectPropertyValue = (
+  obj: { [key: string]: any },
+  path: string | string[],
+  value: any
+) => {
+  if (typeof path === 'string') {
+    path = path.split('.');
+  }
+
+  if (path.length > 1) {
+    const e = path.shift() ?? '';
+    setObjectPropertyValue(
+      (obj[e] =
+        Object.prototype.toString.call(obj[e]) === '[object Object]'
+          ? obj[e]
+          : {}),
+      path,
+      value
+    );
+  } else {
+    obj[path[0]] = value;
+  }
+};

package/src/helpers/types.ts

@@ -0,0 +1,7 @@
+export type RequireAtLeastOne<T, Keys extends keyof T = keyof T> = Pick<
+  T,
+  Exclude<keyof T, Keys>
+> &
+  {
+    [K in Keys]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<Keys, K>>>;
+  }[Keys];

package/src/helpers/versioning.ts

@@ -1,58 +1,73 @@
-import * as semver from 'semver';
-import * as vscode from 'vscode';
-import * as helpers from './index';
-
-export enum ThemeStatus {
-    neverUsedBefore,
-    updated,
-    current
-}
-
-/** Check the current status of the theme */
-export const checkThemeStatus = async (state: vscode.Memento) => {
-    try {
-        // get the version from the state
-        const stateVersion = state.get('material-icon-theme.version');
-        const packageVersion = getCurrentExtensionVersion();
-
-        // check if the theme was used before
-        if (stateVersion === undefined) {
-            await updateExtensionVersionInMemento(state);
-            return themeIsAlreadyActivated() ? ThemeStatus.updated : ThemeStatus.neverUsedBefore;
-        }
-        // compare the version in the state with the package version
-        else if (semver.lt(stateVersion, packageVersion)) {
-            await updateExtensionVersionInMemento(state);
-            return ThemeStatus.updated;
-        }
-        else {
-            return ThemeStatus.current;
-        }
-    }
-    catch (error) {
-        console.error(error);
-    }
-};
-
-/** Check if the theme was used before */
-const themeIsAlreadyActivated = () => {
-    return helpers.isThemeActivated() || helpers.isThemeActivated(true);
-};
-
-/** Update the version number to the current version in the memento. */
-const updateExtensionVersionInMemento = (state: vscode.Memento) => {
-    return state.update('material-icon-theme.version', getCurrentExtensionVersion());
-};
-
-/** Get the current version of the extension */
-const getCurrentExtensionVersion = (): string => {
-    return vscode.extensions.getExtension('PKief.material-icon-theme').packageJSON.version;
-};
-
-/**
- * Check if the current version of VS Code
- * supports new features.
-*/
-export const checkVersionSupport = (supportedVersion: string): boolean => {
-    return !semver.lt(vscode.version, supportedVersion);
-};
+import { extensions, Memento, workspace } from 'vscode';
+import { isThemeActivated } from '.';
+import { ThemeStatus } from '../models/helpers/themeStatus';
+
+/** Get configuration of vs code. */
+export const getConfig = (section?: string) => {
+  return workspace.getConfiguration(section);
+};
+
+export const versionKey = 'material-icon-theme.version';
+
+/**
+ * Check the current status of the theme
+ * @param state Global state of context (Memento API)
+ */
+export const checkThemeStatus = async (
+  state: Memento
+): Promise<ThemeStatus> => {
+  try {
+    // get the version from the state
+    const stateVersion = state.get(versionKey);
+    const packageVersion = getCurrentExtensionVersion();
+
+    // check if the theme was used before
+    if (stateVersion === undefined || typeof stateVersion !== 'string') {
+      await updateExtensionVersionInMemento(state);
+      return themeIsAlreadyActivated()
+        ? ThemeStatus.updated
+        : ThemeStatus.neverUsedBefore;
+    }
+    // compare the version in the state with the package version
+    else if (packageVersion && isGreaterVersion(packageVersion, stateVersion)) {
+      await updateExtensionVersionInMemento(state);
+      return ThemeStatus.updated;
+    } else {
+      return ThemeStatus.current;
+    }
+  } catch (error) {
+    console.error(error);
+    return ThemeStatus.current;
+  }
+};
+
+/**
+ * Compares two version numbers (e.g. 1.0.0 with 1.0.1)
+ * @param a version b
+ * @param b version a
+ * @returns true if version `a` is greater than version `b`
+ */
+const isGreaterVersion = (a: string, b: string): boolean => {
+  return (
+    a.localeCompare(b, undefined, { numeric: true, sensitivity: 'base' }) === 1
+  );
+};
+
+/** Check if the theme was used before */
+const themeIsAlreadyActivated = () => {
+  return isThemeActivated() || isThemeActivated(true);
+};
+
+/** Update the version number to the current version in the memento. */
+const updateExtensionVersionInMemento = (state: Memento) => {
+  const currentVersion = getCurrentExtensionVersion();
+  if (currentVersion) {
+    return state.update(versionKey, currentVersion);
+  }
+};
+
+/** Get the current version of the extension */
+const getCurrentExtensionVersion = (): string | undefined => {
+  return extensions.getExtension('PKief.material-icon-theme')?.packageJSON
+    .version;
+};

package/src/i18n/index.ts

@@ -1,82 +1,78 @@
-import * as vscode from 'vscode';
-import { getObjectPropertyValue } from '../helpers/objects';
-
-// Get current language of the vs code workspace
-export const getCurrentLanguage = (): string =>
-    vscode.env.language;
-
-let currentTranslation;
-let fallbackTranslation; // default: en
-const PLACEHOLDER = '%';
-
-/** Initialize the translations */
-export const initTranslations = async () => {
-    try {
-        currentTranslation = await loadTranslation(getCurrentLanguage());
-        fallbackTranslation = await loadTranslation('en');
-    }
-    catch (error) {
-        console.error(error);
-    }
-};
-
-/** Load the required translation */
-const loadTranslation = async (language: string) => {
-    try {
-        return await getTranslationObject(language);
-    } catch (error) {
-        console.error(error);
-        return await getTranslationObject('en');
-    }
-};
-
-/** Get the translation object of the separated translation files */
-const getTranslationObject = async (language: string) => {
-    try {
-        const lang = await import(/* webpackMode: "eager" */ `./lang-${language}`);
-        return lang.translation;
-    }
-    catch (error) {
-        console.error(error);
-    }
-};
-
-/**
- * We look up the matching translation in the translation files.
- * If we cannot find a matching key in the file we use the fallback.
- * With optional parameters you can configure both the translations
- * and the fallback (required for testing purposes).
- * */
-export const getTranslationValue = (key: string, translations = currentTranslation, fallback = fallbackTranslation) => {
-    return getObjectPropertyValue(translations, key) ?
-        getObjectPropertyValue(translations, key) :
-        getObjectPropertyValue(fallback, key) ?
-            getObjectPropertyValue(fallback, key) : undefined;
-};
-
-/**
- * The instant method is required for the translate pipe.
- * It helps to translate a word instantly.
- */
-export const translate = (key: string, words?: string | string[]) => {
-    const translation = <string>getTranslationValue(key);
-
-    if (!words) return translation;
-    return replace(translation, words);
-};
-
-/**
- * The replace function will replace the current placeholder with the
- * data parameter from the translation. You can give it one or more optional
- * parameters ('words').
- */
-export const replace = (value: string = '', words: string | string[]) => {
-    let translation: string = value;
-
-    const values: string[] = [].concat(words);
-    values.forEach((e, i) => {
-        translation = translation.replace(PLACEHOLDER.concat(<any>i), e);
-    });
-
-    return translation;
-};
+import * as vscode from 'vscode';
+import { getObjectPropertyValue } from '../helpers/objects';
+import { Translation } from '../models';
+
+// Get current language of the vs code workspace
+export const getCurrentLanguage = (): string => vscode.env.language;
+
+let currentTranslation: Translation;
+let fallbackTranslation: Translation;
+
+const placeholder = '%';
+
+/** Initialize the translations */
+export const initTranslations = async () => {
+  try {
+    currentTranslation = await loadTranslation(getCurrentLanguage());
+    fallbackTranslation = await loadTranslation('en');
+  } catch (error) {
+    console.error(error);
+  }
+};
+
+/** Load the required translation */
+const loadTranslation = async (language: string) => {
+  try {
+    return await getTranslationObject(language);
+  } catch (error) {
+    return await getTranslationObject('en');
+  }
+};
+
+/** Get the translation object of the separated translation files */
+const getTranslationObject = async (language: string): Promise<Translation> => {
+  const lang = await import(/* webpackMode: "eager" */ `./lang-${language}`);
+  return lang.translation as Translation;
+};
+
+/**
+ * We look up the matching translation in the translation files.
+ * If we cannot find a matching key in the file we use the fallback.
+ * With optional parameters you can configure both the translations
+ * and the fallback (required for testing purposes).
+ * */
+export const getTranslationValue = (
+  key: string,
+  translations = currentTranslation,
+  fallback = fallbackTranslation
+): string | undefined => {
+  return (
+    getObjectPropertyValue(translations, key) ??
+    getObjectPropertyValue(fallback, key)
+  );
+};
+
+/**
+ * The instant method is required for the translate pipe.
+ * It helps to translate a word instantly.
+ */
+export const translate = (key: string, ...variables: string[]): string => {
+  const translation = getTranslationValue(key);
+
+  if (variables.length === 0) return translation ?? key;
+  return replace(translation, ...variables);
+};
+
+/**
+ * The replace function will replace the current placeholder with the
+ * data parameter from the translation. You can give it one or more optional
+ * parameters ('variables').
+ */
+export const replace = (value: string = '', ...variables: string[]) => {
+  let translation: string = value;
+  variables.forEach((variable, i) => {
+    translation = translation.replace(`${placeholder}${i}`, variable);
+  });
+
+  return translation;
+};