eslint: warn about unused directives

Make ESLint warn when directives
are not used, and remove the unused
directives from the source code.

The no-empty rule needs a comment
rather than an ignore directive
in empty catch blocks, so tweak
the config of the rule to admit
empty catch blocks, and report
on other empty bodies.

.eslintrc.js

@@ -72,6 +72,7 @@ module.exports = {
     "no-alert": ["error"],
     "no-caller": ["error"],
     "no-div-regex": ["error"],
+    "no-empty": ["error", { allowEmptyCatch: true }],
     "no-eval": ["error"],
     "no-extend-native": ["error"],
     "no-fallthrough": 0,

gulpfile.js

@@ -55,7 +55,8 @@ gulp.task("lint", function (done) {
     "--ext",
     ".jsx,.js,.ts,.tsx",
     "--max-warnings",
-    "0"
+    "0",
+    "--report-unused-disable-directives"
   ]);
 
   done();

lib/ModelMixins/DiscretelyTimeVaryingMixin.ts

@@ -115,9 +115,7 @@ function DiscretelyTimeVaryingMixin<
               tag: dt.tag !== undefined ? dt.tag : dt.time
             });
           }
-        } catch {
-          /* eslint-disable-line no-empty */
-        }
+        } catch {}
       }
       asJulian.sort((a, b) => JulianDate.compare(a.time, b.time));
       return asJulian;

lib/Models/Catalog/CatalogItems/CartoMapV3CatalogItem.ts

@@ -289,9 +289,7 @@ async function callCartoApi(url: string, auth?: string, body?: JsonObject) {
             )
           );
         }
-      } catch {
-        /* eslint-disable-line no-empty */
-      }
+      } catch {}
     }
     return Result.error(e);
   }

lib/Models/Catalog/Ows/WebFeatureServiceCatalogItem.ts

@@ -431,9 +431,7 @@ class WebFeatureServiceCatalogItem extends GetCapabilitiesMixin(
       let errorMessage: string | undefined;
       try {
         errorMessage = xml2json(getFeatureResponse).Exception?.ExceptionText;
-      } catch {
-        /* eslint-disable-line no-empty */
-      }
+      } catch {}
 
       const originalError = isDefined(errorMessage)
         ? new TerriaError({

lib/ReactViews/Analytics/InvokeFunction.jsx

@@ -52,12 +52,10 @@ class InvokeFunction extends React.Component {
     t: PropTypes.func.isRequired
   };
 
-  /* eslint-disable-next-line camelcase */
   UNSAFE_componentWillMount() {
     this.parametersViewModel = new FunctionViewModel(this.props.previewed);
   }
 
-  /* eslint-disable-next-line camelcase */
   UNSAFE_componentWillUpdate(nextProps, _nextState) {
     if (nextProps.previewed !== this.parametersViewModel.catalogFunction) {
       // Clear previous parameters view model, because this is a different catalog function.

lib/ReactViews/Analytics/RegionPicker.jsx

@@ -44,7 +44,6 @@ const RegionPicker = createReactClass({
     };
   },
 
-  /* eslint-disable-next-line camelcase */
   UNSAFE_componentWillMount() {
     this._loadingRegionProvider = undefined;
     this._selectedRegionCatalogItem = undefined;

lib/ReactViews/CleanDropdownPanel/CleanDropdownPanel.jsx

@@ -65,7 +65,6 @@ const CleanDropdownPanel = createReactClass({
     }
   },
 
-  /* eslint-disable-next-line camelcase */
   UNSAFE_componentWillReceiveProps(nextProps) {
     if (nextProps.forceClosed) {
       this.onDismissed();

lib/ReactViews/Custom/Chart/ChartExpandAndDownloadButtons.tsx

@@ -74,9 +74,7 @@ class ChartExpandAndDownloadButtons extends React.Component<PropsType> {
 
       try {
         terria.addModel(itemToExpand);
-      } catch {
-        /* eslint-disable-line no-empty */
-      }
+      } catch {}
       (await workbench.add(itemToExpand)).raiseError(terria, undefined, true);
     });
   }

lib/ReactViews/Custom/parseCustomHtmlToReact.ts

@@ -78,7 +78,6 @@ function getProcessingInstructions(context: ParseCustomHtmlToReactContext) {
     shouldProcessNode: (node: DomElement) => node.name === "a",
     processNode: function (node: DomElement, children, index) {
       // Make sure any <a href> tags open in a new window
-      // eslint-disable-line react/display-name
       const elementProps = {
         key: "anchor-" + keyIndex++,
         target: "_blank",

lib/ReactViews/Generic/Dropdown.jsx

@@ -39,7 +39,6 @@ const Dropdown = createReactClass({
     };
   },
 
-  /* eslint-disable-next-line camelcase */
   UNSAFE_componentWillMount() {
     // this._element is updated by the ref callback attribute, https://facebook.github.io/react/docs/more-about-refs.html
     this.buttonElement = undefined;

lib/ReactViews/Generic/Editor.jsx

@@ -1,4 +1,3 @@
-/* eslint-disable camelcase */
 import React, { useRef } from "react";
 import { Editor } from "@tinymce/tinymce-react";
 import PropTypes from "prop-types";

lib/ReactViews/HOCs/withControlledVisibility.tsx

@@ -13,7 +13,6 @@ interface WithControlledVisibilityProps {
  * as prop
  */
 export default <P extends object>(WrappedComponent: React.ComponentType<P>) => {
-  // eslint-disable-next-line require-jsdoc
   function WithControlledVisibility({
     elementConfig,
     ...props

lib/ReactViews/Map/Panels/DropdownPanel.jsx

@@ -65,7 +65,6 @@ const DropdownPanel = createReactClass({
     }
   },
 
-  /* eslint-disable-next-line camelcase */
   UNSAFE_componentWillReceiveProps(nextProps) {
     if (nextProps.forceClosed) {
       this.onDismissed();
@@ -99,7 +98,6 @@ const DropdownPanel = createReactClass({
           ref={
             this.props.btnRef || ((element) => (this.buttonElement = element))
           }
-          /* eslint-disable-next-line react/no-unknown-property */
           isOpen={this.isOpen()}
           css={`
             ${(p) =>

lib/ReactViews/Map/Panels/InnerPanel.jsx

@@ -139,7 +139,6 @@ const InnerPanel = createReactClass({
           onClick={this.forceClose}
           title={t("general.close")}
           aria-label={t("general.close")}
-          /* eslint-disable-next-line react/no-unknown-property */
           showDropdownAsModal={this.props.showDropdownAsModal}
           css={`
             svg {

lib/ReactViews/Map/Panels/SharePanel/StorySharePanel.jsx

@@ -37,7 +37,6 @@ const StorySharePanel = createReactClass({
     }
   },
 
-  /* eslint-disable-next-line camelcase */
   UNSAFE_componentWillReceiveProps(nextProps) {
     if (nextProps.forceClosed) {
       this.onDismissed();

lib/ReactViews/Map/TerriaViewerWrapper/Splitter/dragHook.ts

@@ -23,9 +23,7 @@ try {
 
   window.addEventListener("test", callback, options);
   window.removeEventListener("test", callback, options);
-} catch (_err) {
-  /* eslint-disable-line no-empty */
-}
+} catch (_err) {}
 
 const notPassive = passiveSupported ? { passive: false } : false;
 

lib/ReactViews/Mobile/MobileModalWindow.jsx

@@ -78,7 +78,6 @@ class MobileModalWindow extends React.Component {
     });
   }
 
-  /* eslint-disable-next-line camelcase */
   UNSAFE_componentWillReceiveProps() {
     const numItems = this.props.terria.workbench.items.length;
     if (

lib/ReactViews/Notification/NotificationWindow.jsx

@@ -71,7 +71,6 @@ const NotificationWindow = createReactClass({
       <div className={classNames(Styles.wrapper, `${type}`)}>
         <div
           className={Styles.notification}
-          /* eslint-disable-next-line react/no-unknown-property */
           isStory={isStory}
           css={`
             background: ${(p) =>

lib/ReactViews/Search/SearchBox.jsx

@@ -61,7 +61,6 @@ export const SearchBox = createReactClass({
     };
   },
 
-  /* eslint-disable-next-line camelcase */
   UNSAFE_componentWillMount() {
     this.searchWithDebounce = debounce(this.search, DEBOUNCE_INTERVAL);
   },

lib/ReactViews/StandardUserInterface/customizable/ResponsiveSwitch.jsx

@@ -7,7 +7,6 @@ import PropTypes from "prop-types";
  * passed to it is true or false.
  */
 export default (LargeScreenComponent, SmallScreenComponent) => {
-  // eslint-disable-next-line require-jsdoc
   function ResponsiveSwitch(props) {
     return props.smallScreen ? (
       <SmallScreenComponent {...props} />

lib/ReactViews/Story/StoryEditor.jsx

@@ -33,7 +33,6 @@ class StoryEditor extends React.Component {
     this.escKeyListener = null;
   }
 
-  /* eslint-disable-next-line camelcase */
   UNSAFE_componentWillMount() {
     const story = this.props.story;
     this.setState({

lib/ReactViews/Tools/DiffTool/DiffTool.tsx

@@ -100,9 +100,7 @@ class DiffTool extends React.Component<PropsType> {
         this.leftItem = leftItem;
         this.rightItem = rightItem;
       });
-    } catch {
-      /* eslint-disable-line no-empty */
-    }
+    } catch {}
   }
 
   @action

lib/ReactViews/Workbench/Controls/ColorScaleRangeSection.jsx

@@ -23,14 +23,13 @@ const ColorScaleRangeSection = createReactClass({
     };
   },
 
-  /* eslint-disable-next-line camelcase */
   UNSAFE_componentWillMount() {
     this.setState({
       minRange: this.props.minValue,
       maxRange: this.props.maxValue
     });
   },
-  /* eslint-disable-next-line camelcase */
+
   UNSAFE_componentWillReceiveProps(nextProps) {
     this.setState({
       minRange: nextProps.minValue,

lib/ReactViews/Workbench/Controls/ViewingControls.tsx

@@ -110,7 +110,6 @@ class ViewingControls extends React.Component<
     };
   }
 
-  /* eslint-disable-next-line camelcase */
   UNSAFE_componentWillMount() {
     window.addEventListener("click", this.hideMenu.bind(this));
   }