Update eslint spacing rules (#366)

* Add space-infix-ops rule * Add no-multi-spaces --------- Co-authored-by: Darius Jahandarie <[email protected]>
yomidevs · Dec 17, 2023 · b249627 · b249627
1 parent decbc60
commit b249627
Show file tree

Hide file tree

Showing 58 changed files with 163 additions and 102 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -192,6 +192,7 @@
             }
         ],
         "no-implicit-globals": "error",
+        "no-multi-spaces": "error",
         "no-trailing-spaces": "error",
         "no-whitespace-before-property": "error",
         "object-curly-spacing": [
@@ -221,6 +222,12 @@
             "error",
             "never"
         ],
+        "space-infix-ops": [
+            "error",
+            {
+                "int32Hint": false
+            }
+        ],
         "space-unary-ops": "error",
         "spaced-comment": [
             "error",
@@ -515,7 +522,10 @@
             "files": [
                 "*.json"
             ],
-            "parser": "jsonc-eslint-parser"
+            "parser": "jsonc-eslint-parser",
+            "rules": {
+                "no-multi-spaces": "off"
+            }
         },
         {
             "files": [

diff --git a/dev/util.js b/dev/util.js
@@ -74,7 +74,7 @@ export function getArgs(args, argMap) {
  * @param {?(fileName: string) => boolean} predicate
  * @returns {string[]}
  */
-export function getAllFiles(baseDirectory, predicate=null) {
+export function getAllFiles(baseDirectory, predicate = null) {
     const results = [];
     const directories = [baseDirectory];
     while (directories.length > 0) {

diff --git a/ext/js/app/frontend.js b/ext/js/app/frontend.js
@@ -41,9 +41,9 @@ export class Frontend {
         parentPopupId,
         parentFrameId,
         useProxyPopup,
-        canUseWindowPopup=true,
+        canUseWindowPopup = true,
         allowRootFramePopupProxy,
-        childrenSupported=true,
+        childrenSupported = true,
         hotkeyHandler
     }) {
         /** @type {import('frontend').PageType} */
@@ -106,6 +106,7 @@ export class Frontend {
         /** @type {?import('settings').OptionsContext} */
         this._optionsContextOverride = null;
 
+        /* eslint-disable no-multi-spaces */
         /** @type {import('core').MessageHandlerMap} */
         this._runtimeMessageHandlers = new Map(/** @type {import('core').MessageHandlerArray} */ ([
             ['Frontend.requestReadyBroadcast',   {async: false, handler: this._onMessageRequestFrontendReadyBroadcast.bind(this)}],
@@ -117,6 +118,7 @@ export class Frontend {
             ['scanSelectedText', this._onActionScanSelectedText.bind(this)],
             ['scanTextAtCaret',  this._onActionScanTextAtCaret.bind(this)]
         ]);
+        /* eslint-enable no-multi-spaces */
     }
 
     /**
@@ -174,13 +176,15 @@ export class Frontend {
         this._textScanner.on('clear', this._onTextScannerClear.bind(this));
         this._textScanner.on('searched', this._onSearched.bind(this));
 
+        /* eslint-disable no-multi-spaces */
         yomitan.crossFrame.registerHandlers([
             ['Frontend.closePopup',       {async: false, handler: this._onApiClosePopup.bind(this)}],
             ['Frontend.copySelection',    {async: false, handler: this._onApiCopySelection.bind(this)}],
             ['Frontend.getSelectionText', {async: false, handler: this._onApiGetSelectionText.bind(this)}],
             ['Frontend.getPopupInfo',     {async: false, handler: this._onApiGetPopupInfo.bind(this)}],
             ['Frontend.getPageInfo',      {async: false, handler: this._onApiGetPageInfo.bind(this)}]
         ]);
+        /* eslint-enable no-multi-spaces */
 
         this._prepareSiteSpecific();
         this._updateContentScale();

diff --git a/ext/js/app/popup-factory.js b/ext/js/app/popup-factory.js
@@ -47,6 +47,7 @@ export class PopupFactory {
      */
     prepare() {
         this._frameOffsetForwarder.prepare();
+        /* eslint-disable no-multi-spaces */
         yomitan.crossFrame.registerHandlers([
             ['PopupFactory.getOrCreatePopup',     {async: true,  handler: this._onApiGetOrCreatePopup.bind(this)}],
             ['PopupFactory.setOptionsContext',    {async: true,  handler: this._onApiSetOptionsContext.bind(this)}],
@@ -64,6 +65,7 @@ export class PopupFactory {
             ['PopupFactory.getFrameSize',         {async: true,  handler: this._onApiGetFrameSize.bind(this)}],
             ['PopupFactory.setFrameSize',         {async: true,  handler: this._onApiSetFrameSize.bind(this)}]
         ]);
+        /* eslint-enable no-multi-spaces */
     }
 
     /**
@@ -72,12 +74,12 @@ export class PopupFactory {
      * @returns {Promise<import('popup').PopupAny>}
      */
     async getOrCreatePopup({
-        frameId=null,
-        id=null,
-        parentPopupId=null,
-        depth=null,
-        popupWindow=false,
-        childrenSupported=false
+        frameId = null,
+        id = null,
+        parentPopupId = null,
+        depth = null,
+        popupWindow = false,
+        childrenSupported = false
     }) {
         // Find by existing id
         if (id !== null) {

diff --git a/ext/js/app/popup.js b/ext/js/app/popup.js
@@ -718,7 +718,7 @@ export class Popup extends EventDispatcher {
      * @param {string} action
      * @param {import('core').SerializableObject} params
      */
-    _invokeWindow(action, params={}) {
+    _invokeWindow(action, params = {}) {
         const contentWindow = this._frame.contentWindow;
         if (this._frameClient === null || !this._frameClient.isConnected() || contentWindow === null) { return; }
 

diff --git a/ext/js/background/backend.js b/ext/js/background/backend.js
@@ -147,6 +147,7 @@ export class Backend {
         /** @type {PermissionsUtil} */
         this._permissionsUtil = new PermissionsUtil();
 
+        /* eslint-disable no-multi-spaces */
         /** @type {import('backend').MessageHandlerMap} */
         this._messageHandlers = new Map(/** @type {import('backend').MessageHandlerMapInit} */ ([
             ['requestBackendReadySignal',    {async: false, contentScript: true,  handler: this._onApiRequestBackendReadySignal.bind(this)}],
@@ -193,6 +194,7 @@ export class Backend {
             ['loadExtensionScripts',         {async: true,  contentScript: true,  handler: this._onApiLoadExtensionScripts.bind(this)}],
             ['openCrossFramePort',           {async: false, contentScript: true,  handler: this._onApiOpenCrossFramePort.bind(this)}]
         ]));
+        /* eslint-enable no-multi-spaces */
         /** @type {import('backend').MessageHandlerWithProgressMap} */
         this._messageHandlersWithProgress = new Map(/** @type {import('backend').MessageHandlerWithProgressMapInit} */ ([
             // Empty
@@ -201,10 +203,10 @@ export class Backend {
         /** @type {Map<string, (params?: import('core').SerializableObject) => void>} */
         this._commandHandlers = new Map(/** @type {[name: string, handler: (params?: import('core').SerializableObject) => void][]} */ ([
             ['toggleTextScanning', this._onCommandToggleTextScanning.bind(this)],
-            ['openInfoPage',       this._onCommandOpenInfoPage.bind(this)],
-            ['openSettingsPage',   this._onCommandOpenSettingsPage.bind(this)],
-            ['openSearchPage',     this._onCommandOpenSearchPage.bind(this)],
-            ['openPopupWindow',    this._onCommandOpenPopupWindow.bind(this)]
+            ['openInfoPage', this._onCommandOpenInfoPage.bind(this)],
+            ['openSettingsPage', this._onCommandOpenSettingsPage.bind(this)],
+            ['openSearchPage', this._onCommandOpenSearchPage.bind(this)],
+            ['openPopupWindow', this._onCommandOpenPopupWindow.bind(this)]
         ]));
     }
 
@@ -805,7 +807,7 @@ export class Backend {
     }
 
     /** @type {import('api').Handler<import('api').GetOrCreateSearchPopupDetails, import('api').GetOrCreateSearchPopupResult>} */
-    async _onApiGetOrCreateSearchPopup({focus=false, text}) {
+    async _onApiGetOrCreateSearchPopup({focus = false, text}) {
         const {tab, created} = await this._getOrCreateSearchPopup();
         if (focus === true || (focus === 'ifCreated' && created)) {
             await this._focusTab(tab);
@@ -1979,7 +1981,7 @@ export class Backend {
      * @param {?number} [timeout=null]
      * @returns {Promise<void>}
      */
-    _waitUntilTabFrameIsReady(tabId, frameId, timeout=null) {
+    _waitUntilTabFrameIsReady(tabId, frameId, timeout = null) {
         return new Promise((resolve, reject) => {
             /** @type {?import('core').Timeout} */
             let timer = null;

diff --git a/ext/js/background/offscreen.js b/ext/js/background/offscreen.js
@@ -50,6 +50,7 @@ export class Offscreen {
             richContentPasteTargetSelector: '#clipboard-rich-content-paste-target'
         });
 
+        /* eslint-disable no-multi-spaces */
         /** @type {import('offscreen').MessageHandlerMap} */
         const messageHandlers = new Map([
             ['clipboardGetTextOffscreen',    {async: true,  handler: this._getTextHandler.bind(this)}],
@@ -65,6 +66,7 @@ export class Offscreen {
             ['getTermFrequenciesOffscreen',  {async: true,  handler: this._getTermFrequenciesHandler.bind(this)}],
             ['clearDatabaseCachesOffscreen', {async: false, handler: this._clearDatabaseCachesHandler.bind(this)}]
         ]);
+        /* eslint-enable no-multi-spaces */
         /** @type {import('offscreen').MessageHandlerMap<string>} */
         this._messageHandlers = messageHandlers;
 

diff --git a/ext/js/background/profile-conditions-util.js b/ext/js/background/profile-conditions-util.js
@@ -34,11 +34,11 @@ export class ProfileConditionsUtil {
                 'popupLevel',
                 {
                     operators: new Map(/** @type {import('profile-conditions-util').OperatorMapArray} */ ([
-                        ['equal',              this._createSchemaPopupLevelEqual.bind(this)],
-                        ['notEqual',           this._createSchemaPopupLevelNotEqual.bind(this)],
-                        ['lessThan',           this._createSchemaPopupLevelLessThan.bind(this)],
-                        ['greaterThan',        this._createSchemaPopupLevelGreaterThan.bind(this)],
-                        ['lessThanOrEqual',    this._createSchemaPopupLevelLessThanOrEqual.bind(this)],
+                        ['equal', this._createSchemaPopupLevelEqual.bind(this)],
+                        ['notEqual', this._createSchemaPopupLevelNotEqual.bind(this)],
+                        ['lessThan', this._createSchemaPopupLevelLessThan.bind(this)],
+                        ['greaterThan', this._createSchemaPopupLevelGreaterThan.bind(this)],
+                        ['lessThanOrEqual', this._createSchemaPopupLevelLessThanOrEqual.bind(this)],
                         ['greaterThanOrEqual', this._createSchemaPopupLevelGreaterThanOrEqual.bind(this)]
                     ]))
                 }

diff --git a/ext/js/comm/anki-connect.js b/ext/js/comm/anki-connect.js
@@ -318,7 +318,7 @@ export class AnkiConnect {
      * @param {?string[]} actions A list of actions to check for
      * @returns {Promise<import('anki').ApiReflectResult>} Information about the APIs.
      */
-    async apiReflect(scopes, actions=null) {
+    async apiReflect(scopes, actions = null) {
         const result = await this._invoke('apiReflect', {scopes, actions});
         if (!(typeof result === 'object' && result !== null)) {
             throw this._createUnexpectedResultError('object', result);

diff --git a/ext/js/comm/api.js b/ext/js/comm/api.js
@@ -482,7 +482,7 @@ export class API {
      * @param {number} [timeout]
      * @returns {Promise<TReturn>}
      */
-    _invokeWithProgress(action, params, onProgress0, timeout=5000) {
+    _invokeWithProgress(action, params, onProgress0, timeout = 5000) {
         return new Promise((resolve, reject) => {
             /** @type {?chrome.runtime.Port} */
             let port = null;
@@ -554,7 +554,7 @@ export class API {
      * @param {import('core').SerializableObject} [params]
      * @returns {Promise<TReturn>}
      */
-    _invoke(action, params={}) {
+    _invoke(action, params = {}) {
         const data = {action, params};
         return new Promise((resolve, reject) => {
             try {

diff --git a/ext/js/comm/clipboard-reader.js b/ext/js/comm/clipboard-reader.js
@@ -26,7 +26,7 @@ export class ClipboardReader {
      * Creates a new instances of a clipboard reader.
      * @param {{document: ?Document, pasteTargetSelector: ?string, richContentPasteTargetSelector: ?string}} details Details about how to set up the instance.
      */
-    constructor({document=null, pasteTargetSelector=null, richContentPasteTargetSelector=null}) {
+    constructor({document = null, pasteTargetSelector = null, richContentPasteTargetSelector = null}) {
         /** @type {?Document} */
         this._document = document;
         /** @type {?import('environment').Browser} */

diff --git a/ext/js/comm/frame-ancestry-handler.js b/ext/js/comm/frame-ancestry-handler.js
@@ -109,7 +109,7 @@ export class FrameAncestryHandler {
      * @param {number} [timeout]
      * @returns {Promise<number[]>}
      */
-    _getFrameAncestryInfo(timeout=5000) {
+    _getFrameAncestryInfo(timeout = 5000) {
         return new Promise((resolve, reject) => {
             const targetWindow = window.parent;
             if (window === targetWindow) {

diff --git a/ext/js/comm/frame-client.js b/ext/js/comm/frame-client.js
@@ -41,7 +41,7 @@ export class FrameClient {
      * @param {import('frame-client').SetupFrameFunction} setupFrame
      * @param {number} [timeout]
      */
-    async connect(frame, targetOrigin, hostFrameId, setupFrame, timeout=10000) {
+    async connect(frame, targetOrigin, hostFrameId, setupFrame, timeout = 10000) {
         const {secret, token, frameId} = await this._connectInternal(frame, targetOrigin, hostFrameId, setupFrame, timeout);
         this._secret = secret;
         this._token = token;

diff --git a/ext/js/core.js b/ext/js/core.js
@@ -600,7 +600,7 @@ export class DynamicProperty extends EventDispatcher {
      * @returns {import('core').TokenString} A string token which can be passed to the clearOverride function
      *   to remove the override.
      */
-    setOverride(value, priority=0) {
+    setOverride(value, priority = 0) {
         const overridesCount = this._overrides.length;
         let i = 0;
         for (; i < overridesCount; ++i) {
@@ -670,7 +670,7 @@ export class Logger extends EventDispatcher {
      *   Other values will be logged at a non-error level.
      * @param {?import('log').LogContext} [context] An optional context object for the error which should typically include a `url` field.
      */
-    log(error, level, context=null) {
+    log(error, level, context = null) {
         if (typeof context !== 'object' || context === null) {
             context = {url: location.href};
         }
@@ -745,7 +745,7 @@ export class Logger extends EventDispatcher {
      * @param {unknown} error The error to log. This is typically an `Error` or `Error`-like object.
      * @param {?import('log').LogContext} context An optional context object for the error which should typically include a `url` field.
      */
-    warn(error, context=null) {
+    warn(error, context = null) {
         this.log(error, 'warn', context);
     }
 
@@ -754,7 +754,7 @@ export class Logger extends EventDispatcher {
      * @param {unknown} error The error to log. This is typically an `Error` or `Error`-like object.
      * @param {?import('log').LogContext} context An optional context object for the error which should typically include a `url` field.
      */
-    error(error, context=null) {
+    error(error, context = null) {
         this.log(error, 'error', context);
     }
 }

diff --git a/ext/js/data/anki-note-builder.js b/ext/js/data/anki-note-builder.js
@@ -51,15 +51,15 @@ export class AnkiNoteBuilder {
         deckName,
         modelName,
         fields,
-        tags=[],
-        requirements=[],
-        checkForDuplicates=true,
-        duplicateScope='collection',
-        duplicateScopeCheckAllModels=false,
-        resultOutputMode='split',
-        glossaryLayoutMode='default',
-        compactTags=false,
-        mediaOptions=null
+        tags = [],
+        requirements = [],
+        checkForDuplicates = true,
+        duplicateScope = 'collection',
+        duplicateScopeCheckAllModels = false,
+        resultOutputMode = 'split',
+        glossaryLayoutMode = 'default',
+        compactTags = false,
+        mediaOptions = null
     }) {
         let duplicateScopeDeckName = null;
         let duplicateScopeCheckChildren = false;
@@ -130,9 +130,9 @@ export class AnkiNoteBuilder {
         dictionaryEntry,
         mode,
         context,
-        resultOutputMode='split',
-        glossaryLayoutMode='default',
-        compactTags=false,
+        resultOutputMode = 'split',
+        glossaryLayoutMode = 'default',
+        compactTags = false,
         marker
     }) {
         const commonData = this._createData(dictionaryEntry, mode, context, resultOutputMode, glossaryLayoutMode, compactTags, void 0);

diff --git a/ext/js/data/database.js b/ext/js/data/database.js
@@ -265,7 +265,7 @@ export class Database {
      * @param {?(completedCount: number, totalCount: number) => void} onProgress
      * @returns {Promise<void>}
      */
-    bulkDelete(objectStoreName, indexName, query, filterKeys=null, onProgress=null) {
+    bulkDelete(objectStoreName, indexName, query, filterKeys = null, onProgress = null) {
         return new Promise((resolve, reject) => {
             const transaction = this._readWriteTransaction([objectStoreName], resolve, reject);
             const objectStore = transaction.objectStore(objectStoreName);

diff --git a/ext/js/data/options-util.js b/ext/js/data/options-util.js
@@ -39,7 +39,7 @@ export class OptionsUtil {
      * @param {?number} [targetVersion]
      * @returns {Promise<import('settings').Options>}
      */
-    async update(optionsInput, targetVersion=null) {
+    async update(optionsInput, targetVersion = null) {
         // Invalid options
         let options = /** @type {{[key: string]: unknown}} */ (
             typeof optionsInput === 'object' && optionsInput !== null && !Array.isArray(optionsInput) ?
@@ -530,6 +530,7 @@ export class OptionsUtil {
      * @returns {import('options-util').ModernUpdate[]}
      */
     _getVersionUpdates(targetVersion) {
+        /* eslint-disable no-multi-spaces */
         const result = [
             {async: false, update: this._updateVersion1.bind(this)},
             {async: false, update: this._updateVersion2.bind(this)},
@@ -553,6 +554,7 @@ export class OptionsUtil {
             {async: false, update: this._updateVersion20.bind(this)},
             {async: true,  update: this._updateVersion21.bind(this)}
         ];
+        /* eslint-enable no-multi-spaces */
         if (typeof targetVersion === 'number' && targetVersion < result.length) {
             result.splice(targetVersion);
         }
@@ -818,6 +820,7 @@ export class OptionsUtil {
             };
             delete profile.options.anki.sentenceExt;
             profile.options.general.popupActionBarLocation = 'top';
+            /* eslint-disable no-multi-spaces */
             profile.options.inputs = {
                 hotkeys: [
                     {action: 'close',             key: 'Escape',    modifiers: [],       scopes: ['popup'], enabled: true},
@@ -838,6 +841,7 @@ export class OptionsUtil {
                     {action: 'copyHostSelection', key: 'KeyC',      modifiers: ['ctrl'], scopes: ['popup'], enabled: true}
                 ]
             };
+            /* eslint-enable no-multi-spaces */
             profile.options.anki.suspendNewCards = false;
             profile.options.popupWindow = {
                 width: profile.options.general.popupWidth,