ci: run npm install before jsdoc and minor document changes (#3)

WFCD · Apr 11, 2024 · a2ae735 · a2ae735
1 parent f2bad57
commit a2ae735
Show file tree

Hide file tree

Showing 7 changed files with 19 additions and 13 deletions.
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -35,6 +35,8 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version-file: '.nvmrc'
+      - name: npm install
+        run: npm install
       - name: Semantic Release
         uses: cycjimmy/semantic-release-action@v4
         env:

diff --git a/src/Enemy.js b/src/Enemy.js
@@ -32,6 +32,7 @@ export default class Enemy {
 
     /**
      * The amount of kills that were assits
+     * @type {number}
      */
     this.assists = enemy.assists;
 

diff --git a/src/Intrinsics.js b/src/Intrinsics.js
@@ -1,6 +1,9 @@
 export default class Intrinsics {
   constructor(skills) {
     // I know this is railjack but I'm not sure what the context is
+    /**
+     * @type {number}
+     */
     this.space = skills.LPP_SPACE;
 
     /**

diff --git a/src/ItemConfig.js b/src/ItemConfig.js
@@ -26,25 +26,25 @@ export default class ItemConfig {
 
     /**
      * Primary colors applied to item if they exist
-     * @type {import('warframe-items').ColorMap}
+     * @type {module:"warframe-items".ColorMap}
      */
     if (config.pricol) this.primaryColor = colors.mapColors(mapToHex(config.pricol));
 
     /**
      * Sigil colors applied to item if they exist
-     * @type {import('warframe-items').ColorMap}
+     * @type {module:"warframe-items".ColorMap}
      */
     if (config.sigcol) this.sigilColor = colors.mapColors(mapToHex(config.sigcol));
 
     /**
      * Attachment colors applied to item if they exist
-     * @type {import('warframe-items').ColorMap}
+     * @type {module:"warframe-items".ColorMap}
      */
     if (config.attcol) this.attachmentsColor = colors.mapColors(mapToHex(config.attcol));
 
     /**
      * Syandana colors applied to item if they exist
-     * @type {import('warframe-items').ColorMap}
+     * @type {module:"warframe-items".ColorMap}
      */
     if (config.syancol) this.syandanaColor = colors.mapColors(mapToHex(config.syancol));
   }

diff --git a/src/LoadOutItem.js b/src/LoadOutItem.js
@@ -28,7 +28,7 @@ export default class LoadOutItem {
 
       /**
        * Complete item from Warframe-items
-       * @type {import('warframe-items').Item}
+       * @type {module:"warframe-items".Item}
        */
       this.item = item;
     }

diff --git a/src/OperatorLoadOuts.js b/src/OperatorLoadOuts.js
@@ -25,43 +25,43 @@ export default class OperatorLoadOuts {
 
     /**
      * Operator primary colors
-     * @type {import('warframe-items').ColorMap}
+     * @type {module:"warframe-items".ColorMap}
      */
     if (loadout.pricol) this.primaryColor = colors.mapColors(mapToHex(loadout.pricol));
 
     /**
      * Operator sigil colors
-     * @type {import('warframe-items').ColorMap}
+     * @type {module:"warframe-items".ColorMap}
      */
     if (loadout.sigcol) this.sigilColor = colors.mapColors(mapToHex(loadout.sigcol));
 
     /**
      * Operator attachment colors
-     * @type {import('warframe-items').ColorMap}
+     * @type {module:"warframe-items".ColorMap}
      */
     if (loadout.attcol) this.attachmentsColor = colors.mapColors(mapToHex(loadout.attcol));
 
     /**
      * Operator syandana colors
-     * @type {import('warframe-items').ColorMap}
+     * @type {module:"warframe-items".ColorMap}
      */
     if (loadout.syancol) this.syandanaColor = colors.mapColors(mapToHex(loadout.syancol));
 
     /**
      * Operator eye colors
-     * @type {import('warframe-items').ColorMap}
+     * @type {module:"warframe-items".ColorMap}
      */
     if (loadout.eyecol) this.eyeColor = colors.mapColors(mapToHex(loadout.eyecol));
 
     /**
      * Operator facial colors
-     * @type {import('warframe-items').ColorMap}
+     * @type {module:"warframe-items".ColorMap}
      */
     if (loadout.facial) this.facial = colors.mapColors(mapToHex(loadout.facial));
 
     /**
      * Operator cloth colors
-     * @type {import('warframe-items').ColorMap}
+     * @type {module:"warframe-items".ColorMap}
      */
     if (loadout.cloth) this.cloth = colors.mapColors(mapToHex(loadout.cloth));
   }

diff --git a/src/XpInfo.js b/src/XpInfo.js
@@ -16,7 +16,7 @@ export default class XpInfo {
 
     /**
      * The item corrosponding to the unique name.
-     * @type {import('warframe-items').Item | undefined}
+     * @type {module:"warframe-items".Item | undefined}
      */
     this.item = find.findItem(info.ItemType);
   }