Add eslint-plugin-jsdoc

Author: xPaw

eslint.config.mjs

@@ -2,6 +2,7 @@ import { FlatCompat } from "@eslint/eslintrc";
 import { fileURLToPath } from "node:url";
 import globals from "globals";
 import js from "@eslint/js";
+import jsdoc from 'eslint-plugin-jsdoc';
 import path from "node:path";
 
 const __filename = fileURLToPath( import.meta.url );
@@ -15,6 +16,7 @@ const compat = new FlatCompat( {
 export default[
 	...compat.extends( "eslint:all" ),
 	...compat.extends( "eslint:recommended" ),
+	jsdoc.configs[ 'flat/recommended-typescript-flavor' ],
 	{
 		ignores: [ "node_modules/*" ],
 		languageOptions: {
@@ -37,7 +39,16 @@ export default[
 			sourceType: "commonjs",
 		},
 
+		plugins: {
+			jsdoc,
+		},
+
 		rules: {
+			"jsdoc/require-description": "off",
+			"jsdoc/require-param-description": "off",
+			"jsdoc/require-returns-description": "off",
+			"jsdoc/require-jsdoc": "off",
+			"jsdoc/require-returns": "off",
 			"array-bracket-spacing": [ "error", "always" ],
 			"brace-style": [ "error", "allman" ],
 			"camelcase": "off",

options/options.js

@@ -49,7 +49,7 @@
 	let starDismissed = false;
 	const checkboxes = document.querySelectorAll( '.option-check:not(:disabled)' );
 
-	/** @type {Object.<string, HTMLElement[]>} */
+	/** @type {Record<string, HTMLElement[]>} */
 	const options =
 	{
 		'clicked-star': null,

package-lock.json

@@ -19,6 +19,7 @@
 		"@types/firefox-webext-browser": "^120.0.3",
 		"archiver": "^7.0.1",
 		"eslint": "^9.10.0",
+		"eslint-plugin-jsdoc": "^50.6.3",
 		"prettier": "^3.3.2",
 		"stylelint": "^16.5.0",
 		"stylelint-config-standard": "^37.0.0",

package.json

@@ -359,7 +359,7 @@ function GetApp( appid, callback )
 }
 
 /**
- * @param {Object} obj
+ * @param {object} obj
  * @param {string} obj.appid
  * @param {string} obj.currency
  * @param {(obj: {success: true}|{success: false, error: string}) => void} callback
@@ -580,7 +580,7 @@ function StoreRemoveFreeLicense( request, callback )
 }
 
 /**
-* @param {Record<string, string>} request
+ * @param {Record<string, string>} request
  * @param {(obj: {success: boolean, granted: boolean}) => void} callback
  */
 function StoreRequestPlaytestAccess( request, callback )
@@ -615,6 +615,7 @@ function StoreRequestPlaytestAccess( request, callback )
  * @param {string} path
  * @param {FormData} formData
  * @param {(obj: {success: true}|{success: false, error: string}) => void} callback
+ * @param {boolean} rawCallback
  */
 function ExecuteStoreApiCall( path, formData, callback, rawCallback = false )
 {
@@ -743,15 +744,16 @@ function GetStoreSessionID( callback )
 
 /**
  * @param {{[key: string]: any}} items
- * @return Promise<{[key: string]: any}>
+ * @returns {Promise<{[key: string]: any}>}
  */
 function GetLocalOption( items )
 {
 	return ExtensionApi.storage.local.get( items );
 }
 
 /**
- * @param {String} option
+ * @param {string} option
+ * @param {any} value
  */
 function SetLocalOption( option, value )
 {

scripts/background.js

@@ -24,8 +24,8 @@ var ExtensionApi = ( () =>
 var CurrentAppID;
 
 /**
- * @param {String} url
- * @returns {Number}
+ * @param {string} url
+ * @returns {number}
  */
 function GetAppIDFromUrl( url )
 {
@@ -50,9 +50,9 @@ function GetHomepage()
 }
 
 /**
- * @param {String} message
- * @param {String[]} substitutions
- * @returns {String}
+ * @param {string} message
+ * @param {string[]} substitutions
+ * @returns {string}
  */
 function _t( message, substitutions = [] )
 {
@@ -79,7 +79,8 @@ function GetOption( items, callback )
 }
 
 /**
- * @param {String} option
+ * @param {string} option
+ * @param {any} value
  */
 function SetOption( option, value )
 {
@@ -90,7 +91,7 @@ function SetOption( option, value )
 }
 
 /**
- * @param {String} res
+ * @param {string} res
  */
 function GetLocalResource( res )
 {
@@ -99,7 +100,7 @@ function GetLocalResource( res )
 
 /**
  * @callback SendMessageToBackgroundScriptCallback
- * @param {{success: Boolean, error?: String, data?: any}?} data
+ * @param {{success: boolean, error?: string, data?: any}?} data
  */
 
 /**