From 90b5ff514986915f406d4ce6e1a361a7e35b4521 Mon Sep 17 00:00:00 2001
From: Ed Sanders <esanders@wikimedia.org>
Date: Sun, 17 Oct 2021 14:45:16 +0100
Subject: [PATCH] Define documentable types in eslintrc instead of inline

Change-Id: I80f0557a6355208d2694f3776cce2ee858573a9c
---
 stories/.eslintrc.json                 | 12 ++++++++++++
 stories/LanguageButton.stories.data.js |  3 ---
 stories/Logo.stories.data.js           |  5 -----
 stories/Menu.stories.data.js           |  3 ---
 stories/MenuDropdown.stories.data.js   |  4 ----
 stories/MenuPortal.stories.data.js     |  3 ---
 stories/MenuTabs.stories.data.js       |  4 ----
 stories/SearchBox.stories.data.js      |  4 ----
 stories/UserLinks.stories.data.js      |  4 ----
 stories/skin.stories.data.js           |  4 ----
 stories/utils.js                       |  4 ----
 11 files changed, 12 insertions(+), 38 deletions(-)

diff --git a/stories/.eslintrc.json b/stories/.eslintrc.json
index 024f2b5..846b3a2 100644
--- a/stories/.eslintrc.json
+++ b/stories/.eslintrc.json
@@ -12,5 +12,17 @@
 	},
 	"parserOptions": {
 		"sourceType": "module"
+	},
+	"settings": {
+		"jsdoc": {
+			"preferredTypes": {
+				"Indicator": "Indicator",
+				"LogoOptions": "LogoOptions",
+				"LogoTemplateData": "LogoTemplateData",
+				"MenuDefinition": "MenuDefinition",
+				"SearchData": "SearchData",
+				"UserLinksDefinition": "UserLinksDefinition"
+			}
+		}
 	}
 }
diff --git a/stories/LanguageButton.stories.data.js b/stories/LanguageButton.stories.data.js
index f530da2..9bab058 100644
--- a/stories/LanguageButton.stories.data.js
+++ b/stories/LanguageButton.stories.data.js
@@ -1,6 +1,3 @@
-/**
- * @external MenuDefinition
- */
 import { placeholder, htmlUserLanguageAttributes,
 	makeIcon, portletAfter } from './utils';
 
diff --git a/stories/Logo.stories.data.js b/stories/Logo.stories.data.js
index 77a821f..0ddc430 100644
--- a/stories/Logo.stories.data.js
+++ b/stories/Logo.stories.data.js
@@ -1,8 +1,3 @@
-/**
- * @external LogoOptions
- * @external LogoTemplateData
- */
-
 import logoTemplate from '!!raw-loader!../includes/templates/Logo.mustache';
 import wordmarkSrc from '../.storybook/resolve-imports/assets/wordmark.svg';
 import tagelineScr from '../.storybook/resolve-imports/assets/tagline.svg';
diff --git a/stories/Menu.stories.data.js b/stories/Menu.stories.data.js
index e04455a..847e92d 100644
--- a/stories/Menu.stories.data.js
+++ b/stories/Menu.stories.data.js
@@ -1,6 +1,3 @@
-/**
- * @external MenuDefinition
- */
 import menuTemplate from '!!raw-loader!../includes/templates/Menu.mustache';
 import { helperMakeMenuData } from './utils';
 
diff --git a/stories/MenuDropdown.stories.data.js b/stories/MenuDropdown.stories.data.js
index 35abb73..6c7b5a7 100644
--- a/stories/MenuDropdown.stories.data.js
+++ b/stories/MenuDropdown.stories.data.js
@@ -1,7 +1,3 @@
-/**
- * @external MenuDefinition
- */
-
 import vectorMenuTemplate from '!!raw-loader!../includes/templates/Menu.mustache';
 import { htmlUserLanguageAttributes } from './utils';
 
diff --git a/stories/MenuPortal.stories.data.js b/stories/MenuPortal.stories.data.js
index 614d12f..5e4b67a 100644
--- a/stories/MenuPortal.stories.data.js
+++ b/stories/MenuPortal.stories.data.js
@@ -1,6 +1,3 @@
-/**
- * @external MenuDefinition
- */
 import mustache from 'mustache';
 import { vectorMenuTemplate as portalTemplate } from './MenuDropdown.stories.data';
 import '../resources/skins.vector.styles/MenuPortal.less';
diff --git a/stories/MenuTabs.stories.data.js b/stories/MenuTabs.stories.data.js
index 3b9f02c..ce8f7eb 100644
--- a/stories/MenuTabs.stories.data.js
+++ b/stories/MenuTabs.stories.data.js
@@ -1,7 +1,3 @@
-/**
- * @external MenuDefinition
- */
-
 import { htmlUserLanguageAttributes } from './utils';
 
 /**
diff --git a/stories/SearchBox.stories.data.js b/stories/SearchBox.stories.data.js
index 4aea02d..7359813 100644
--- a/stories/SearchBox.stories.data.js
+++ b/stories/SearchBox.stories.data.js
@@ -1,7 +1,3 @@
-/**
- * @external SearchData
- */
-
 import searchBoxTemplate from '!!raw-loader!../includes/templates/SearchBox.mustache';
 import Button from '!!raw-loader!../includes/templates/Button.mustache';
 import { htmlUserLanguageAttributes } from './utils';
diff --git a/stories/UserLinks.stories.data.js b/stories/UserLinks.stories.data.js
index 6307563..2e12d7f 100644
--- a/stories/UserLinks.stories.data.js
+++ b/stories/UserLinks.stories.data.js
@@ -1,7 +1,3 @@
-/**
- * @external MenuDefinition
- * @external UserLinksDefinition
- */
 import msgs from '../i18n/en.json';
 import mustache from 'mustache';
 import { menuTemplate } from './Menu.stories.data';
diff --git a/stories/skin.stories.data.js b/stories/skin.stories.data.js
index e4eba7c..9a4d177 100644
--- a/stories/skin.stories.data.js
+++ b/stories/skin.stories.data.js
@@ -1,7 +1,3 @@
-/**
- * @external Indicator
- */
-
 import { htmlUserLanguageAttributes } from './utils';
 import { placeholder } from './utils';
 
diff --git a/stories/utils.js b/stories/utils.js
index 37665aa..fba0e32 100644
--- a/stories/utils.js
+++ b/stories/utils.js
@@ -1,7 +1,3 @@
-/**
- * @external MenuDefinition
- */
-
 /**
  * @param {string} name
  * @return {string}