fix: bug#139, add in link checkers to documentation

ztalbot2000 · Jun 11, 2023 · f4a1ae7 · f4a1ae7
1 parent 62504e6
commit f4a1ae7
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 4 deletions.
diff --git a/docs/autoGenerated/CMD4_AccessoryDescriptions.html b/docs/autoGenerated/CMD4_AccessoryDescriptions.html
@@ -7026,7 +7026,7 @@ <h2><a name="CMD4 Accessory Directives">CMD4 Accessory Directives</a></h2>
          </TABLE>
       </DIV>   <!-- main -->
       <div id="CustomCharacteristics" class="section">
-         <h2><a name="CUSTOMCHARACTERISTICS">Custom Characteristics</a></h2>
+         <h2><a name="CUSTOM_CHARACTERISTICS">Custom Characteristics</a></h2>
          <p>These directives appear within the Cmd4 Platform section</p><BR>
          <p>IMPORTANT - It is unlikely that adding custom characteristics will be supported by any GUI or SIRI<BR>
          <BR><BR>

diff --git a/package.json b/package.json
@@ -33,6 +33,7 @@
       "eslint": "^7.17.0",
       "generate-changelog": "^1.8.0",
       "husky": "^4.3.8",
+      "link-checker": "^1.4.2",
       "markdown-link-check": "^3.8.6",
       "mocha": "^8.0.1",
       "node-persist": "^0.0.11",
@@ -82,7 +83,8 @@
       "allTests": "node_modules/.bin/mocha --bail --file test/mocha-setup $( cat test/allTests )",
       "sanityTests": "node_modules/.bin/mocha --bail --file test/mocha-setup $( cat test/sanityTests )",
       "_Note0": "Excluded from commit as may fail for probing GitHub to much",
-      "testMarkDown": "markdown-link-check ./README.md && markdown-link-check ./CHANGELOG.md",
+      "testMarkDown": "markdown-link-check ./README.md && markdown-link-check ./CHANGELOG.md && markdown-link-check ./docs/AdvancedTroubleShooting.md && markdown-link-check ./docs/Developers.md",
+      "testAutoGeneratedDocLinks": "link-checker docs/autoGenerated/CMD4_AccessoryDescriptions.html",
       "commitTests": "npm run test && npm run testMarkDown",
       "_Note": "Excluded only because they sometimes fail, but pass alone.    ",
       "testCmd4Accessory": "node_modules/.bin/mocha --file test/mocha-setup test/Cmd4Accessory.js",

diff --git a/tools/Cmd4AccDocGenerator b/tools/Cmd4AccDocGenerator
@@ -1253,7 +1253,7 @@ function addCmd4AccessoryDirectivePages_WithinMain( )
    wfs( `<TR ALIGN="left"><TD><a name="${ constants.CATEGORY }">${ constants.CATEGORY }</a><TD> < CATEGORY > <TD> <TD> See <a href="https://developers.homebridge.io/#/categories">Homebridge Categories</a> for a complete list of possible categories.  </TR>\n` );
 
    // fakegato - AccessoryDirectives
-   wfs( `<TR ALIGN="left"><TD><a name="${ constants.FAKEGATO }">${ constants.FAKEGATO }</a><TD>  < JSON >  <TD> <TD> See the section, <a href="https://github.com/ztalbot2000/homebridge-cmd4/README.md#fakegatotag"> "Adding in Fakegato history"</a> below.</TR>\n` );
+   wfs( `<TR ALIGN="left"><TD><a name="${ constants.FAKEGATO }">${ constants.FAKEGATO }</a><TD>  < JSON >  <TD> <TD> See the section, <a href="https://github.com/ztalbot2000/homebridge-cmd4/docs/Developers.md#fakegatotag"> "Adding in Fakegato history"</a> below.</TR>\n` );
 
    // linkedTypes - AccessoryDirectives
    wfs( `<TR ALIGN="left"><TD><a name="${ constants.LINKEDTYPES }">${ constants.LINKEDTYPES }</a><TD>  < JSON >  <TD> <TD> Other Cmd4 Accessories like Input Source for HDMI inputs. </TR>\n` );
@@ -1268,7 +1268,7 @@ function addCustomCharacteristicPages_withinMain( )
 {
    wf( "+", `<div id="CustomCharacteristics" class="section">\n` );
 
-   wfs( `<h2><a name="CUSTOMCHARACTERISTICS">Custom Characteristics</a></h2>\n` );
+   wfs( `<h2><a name="CUSTOM_CHARACTERISTICS">Custom Characteristics</a></h2>\n` );
    wfs( `<p>These directives appear within the Cmd4 Platform section</p><BR>\n` );
    wfs( `<p>IMPORTANT - It is unlikely that adding custom characteristics will be supported by any GUI or SIRI<BR>\n` );
    wfs( `<BR><BR>\n` );