Preparations to use javascript modules and other small fixes (#1050)

* Preparing commit hook to accept mjs and cjs files, avoiding deleted files

* Renaming window-aux and app-config to .cjs

* Updating renderer electron imports

* Adding 'use strict' to all files

* Switching 'fs' import to use import

* Switching 'electron-store' import to use import

* Switching notification.js to use export

* Switching 'path' import to use import

* Switching 'electron' to use import

* Export section to have commas and be sorted, last line at end

* Adding all 3 js extensions to eslint target

* Small updates to cjs files to switch CRLF to LF, adding attributes

.gitattributes

@@ -10,6 +10,7 @@
 *.bat             text eol=crlf
 *.cmd             text eol=crlf
 *.coffee          text
+*.cjs             text eol=lf
 *.css             text
 *.htm             text diff=html
 *.html            text diff=html
@@ -21,6 +22,7 @@
 *.less            text
 *.ls              text
 *.map             text -diff
+*.mjs             text eol=lf
 *.od              text
 *.onlydata        text
 *.php             text diff=php

.husky/pre-commit

@@ -13,7 +13,7 @@ get_changed_files()
     while read -d $'\0' file
     do
         echo ${file}
-    done < <(git diff --staged -z --name-only -- "$@")
+    done < <(git diff --staged -z --name-only --diff-filter=d -- "$@")
 }
 
 readarray -t changed_css < <(get_changed_files 'css/*.css')
@@ -22,7 +22,7 @@ if [ ! -z "$changed_css" ]; then
     pids="$pids $!"
 fi
 
-readarray -t changed_js < <(get_changed_files '*/*.js')
+readarray -t changed_js < <(get_changed_files '*/*.cjs' '*/*.js' '*/*.mjs')
 if [ ! -z "$changed_js" ]; then
     npx eslint "${changed_js[@]}" &
     pids="$pids $!"

__tests__/__main__/import-export.js

@@ -8,9 +8,9 @@ const {
     validEntry
 } = require('../../js/import-export');
 
-const fs = require('fs');
-const Store = require('electron-store');
-const path = require('path');
+import fs from 'fs';
+import Store from 'electron-store';
+import path from 'path';
 
 describe('Import export', function()
 {

__tests__/__main__/main-window.js

@@ -1,7 +1,9 @@
+'use strict';
+
 const notification = require('../../js/notification.js');
 const userPreferences = require('../../js/user-preferences.js');
 const { savePreferences, defaultPreferences, resetPreferences } = userPreferences;
-const { app, BrowserWindow, ipcMain } = require('electron');
+import { app, BrowserWindow, ipcMain } from 'electron';
 
 jest.mock('../../js/update-manager', () => ({
     checkForUpdates: jest.fn(),

__tests__/__main__/menus.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const { getContextMenuTemplate, getDockMenuTemplate, getEditMenuTemplate, getHelpMenuTemplate, getMainMenuTemplate, getViewMenuTemplate} = require('../../js/menus.js');
 
 jest.mock('../../src/configs/i18next.config.js', () => ({

__tests__/__main__/notification.js

@@ -4,7 +4,7 @@
 const { createNotification, createLeaveNotification, updateDismiss, getDismiss } = require('../../js/notification.js');
 const { getUserPreferences, savePreferences, resetPreferences } = require('../../js/user-preferences.js');
 const { getDateStr } = require('../../js/date-aux.js');
-const { app } = require('electron');
+import { app } from 'electron';
 
 function buildTimeString(now)
 {

__tests__/__main__/time-balance.js

@@ -1,7 +1,7 @@
 /* eslint-disable no-undef */
 'use strict';
 
-const Store = require('electron-store');
+import Store from 'electron-store';
 import {
     computeAllTimeBalanceUntil,
     getFirstInputInDb,

__tests__/__main__/update-manager.js

@@ -1,4 +1,6 @@
-const ElectronStore = require('electron-store');
+'use strict';
+
+import Store from 'electron-store';
 const { getDateStr } = require('../../js/date-aux');
 const {shouldCheckForUpdates, checkForUpdates} = require('../../js/update-manager');
 
@@ -26,7 +28,7 @@ describe('js/update-manager.js', () =>
     {
         test('Should return true when was never checked', () =>
         {
-            const store = new ElectronStore();
+            const store = new Store();
             store.set('update-remind-me-after', false);
             expect(shouldCheckForUpdates()).toBe(true);
         });
@@ -35,15 +37,15 @@ describe('js/update-manager.js', () =>
         {
             const now = new Date();
             now.setDate(now.getDate() - 1);
-            const store = new ElectronStore();
+            const store = new Store();
             store.set('update-remind-me-after', getDateStr(now));
             expect(shouldCheckForUpdates()).toBe(true);
         });
 
         test('Should return false when was checked today', () =>
         {
             const now = new Date();
-            const store = new ElectronStore();
+            const store = new Store();
             store.set('update-remind-me-after', getDateStr(now));
             expect(shouldCheckForUpdates()).toBe(false);
         });

__tests__/__main__/user-preferences.js

@@ -2,7 +2,7 @@
 'use strict';
 
 const { booleanInputs, defaultPreferences, getDefaultWidthHeight, getPreferencesFilePath, getUserPreferences, savePreferences, showDay, switchCalendarView, notificationIsEnabled, getUserLanguage, getNotificationsInterval, repetitionIsEnabled, getUserPreferencesPromise, resetPreferences } = require('../../js/user-preferences');
-const fs = require('fs');
+import fs from 'fs';
 const { themeOptions } = require('../../renderer/themes');
 const { getLanguageMap, getLanguagesCodes, getLanguageName } = require('../../src/configs/app.config');
 

__tests__/__main__/windows.js

@@ -1,4 +1,6 @@
-const { BrowserWindow } = require('electron');
+'use strict';
+
+import { BrowserWindow } from 'electron';
 const { getDateStr } = require('../../js/date-aux.js');
 const windows = require('../../js/windows.js');
 const {getWaiverWindow, tray, contextMenu, prefWindow, resetWindowsElements, openWaiverManagerWindow, getDialogCoordinates} = require('../../js/windows.js');

__tests__/__renderer__/classes/BaseCalendar.js

@@ -1,8 +1,9 @@
-import ElectronStore from 'electron-store';
+'use strict';
+
+import Store from 'electron-store';
 import { BaseCalendar } from '../../../renderer/classes/BaseCalendar.js';
 import { generateKey } from '../../../js/date-db-formatter.js';
 import { getUserPreferences, resetPreferences, savePreferences, switchCalendarView } from '../../../js/user-preferences.js';
-const Store = require('electron-store');
 const timeBalance = require('../../../js/time-balance');
 import { calendarApi } from '../../../renderer/preload-scripts/calendar-api.js';
 
@@ -47,9 +48,9 @@ describe('BaseCalendar.js', () =>
     const mocks = {};
     beforeEach(() =>
     {
-        const flexibleStore = new ElectronStore({name: 'flexible-store'});
+        const flexibleStore = new Store({name: 'flexible-store'});
         flexibleStore.clear();
-        const waivedWorkdays = new ElectronStore({name: 'waived-workdays'});
+        const waivedWorkdays = new Store({name: 'waived-workdays'});
         waivedWorkdays.clear();
         ExtendedClass.prototype._initCalendar = () => {};
         ExtendedClass.prototype._getTargetDayForAllTimeBalance = () => {};
@@ -120,10 +121,10 @@ describe('BaseCalendar.js', () =>
         test('Should build with default internal store values', async(done) =>
         {
             ExtendedClass.prototype._initCalendar = () => { done(); };
-            const flexibleStore = new ElectronStore({name: 'flexible-store'});
+            const flexibleStore = new Store({name: 'flexible-store'});
             flexibleStore.set('flexible', 'store');
 
-            const waivedWorkdays = new ElectronStore({name: 'waived-workdays'});
+            const waivedWorkdays = new Store({name: 'waived-workdays'});
             waivedWorkdays.set('2022-01-01', {
                 reason: 'dismiss',
                 hours: '10:00'

__tests__/__renderer__/classes/CalendarFactory.js

@@ -1,3 +1,5 @@
+'use strict';
+
 import { CalendarFactory } from '../../../renderer/classes/CalendarFactory.js';
 import { FlexibleDayCalendar } from '../../../renderer/classes/FlexibleDayCalendar.js';
 import { FlexibleMonthCalendar } from '../../../renderer/classes/FlexibleMonthCalendar.js';

__tests__/__renderer__/classes/FlexibleDayCalendar.js

@@ -1,6 +1,7 @@
 /* eslint-disable no-undef */
+'use strict';
 
-const Store = require('electron-store');
+import Store from 'electron-store';
 import { computeAllTimeBalanceUntilAsync } from '../../../js/time-balance.js';
 import { defaultPreferences } from '../../../js/user-preferences.js';
 import { CalendarFactory } from '../../../renderer/classes/CalendarFactory.js';

__tests__/__renderer__/classes/FlexibleMonthCalendar.js

@@ -1,7 +1,7 @@
 /* eslint-disable no-undef */
 'use strict';
 
-const Store = require('electron-store');
+import Store from 'electron-store';
 import { computeAllTimeBalanceUntilAsync } from '../../../js/time-balance.js';
 import { defaultPreferences } from '../../../js/user-preferences.js';
 import { CalendarFactory } from '../../../renderer/classes/CalendarFactory.js';

__tests__/__renderer__/notification-channel.js

@@ -1,3 +1,5 @@
+'use strict';
+
 const notificationChannel = require('../../renderer/notification-channel.js');
 
 describe('Notifications channel',  () =>

__tests__/__renderer__/preferences.js

@@ -1,8 +1,8 @@
 /* eslint-disable no-undef */
 'use strict';
 
-const fs = require('fs');
-const path = require('path');
+import fs from 'fs';
+import path from 'path';
 const {
     defaultPreferences,
     getPreferencesFilePath,

__tests__/__renderer__/user-preferences.js

@@ -9,7 +9,7 @@ const {
     isNotBoolean,
     isNotificationInterval,
 } = require('../../js/user-preferences');
-const fs = require('fs');
+import fs from 'fs';
 
 describe('Should return false if the value is not boolean type', () =>
 {

__tests__/__renderer__/window-aux.js

@@ -1,11 +1,11 @@
 /* eslint-disable no-undef */
 'use strict';
 
-const path = require('path');
+import path from 'path';
 const BrowserWindow = require('@electron/remote').BrowserWindow;
-import * as windowAux from '../../js/window-aux.js';
+import * as windowAux from '../../js/window-aux.cjs';
 
-describe('window-aux.js Testing', function()
+describe('window-aux.cjs Testing', function()
 {
     process.env.NODE_ENV = 'test';
 

__tests__/__renderer__/workday-waiver.js

@@ -1,9 +1,9 @@
 /* eslint-disable no-undef */
 'use strict';
 
-const Store = require('electron-store');
-const fs = require('fs');
-const path = require('path');
+import Store from 'electron-store';
+import fs from 'fs';
+import path from 'path';
 const Holidays = require('date-holidays');
 /* eslint-disable-next-line no-global-assign */
 window.$ = require('jquery');
@@ -150,7 +150,7 @@ async function testWaiverCount(expected)
     expect($('#waiver-list-table tbody')[0].rows.length).toBe(expected);
 }
 
-jest.mock('../../js/window-aux.js');
+jest.mock('../../js/window-aux.cjs');
 
 describe('Test Workday Waiver Window', function()
 {

esm-main.js

@@ -1,15 +1,15 @@
 /*eslint-disable no-useless-escape*/
 'use strict';
 
-const { app, ipcMain } = require('electron');
+import { app, ipcMain } from 'electron';
 const { createWindow, createMenu, getMainWindow, triggerStartupDialogs } = require('./js/main-window');
 const { createNotification } = require('./js/notification');
 const { openWaiverManagerWindow } = require('./js/windows.js');
 const { setupI18n, getCurrentTranslation, setLanguageChangedCallback } = require('./src/configs/i18next.config.js');
 const { handleSquirrelEvent } = require('./js/squirrel.js');
-const { showAlert, showDialogSync } = require('./js/window-aux.js');
+const { showAlert, showDialogSync } = require('./js/window-aux.cjs');
 
-import { appConfig } from './js/app-config.js';
+import { appConfig } from './js/app-config.cjs';
 import { setupCalendarStore } from './main/calendar-aux.js';
 
 if (appConfig.win32)

js/app-config.js → js/app-config.cjs

@@ -1,8 +1,8 @@
 'use strict';
 
 const { app } = require('electron');
-const path = require('path');
 const os = require('os');
+const path = require('path');
 
 const macOS = process.platform === 'darwin';
 const win32 = process.platform === 'win32';
@@ -29,7 +29,7 @@ function getDetails()
     return `Version: ${version}\nElectron: ${electronVersion}\nChrome: ${chromeVersion}\nNode.js: ${nodeVersion}\nOS: ${OSInfo}`;
 }
 
-export {
+module.exports = {
     appConfig,
-    getDetails
-};
+    getDetails,
+};

js/date-aux.js

@@ -43,5 +43,7 @@ function getCurrentDateTimeStr()
 }
 
 export {
-    getDateStr, getMonthLength, getCurrentDateTimeStr
+    getCurrentDateTimeStr,
+    getDateStr,
+    getMonthLength,
 };

js/date-db-formatter.js

@@ -13,5 +13,5 @@ function generateKey(year, month, day)
 }
 
 export {
-    generateKey,
-};
+    generateKey
+};

js/date-to-string-util.js

@@ -28,5 +28,5 @@ function getMonthName(languageData, monthIndex)
 
 export {
     getDayAbbr,
-    getMonthName
+    getMonthName,
 };

js/demo-generator.js

@@ -1,6 +1,8 @@
+'use strict';
+
 const { hourMinToHourFormatted, sumTime } = require('./time-math.js');
 const { generateKey } = require('./date-db-formatter.js');
-const Store = require('electron-store');
+import Store from 'electron-store';
 
 /**
  * Returns a random integer between min (inclusive) and max (inclusive), rounding up to closest multiple of 5
@@ -66,4 +68,4 @@ function generateDemoInformation(dateFromStr, dateToStr, workingDays, usualTimes
 
 module.exports = {
     generateDemoInformation
-};
+};

js/import-export.js

@@ -1,8 +1,8 @@
 /*eslint-disable no-prototype-builtins*/
 'use strict';
 
-const Store = require('electron-store');
-const fs = require('fs');
+import Store from 'electron-store';
+import fs from 'fs';
 
 import { validateTime } from './time-math.js';
 import { generateKey } from './date-db-formatter.js';
@@ -221,8 +221,8 @@ function migrateFixedDbToFlexible()
 }
 
 module.exports = {
-    importDatabaseFromFile,
     exportDatabaseToFile,
+    importDatabaseFromFile,
     migrateFixedDbToFlexible,
-    validEntry
+    validEntry,
 };