Ux/reload notification (#232)

* chore: check on installation type now as single module

* feat(Reload notification): added support for after-install notification

* feat(Reload notification): added support never show again notification

extensions/helpers/check-installation.ts

@@ -0,0 +1,34 @@
+import {getDefaultValues, getPackageJSON} from './fs';
+import {IInstallationType} from '../interfaces/iinstallation-type';
+
+const splitVersion = (input: string): {major: number; minor: number; patch: number} => {
+  const [major, minor, patch] = input.split('.').map(i => parseInt(i, 10));
+  return {major, minor, patch};
+};
+
+export default (): IInstallationType => {
+  const out: IInstallationType = {
+    isUpdate: false,
+    isFirstInstall: false
+  };
+
+  const defaults = getDefaultValues();
+  const packageJSON = getPackageJSON();
+
+  const isFirstInstall = defaults.changelog === undefined ||
+     (defaults.changelog !== undefined && typeof defaults.changelog.lastversion !== 'string');
+
+  if (isFirstInstall) {
+    return {...out, isFirstInstall};
+  }
+
+  const versionCurrent = splitVersion(packageJSON.version);
+  const versionOld = isFirstInstall ? null : splitVersion(defaults.changelog.lastversion);
+
+  const isUpdate = !versionOld ||
+    versionCurrent.major > versionOld.major ||
+    versionCurrent.minor > versionOld.minor ||
+    versionCurrent.patch > versionOld.patch;
+
+  return {...out, isUpdate};
+};

extensions/helpers/configuration-change.ts

@@ -1,13 +1,10 @@
 import {
   ConfigurationChangeEvent
 } from 'vscode';
-import {getCustomSettings, isMaterialThemeIcons, isAutoApplyEnable, isMaterialTheme} from './settings';
+import {getCustomSettings, isMaterialThemeIcons, isMaterialTheme} from './settings';
 import {getCurrentThemeIconsID, getCurrentThemeID} from './vscode';
 
-import * as ThemeCommands from './../commands';
+import handleAutoapply from './handle-autoapply';
-import {infoMessage} from './messages';
-
-const icons = () => isAutoApplyEnable() ? ThemeCommands.fixIcons() : infoMessage();
 
 const onIconsChanged = () => {
   const customSettings = getCustomSettings();
@@ -16,27 +13,18 @@ const onIconsChanged = () => {
   }
 
   const currentIconsTheme = getCurrentThemeIconsID();
-  if (isMaterialThemeIcons(currentIconsTheme)) {
+  return handleAutoapply(isMaterialThemeIcons(currentIconsTheme));
-    return icons();
-  }
 };
 
 const onThemeChanged = () => {
   const currentTheme = getCurrentThemeID();
-  if (isMaterialTheme(currentTheme)) {
+  return handleAutoapply(isMaterialTheme(currentTheme));
-    return icons();
-  }
 };
 
 export const onChangeConfiguration = (event: ConfigurationChangeEvent) => {
   const isColorTheme = event.affectsConfiguration('workbench.colorTheme');
   const isIconTheme = event.affectsConfiguration('workbench.iconTheme');
 
-  if (isIconTheme) {
+  return isIconTheme ? onIconsChanged() :
-    return onIconsChanged();
+          isColorTheme ? onThemeChanged() : null;
-  }
-
-  if (isColorTheme) {
-    return onThemeChanged();
-  }
 };

extensions/helpers/handle-autoapply.ts

@@ -0,0 +1,31 @@
+import {isAutoApplyEnable, isReloadNotificationEnable, setCustomSetting} from './settings';
+import {infoMessage} from './messages';
+import {fixIcons} from '../commands';
+
+export default async (doubleCheck: boolean) => {
+  if (!doubleCheck) {
+    return;
+  }
+
+  if (isAutoApplyEnable()) {
+    return fixIcons();
+  }
+
+  if (!isReloadNotificationEnable()) {
+    return;
+  }
+
+  const result = await infoMessage();
+
+  if (result.nomore) {
+    return setCustomSetting('showReloadNotification', false);
+  }
+
+  if (result.autoreload) {
+    setCustomSetting('autoApplyIcons', true);
+  }
+
+  if (result.reload) {
+    return fixIcons();
+  }
+};

extensions/helpers/messages.ts

@@ -2,24 +2,52 @@ import {
   window as Window
 } from 'vscode';
 
-import * as ThemeCommands from './../commands';
-
 const MESSAGES = {
   INFO: {
     message: 'Do you want to reload to apply Material Theme Icons to enjoy the full experience?',
-    options: {ok: 'Yeah, releoad', cancel: 'No, thank you'}
+    options: {ok: 'Yeah, reload', autoreload: 'Yes and enable auto-reload', cancel: 'No, thank you', nomore: 'Never show again'}
   },
   CHANGELOG: {
     message: 'Material Theme was updated. Check the release notes for more details.',
     options: {ok: 'Show me', cancel: 'Maybe later'}
+  },
+  INSTALLATION: {
+    message: 'Thank you for installing Material Theme! Would you like to enable the auto-application (with window reload when needed) of the Material Theme icons?',
+    options: {ok: 'Sure!', cancel: 'Nope :('}
   }
 };
 
 export const infoMessage = async () => {
-  if (await Window.showInformationMessage(MESSAGES.INFO.message, MESSAGES.INFO.options.ok, MESSAGES.INFO.options.cancel) === MESSAGES.INFO.options.ok) {
+  const result = await Window.showInformationMessage(
-    ThemeCommands.fixIcons();
+    MESSAGES.INFO.message,
+    MESSAGES.INFO.options.ok,
+    MESSAGES.INFO.options.autoreload,
+    MESSAGES.INFO.options.cancel,
+    MESSAGES.INFO.options.nomore
+  );
+
+  switch (result) {
+    case MESSAGES.INFO.options.ok:
+      return {reload: true};
+    case MESSAGES.INFO.options.autoreload:
+      return {reload: true, autoreload: true};
+    case MESSAGES.INFO.options.nomore:
+      return {nomore: true};
+    default:
+      return {};
   }
 };
 
 export const changelogMessage = async () =>
-  await Window.showInformationMessage(MESSAGES.CHANGELOG.message, MESSAGES.CHANGELOG.options.ok, MESSAGES.CHANGELOG.options.cancel) === MESSAGES.CHANGELOG.options.ok;
+  await Window.showInformationMessage(
+    MESSAGES.CHANGELOG.message,
+    MESSAGES.CHANGELOG.options.ok,
+    MESSAGES.CHANGELOG.options.cancel
+  ) === MESSAGES.CHANGELOG.options.ok;
+
+export const installationMessage = async () =>
+  await Window.showInformationMessage(
+    MESSAGES.INSTALLATION.message,
+    MESSAGES.INSTALLATION.options.ok,
+    MESSAGES.INSTALLATION.options.cancel,
+  ) === MESSAGES.INSTALLATION.options.ok;

extensions/helpers/settings.ts

@@ -22,7 +22,14 @@ export function getCustomSettings(): IThemeCustomProperties {
  * Get autoApplyIcons
  */
 export function isAutoApplyEnable(): boolean {
-  return vscode.workspace.getConfiguration().get<boolean>('materialTheme.autoApplyIcons', true);
+  return vscode.workspace.getConfiguration().get<boolean>('materialTheme.autoApplyIcons');
+}
+
+/**
+ * Get showReloadNotification
+ */
+export function isReloadNotificationEnable(): boolean {
+  return vscode.workspace.getConfiguration().get<boolean>('materialTheme.showReloadNotification');
 }
 
 /**

extensions/helpers/should-show-changelog.ts

@@ -1,35 +0,0 @@
-import * as path from 'path';
-
-import {IDefaults} from './../interfaces/idefaults';
-
-import {getDefaultValues, getPackageJSON, writeFile} from './fs';
-
-const splitVersion = (input: string): {major: number; minor: number; patch: number} => {
-  const [major, minor, patch] = input.split('.').map(i => parseInt(i, 10));
-  return {major, minor, patch};
-};
-
-const writeDefaults = (defaults: IDefaults) =>
-  writeFile(path.join('./extensions/defaults.json'), JSON.stringify(defaults, null, 2));
-
-export default (): boolean => {
-  const defaults = getDefaultValues();
-  const packageJSON = getPackageJSON();
-
-  const defaultsNotPresent = defaults.changelog === undefined ||
-     (defaults.changelog !== undefined && typeof defaults.changelog.lastversion !== 'string');
-
-  const versionCurrent = splitVersion(packageJSON.version);
-  const versionOld = defaultsNotPresent ? null : splitVersion(defaults.changelog.lastversion);
-
-  const out = !versionOld ||
-    versionCurrent.major > versionOld.major ||
-    versionCurrent.minor > versionOld.minor ||
-    versionCurrent.patch > versionOld.patch;
-
-  const newChangelog = {...defaults.changelog, lastversion: packageJSON.version};
-  const newDefaults = {...defaults, changelog: newChangelog};
-  writeDefaults(newDefaults);
-
-  return out;
-};

extensions/helpers/write-changelog.ts

@@ -0,0 +1,16 @@
+import * as path from 'path';
+import {getDefaultValues, getPackageJSON, writeFile} from './fs';
+
+import {IDefaults} from './../interfaces/idefaults';
+
+const writeDefaults = (defaults: IDefaults) =>
+  writeFile(path.join('./extensions/defaults.json'), JSON.stringify(defaults, null, 2));
+
+export default (): void => {
+  const defaults = getDefaultValues();
+  const packageJSON = getPackageJSON();
+
+  const newChangelog = {...defaults.changelog, lastversion: packageJSON.version};
+  const newDefaults = {...defaults, changelog: newChangelog};
+  writeDefaults(newDefaults);
+};

extensions/interfaces/iinstallation-type.ts

@@ -0,0 +1,4 @@
+export interface IInstallationType {
+ isUpdate: boolean;
+ isFirstInstall: boolean;
+}

extensions/material.theme.config.ts

@@ -4,13 +4,18 @@ import {
 } from 'vscode';
 
 import * as ThemeCommands from './commands';
-import {isAutoApplyEnable} from './helpers/settings';
+import {setCustomSetting} from './helpers/settings';
 import {onChangeConfiguration} from './helpers/configuration-change';
-import {infoMessage, changelogMessage} from './helpers/messages';
+import {changelogMessage, installationMessage} from './helpers/messages';
-import shouldShowChangelog from './helpers/should-show-changelog';
+import checkInstallation from './helpers/check-installation';
+import writeChangelog from './helpers/write-changelog';
+import handleAutoapply from './helpers/handle-autoapply';
 
 export async function activate() {
   const config = Workspace.getConfiguration();
+  const installationType = checkInstallation();
+
+  writeChangelog();
 
   // Listen on set theme: when the theme is Material Theme, just adjust icon and accent.
   Workspace.onDidChangeConfiguration(onChangeConfiguration);
@@ -20,20 +25,22 @@ export async function activate() {
     config.update('materialTheme.cache.workbench', undefined, true);
   }
 
-  if (shouldShowChangelog()) {
+  if (installationType.isFirstInstall) {
-    const show = await changelogMessage();
+    const enableAutoApply = await installationMessage();
-    if (show) {
+    await setCustomSetting('autoApplyIcons', enableAutoApply);
-      ThemeCommands.showChangelog();
+    // Set true always on new installation
+    await setCustomSetting('showReloadNotification', true);
   }
+
+  const shouldShowChangelog = (installationType.isFirstInstall || installationType.isUpdate) && await changelogMessage();
+  if (shouldShowChangelog) {
+    ThemeCommands.showChangelog();
   }
 
   // Registering commands
   Commands.registerCommand('materialTheme.setAccent', async () => {
     const wasSet = await ThemeCommands.accentsSetter();
-
+    handleAutoapply(wasSet);
-    if (wasSet) {
-      return isAutoApplyEnable() ? ThemeCommands.fixIcons() : infoMessage();
-    }
   });
   Commands.registerCommand('materialTheme.fixIcons', () => ThemeCommands.fixIcons());
   Commands.registerCommand('materialTheme.toggleApplyIcons', () => ThemeCommands.toggleApplyIcons());

package.json

@@ -93,7 +93,12 @@
         },
         "materialTheme.autoApplyIcons": {
           "type": "boolean",
-          "description": "Enable/disable auto-apply of Material Theme icons",
+          "description": "Enable/disable auto-apply of Material Theme icons with window reload when needed",
+          "default": false
+        },
+        "materialTheme.showReloadNotification": {
+          "type": "boolean",
+          "description": "Useful when autoApplyIcons is false and you want to be asked to reload the window when needed",
           "default": true
         },
         "materialTheme.fixIconsRunning": {