chore: enforce some jsdoc rules

nwutils · Aug 24, 2024 · 37e9df3 · 37e9df3
1 parent 14d5d7d
commit 37e9df3
Show file tree

Hide file tree

Showing 11 changed files with 178 additions and 53 deletions.
diff --git a/eslint.config.js b/eslint.config.js
@@ -1,6 +1,6 @@
+import js from "@eslint/js";
+import jsdoc from 'eslint-plugin-jsdoc';
 import globals from "globals";
-import pluginJs from "@eslint/js";
-
 
 export default [
   {
@@ -9,7 +9,8 @@ export default [
       globals: globals.node
     }
   },
-  pluginJs.configs.recommended,
+  js.configs.recommended,
+  jsdoc.configs['flat/recommended'],
   {
     rules: {
       "semi": ["error", "always"],

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -54,6 +54,7 @@
     "@vitest/coverage-v8": "^2.0.5",
     "base-volta-off-of-nwjs": "^1.0.5",
     "eslint": "^9.9.1",
+    "eslint-plugin-jsdoc": "^50.2.2",
     "globals": "^15.9.0",
     "nw": "^0.91.0",
     "selenium-webdriver": "^4.23.0",

diff --git a/src/bld/osx.js b/src/bld/osx.js
@@ -5,6 +5,14 @@ import process from 'node:process';
 
 import plist from 'plist';
 
+/**
+ *
+ * @param {object} options              - Options.
+ * @param {object} options.app          - Application configuration.
+ * @param {string} options.outDir       - Output directory.
+ * @param {string} options.releaseInfo  - Release information.
+ * @returns {Promise<void>}             - Promise.
+ */
 export default async function setOsxConfig({ app, outDir, releaseInfo }) {
   if (process.platform === 'win32') {
     console.warn(
@@ -22,14 +30,12 @@ export default async function setOsxConfig({ app, outDir, releaseInfo }) {
     }
     /**
      * Path to MacOS application.
-     *
      * @type {string}
      */
     const nwjsApp = path.resolve(outDir, 'nwjs.app');
 
     /**
      * Path to renamed MacOS application.
-     *
      * @type {string}
      */
     const outApp = path.resolve(outDir, `${app.name}.app`);
@@ -218,7 +224,6 @@ export default async function setOsxConfig({ app, outDir, releaseInfo }) {
 
     /**
      * Path to `nwjs.app/Contents/Info.plist`
-     *
      * @type {string}
      */
     const ContentsInfoPlistPath = path.resolve(
@@ -229,7 +234,6 @@ export default async function setOsxConfig({ app, outDir, releaseInfo }) {
 
     /**
      * Path to `nwjs.app/Contents/Resources/en.lproj/InfoPlist.settings`
-     *
      * @type {string}
      */
     const ContentsResourcesEnLprojInfoPlistStringsPath = path.resolve(
@@ -242,7 +246,6 @@ export default async function setOsxConfig({ app, outDir, releaseInfo }) {
 
     /**
      * JSON from `nwjs.app/Contents/Info.plist`
-     *
      * @type {object}
      */
     const ContentsInfoPlistJson = plist.parse(
@@ -254,7 +257,6 @@ export default async function setOsxConfig({ app, outDir, releaseInfo }) {
 
     /**
      * JSON from `${app.name} Helper.app (Alerts)/Contents/Info.plist`
-     *
      * @type {object}
      */
     const HelperAlertsAppJson = plist.parse(
@@ -270,7 +272,6 @@ export default async function setOsxConfig({ app, outDir, releaseInfo }) {
 
     /**
      * JSON from `${app.name} Helper (GPU).app/Contents/Info.plist`
-     *
      * @type {object}
      */
     const HelperGpuAppJson = plist.parse(
@@ -286,7 +287,6 @@ export default async function setOsxConfig({ app, outDir, releaseInfo }) {
 
     /**
      * JSON from `${app.name} Helper (Plugin).app/Contents/Info.plist`
-     *
      * @type {object}
      */
     const HelperPluginAppJson = plist.parse(
@@ -302,7 +302,6 @@ export default async function setOsxConfig({ app, outDir, releaseInfo }) {
 
     /**
      * JSON from `${app.name} Helper (Renderer).app/Contents/Info.plist`
-     *
      * @type {object}
      */
     const HelperRendererAppJson = plist.parse(
@@ -318,7 +317,6 @@ export default async function setOsxConfig({ app, outDir, releaseInfo }) {
 
     /**
      * JSON from `${app.name} Helper.app/Contents/Info.plist`
-     *
      * @type {object}
      */
     const HelperAppJson = plist.parse(
@@ -381,7 +379,6 @@ export default async function setOsxConfig({ app, outDir, releaseInfo }) {
 
     /**
      * Data from `nwjs.app/Contents/Resources/en.lproj/InfoPlist.settings`
-     *
      * @type {string[]}
      */
     const ContentsResourcesEnLprojInfoPlistStringsArray = (await fs.promises.readFile(