refactor: re-order linter rules, fix linter warnings and misc cleanup

* Reorder the linter rules in alphabetical order * Install types for dependency "follow-redirects" * Fix 7 linter warnings * Do misc style changes to make the code look prettier imo
FlashpointProject · Jun 18, 2020 · 6286602 · 6286602
1 parent ab52bea
commit 6286602
Show file tree

Hide file tree

Showing 34 changed files with 109 additions and 117 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -34,27 +34,27 @@
   "root": true,
   "rules": {
     "@typescript-eslint/adjacent-overload-signatures": "off",
+    "@typescript-eslint/ban-types": ["warn", {
+      "types": {
+        "{}": false
+      },
+      "extendDefaults": true
+    }],
+    "@typescript-eslint/explicit-function-return-type": "off",
+    "@typescript-eslint/explicit-module-boundary-types": "off",
     "@typescript-eslint/indent": ["warn", 2, { 
       "MemberExpression": 0,
       "SwitchCase": 1
     }],
+    "@typescript-eslint/no-empty-function": ["warn", { "allow": ["arrowFunctions"] }],
     "@typescript-eslint/no-explicit-any": "off",
-    "@typescript-eslint/prefer-interface": "off",
-    "@typescript-eslint/no-use-before-define": "off",
-    "@typescript-eslint/explicit-function-return-type": "off",
+    "@typescript-eslint/no-namespace": "off",
     "@typescript-eslint/no-unused-vars": ["warn", {
       "vars": "all",
       "args": "none"
     }],
-    "@typescript-eslint/explicit-module-boundary-types": "off",
-    "@typescript-eslint/no-namespace": "off",
-    "@typescript-eslint/no-empty-function": ["warn", { "allow": ["arrowFunctions"] }],
-    "@typescript-eslint/ban-types": ["warn", {
-      "types": {
-        "{}": false
-      },
-      "extendDefaults": true
-    }],
+    "@typescript-eslint/no-use-before-define": "off",
+    "@typescript-eslint/prefer-interface": "off",
     "react/no-unescaped-entities": ["error", {"forbid": [{
       "char": ">",
       "alternatives": ["&gt;"]

diff --git a/package.json b/package.json
@@ -64,6 +64,7 @@
     "@types/enzyme": "3.10.5",
     "@types/enzyme-adapter-react-16": "1.0.6",
     "@types/enzyme-to-json": "1.5.3",
+    "@types/follow-redirects": "1.8.0",
     "@types/fs-extra": "8.1.0",
     "@types/jest": "24.0.17",
     "@types/mime": "2.0.1",

diff --git a/src/back/ConfigFile.ts b/src/back/ConfigFile.ts
@@ -1,7 +1,7 @@
-import * as fs from 'fs';
 import { IAppConfigData } from '@shared/config/interfaces';
-import { deepCopy, readJsonFile, stringifyJsonDataFile, readJsonFileSync } from '@shared/Util';
 import { getDefaultConfigData, overwriteConfigData } from '@shared/config/util';
+import { deepCopy, readJsonFile, readJsonFileSync, stringifyJsonDataFile } from '@shared/Util';
+import * as fs from 'fs';
 
 export namespace ConfigFile {
   export function readFile(filePath: string, onError?: (error: string) => void): Promise<IAppConfigData> {
@@ -17,8 +17,8 @@ export namespace ConfigFile {
   }
 
   export async function readOrCreateFile(filePath: string, onError?: (error: string) => void): Promise<IAppConfigData> {
-    let error: Error | undefined,
-      data: IAppConfigData | undefined;
+    let error: Error | undefined;
+    let data: IAppConfigData | undefined;
 
     try {
       data = await readFile(filePath, onError);
@@ -35,8 +35,8 @@ export namespace ConfigFile {
   }
 
   export function readOrCreateFileSync(filePath: string, onError?: (error: string) => void): IAppConfigData {
-    let error: Error | undefined,
-      data: IAppConfigData | undefined;
+    let error: Error | undefined;
+    let data: IAppConfigData | undefined;
 
     try {
       data = readFileSync(filePath, onError);

diff --git a/src/back/game/GameManager.ts b/src/back/game/GameManager.ts
@@ -51,8 +51,7 @@ export namespace GameManager {
   export async function findGameRow(gameId: string, filterOpts?: FilterGameOpts, orderBy?: GameOrderBy, direction?: GameOrderReverse, index?: PageTuple): Promise<number> {
     if (orderBy) { validateSqlName(orderBy); }
 
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    const startTime = Date.now();
+    // const startTime = Date.now();
     const gameRepository = getManager().getRepository(Game);
 
     const subQ = gameRepository.createQueryBuilder('game')
@@ -92,7 +91,7 @@ export namespace GameManager {
   }
 
   export async function findGamePageKeyset(filterOpts: FilterGameOpts, orderBy: GameOrderBy, direction: GameOrderReverse): Promise<GetPageKeysetResult> {
-    let startTime = Date.now();
+    // let startTime = Date.now();
 
     validateSqlName(orderBy);
     validateSqlOrder(direction);
@@ -119,8 +118,7 @@ export namespace GameManager {
 
     // Count games
     let total = -1;
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    startTime = Date.now();
+    // startTime = Date.now();
     query = await getGameQuery('sub', filterOpts, orderBy, direction, 0, undefined, undefined);
 
     query.skip(0);
@@ -158,8 +156,7 @@ export namespace GameManager {
 
     let query: SelectQueryBuilder<Game> | undefined;
     for (let i = 0; i < ranges.length; i++) {
-      // eslint-disable-next-line @typescript-eslint/no-unused-vars
-      const startTime = Date.now();
+      // const startTime = Date.now();
 
       const range = ranges[i];
       query = await getGameQuery('game', opts.filter, opts.orderBy, opts.direction, range.start, range.length, range.index);

diff --git a/src/back/importGame.ts b/src/back/importGame.ts
@@ -52,8 +52,6 @@ export async function importCuration(opts: ImportCurationOpts): Promise<void> {
     imageFolderPath: imagePath,
   } = opts;
 
-  const logMsg = logMessage;
-
   // TODO: Consider moving this check outside importCuration
   // Warn if launch command is already present on another game
   if (curation.meta.launchCommand) {
@@ -105,17 +103,17 @@ export async function importCuration(opts: ImportCurationOpts): Promise<void> {
   const moveFiles = !saveCuration;
   curationLog(log, 'Importing Curation Meta');
   // Copy/extract content and image files
-  GameManager.updateGame(game).then(() => logMsg('Meta Added', curation));
+  GameManager.updateGame(game).then(() => logMessage('Meta Added', curation));
 
   // Copy Thumbnail
   curationLog(log, 'Importing Curation Thumbnail');
   await importGameImage(curation.thumbnail, game.id, LOGOS, path.join(fpPath, imagePath), log)
-  .then(() => { if (log) { logMsg('Thumbnail Copied', curation); } });
+  .then(() => { if (log) { logMessage('Thumbnail Copied', curation); } });
 
   // Copy Screenshot
   curationLog(log, 'Importing Curation Screenshot');
   await importGameImage(curation.screenshot, game.id, SCREENSHOTS, path.join(fpPath, imagePath), log)
-  .then(() => { if (log) { logMsg('Screenshot Copied', curation); } });
+  .then(() => { if (log) { logMessage('Screenshot Copied', curation); } });
 
   // Copy content and Extra files
   curationLog(log, 'Importing Curation Content');
@@ -142,7 +140,7 @@ export async function importCuration(opts: ImportCurationOpts): Promise<void> {
         await copyFolder(getCurationFolder(curation, fpPath), backupPath, true, opts.openDialog, log);
       }
       if (log) {
-        logMsg('Content Copied', curation);
+        logMessage('Content Copied', curation);
       }
     } catch (error) {
       curationLog(log, `Error importing ${curation.meta.title} - Informing user...`);

diff --git a/src/back/responses.ts b/src/back/responses.ts
@@ -380,8 +380,7 @@ export function registerRequestCallbacks(state: BackState): void {
               }
             }
             newPlaylist.games = existingPlaylist.games;
-            break;
-          }
+          } break;
           case 1: {
             const newPlaylistId = uuid();
             newPlaylist.id = newPlaylistId;
@@ -391,8 +390,7 @@ export function registerRequestCallbacks(state: BackState): void {
               g.playlistId = newPlaylistId;
               return g;
             });
-            break;
-          }
+          } break;
           default:
             throw 'User Cancelled';
         }

diff --git a/src/back/util/uuid.ts b/src/back/util/uuid.ts
@@ -1,19 +1,19 @@
 import { randomBytes } from 'crypto';
-
-// Work around synchronously seeding of random buffer in the v1
-// version of uuid by explicitly only requiring v4. As far as I'm
-// aware we cannot use an import statement here without causing webpack
-// to load the v1 version as well.
-//
-// See
-//  https://github.com/kelektiv/node-uuid/issues/189
-const guid = require('uuid/v4') as (options?: { random?: Buffer }) => string;
+import * as guid from 'uuid/v4';
 
 /**
  * Wrapper function over uuid's v4 method that attempts to source
  * entropy using the window Crypto instance rather than through
  * Node.JS.
  */
 export function uuid() {
-  return guid({ random: randomBytes(16) });
+  return guid({ random: bufferToNumbers(randomBytes(16)) });
+}
+
+function bufferToNumbers(buffer: Buffer): number[] {
+  const array: number[] = [];
+  for (let i = 0; i < buffer.length; i++) {
+    array[i] = buffer[i];
+  }
+  return array;
 }
diff --git a/src/renderer/app.tsx b/src/renderer/app.tsx
@@ -363,7 +363,7 @@ export class App extends React.Component<AppProps, AppState> {
         case BackOut.TAG_CATEGORIES_CHANGE: {
           const resData: TagCategoriesChangeData = res.data;
           this.props.setTagCategories(resData);
-        }
+        } break;
       }
     });
 

diff --git a/src/renderer/components/CurateBoxAddApp.tsx b/src/renderer/components/CurateBoxAddApp.tsx
@@ -79,7 +79,7 @@ export function CurateBoxAddApp(props: CurateBoxAddAppProps) {
           disabled={disabled}
           onKeyDown={props.onInputKeyDown} />
       </CurateBoxRow>
-      {specialType ? undefined :
+      { specialType ? undefined : (
         <CurateBoxRow title={strings.browse.applicationPath + ':'}>
           <InputField
             text={props.curation && props.curation.meta.applicationPath || ''}
@@ -89,7 +89,7 @@ export function CurateBoxAddApp(props: CurateBoxAddAppProps) {
             disabled={disabled}
             onKeyDown={props.onInputKeyDown} />
         </CurateBoxRow>
-      }
+      ) }
       <CurateBoxRow title={lcString + ':'}>
         <InputField
           text={props.curation && props.curation.meta.launchCommand || ''}

diff --git a/src/renderer/components/DropdownInputField.tsx b/src/renderer/components/DropdownInputField.tsx
@@ -157,8 +157,9 @@ export class DropdownInputField extends React.Component<DropdownInputFieldProps,
       if (key === 'ArrowUp' || key === 'ArrowDown') {
         const element = document.activeElement;
         if (element && checkIfAncestor(element, this.contentRef.current)) {
-          const next: any = (key === 'ArrowUp') ? element.previousSibling :
-            element.nextElementSibling;
+          const next: any = (key === 'ArrowUp')
+            ? element.previousSibling
+            : element.nextElementSibling;
           if (next && next.focus) {
             next.focus();
             event.preventDefault();

diff --git a/src/renderer/components/GameGrid.tsx b/src/renderer/components/GameGrid.tsx
@@ -167,8 +167,7 @@ export class GameGrid extends React.Component<GameGridProps> {
                       // (If any property is changed the grid is re-rendered, even these)
                       pass_orderBy={this.props.orderBy}
                       pass_orderReverse={this.props.orderReverse}
-                      pass_currentGamesCount={this.currentGamesCount}
-                    />
+                      pass_currentGamesCount={this.currentGamesCount} />
                   );
                 }}
               </ArrowKeyStepper>

diff --git a/src/renderer/components/GameImageSplit.tsx b/src/renderer/components/GameImageSplit.tsx
@@ -82,11 +82,11 @@ export class GameImageSplit extends React.Component<GameImageSplitProps, GameIma
               onConfirm={this.onRemoveClick}
               render={renderDeleteImageButton}
               extra={[strings, text, !!disabled]} />
-            { showPreview ?
+            { showPreview ? (
               <ImagePreview
                 src={this.props.imgSrc}
                 onCancel={this.onPreviewCancel} />
-              : undefined }
+            ) : undefined }
           </div>
         ) }
       </div>

diff --git a/src/renderer/components/GameItemContainer.tsx b/src/renderer/components/GameItemContainer.tsx
@@ -33,7 +33,7 @@ export class GameItemContainer extends React.Component<GameItemContainerProps> {
         onDoubleClick={this.onDoubleClick}
         onContextMenu={this.onContextMenu}
         onDragStart={this.onDragStart}
-        onDragEnd={this.onDragEnd} >
+        onDragEnd={this.onDragEnd}>
         {this.props.children}
       </div>
     );

diff --git a/src/renderer/components/GameList.tsx b/src/renderer/components/GameList.tsx
@@ -136,8 +136,7 @@ export class GameList extends React.Component<GameListProps> {
                       // (If any property is changed the list is re-rendered, even these)
                       pass_orderBy={this.props.orderBy}
                       pass_orderReverse={this.props.orderReverse}
-                      pass_gamesChanged={gamesChanged}
-                    />
+                      pass_gamesChanged={gamesChanged} />
                   )}
                 </ArrowKeyStepper>
               );

diff --git a/src/renderer/components/OpenIcon.tsx b/src/renderer/components/OpenIcon.tsx
@@ -33,7 +33,7 @@ export function OpenIcon (props: IconProps) {
 
 /** An icon from the "Open Iconic" collection. */
 export type OpenIconType = (
-  'account-login'
+  | 'account-login'
   | 'account-logout'
   | 'action-redo'
   | 'action-undo'

diff --git a/src/renderer/components/ProgressComponents.tsx b/src/renderer/components/ProgressComponents.tsx
@@ -35,11 +35,11 @@ export function StatusBar(props: ProgressComponentProps) {
   return (
     <div className={(props.wrapperClass ? ' ' + props.wrapperClass : '') + 'progress-component__wrapper'}>
       <div className='status-bar__top-text'>{props.progressData.text}</div>
-      { props.progressData.secondaryText ?
+      { props.progressData.secondaryText ? (
         <div className='status-bar__bottom-text'>
           {props.progressData.secondaryText}
         </div>
-        : undefined }
+      ) : undefined }
     </div>
   );
 }
@@ -57,11 +57,11 @@ export function ProgressBar(props: ProgressComponentProps) {
       <div className='progress-bar__bar'>
         <div className='progress-bar__bar__inner' style={barCssProps} />
       </div>
-      { props.progressData.text ?
+      { props.progressData.text ? (
         <div className='progress-bar__bottom-text'>
           {props.progressData.text}
         </div>
-        : undefined }
+      ) : undefined }
     </div>
   );
 }
diff --git a/src/renderer/components/ResizableSidebar.tsx b/src/renderer/components/ResizableSidebar.tsx
@@ -80,9 +80,9 @@ export class ResizableSidebar extends React.Component<ResizableSidebarProps, Res
 
   renderDivider() {
     return (
-      <div className='game-browser__sidebar__divider'
-        onMouseDown={this.onDividerMouseDown}>
-      </div>
+      <div
+        className='game-browser__sidebar__divider'
+        onMouseDown={this.onDividerMouseDown} />
     );
   }
 

diff --git a/src/renderer/components/SplashScreen.tsx b/src/renderer/components/SplashScreen.tsx
@@ -11,6 +11,7 @@ export function SplashScreen(props: SplashScreenProps) {
   const extraClass = (upgradesLoaded && creditsLoaded && miscLoaded)
     ? ' splash-screen--fade-out'
     : '';
+
   return (
     <div className={'splash-screen' + extraClass}>
       <div className='splash-screen__logo fp-logo-box'>
@@ -20,21 +21,21 @@ export function SplashScreen(props: SplashScreenProps) {
         <div className='splash-screen__status-header'>
           Loading
         </div>
-        {!upgradesLoaded ?
+        { !upgradesLoaded ? (
           <div className='splash-screen__status'>
             Upgrades
           </div>
-          : undefined }
-        {!creditsLoaded ?
+        ) : undefined }
+        { !creditsLoaded ? (
           <div className='splash-screen__status'>
             Credits
           </div>
-          : undefined }
-        {!miscLoaded ?
+        ) : undefined }
+        { !miscLoaded ? (
           <div className='splash-screen__status'>
             Misc
           </div>
-          : undefined }
+        ) : undefined }
       </div>
     </div>
   );

diff --git a/src/renderer/components/TagAliasInputField.tsx b/src/renderer/components/TagAliasInputField.tsx
@@ -75,7 +75,7 @@ export class TagAliasInputField extends React.Component<TagAliasInputFieldProps,
     return (
       <div
         className={'input-dropdown' + (this.props.disabled ? ' input-dropdown--disabled' : '')}
-        ref={this.rootRef} >
+        ref={this.rootRef}>
         { editable ? inputField : undefined }
         <div
           className={'tag-input-dropdown__content'}
@@ -112,7 +112,7 @@ export class TagAliasInputField extends React.Component<TagAliasInputFieldProps,
               <p className={'tag-primary__right'} >
                 Primary
               </p>
-            ): undefined }
+            ) : undefined }
             { this.props.editable && tagAlias.id != this.props.primaryAliasId ? (
               <div className='tag-alias__buttons'>
                 <div