Fix #119 Support hovers for --start-interval in HEALTHCHECK

Signed-off-by: Remy Suen <[email protected]>

CHANGELOG.md

@@ -8,6 +8,7 @@ All notable changes to this project will be documented in this file.
 - support parsing the new `--start-interval` flag for HEALTHCHECK instructions ([rcjsuen/dockerfile-utils#115](https://github.com/rcjsuen/dockerfile-utils/issues/115))
 - allow some diagnostics to be ignored if a `# dockerfile-utils: ignore` comment precedes the originating line of the error ([rcjsuen/dockerfile-utils#106](https://github.com/rcjsuen/dockerfile-utils/issues/106))
 - suggest the new `--start-interval` flag for HEALTHCHECK instructions when calculating completion items ([#117](https://github.com/rcjsuen/dockerfile-language-service/issues/117))
+- provide documentation support when hovering over the `--start-interval` flag for HEALTHCHECK instructions ([#119](https://github.com/rcjsuen/dockerfile-language-service/issues/119))
 
 ## [0.10.2] - 2023-06-01
 ### Fixed

src/dockerHover.ts

@@ -197,6 +197,8 @@ export class DockerHover {
                                 return "HEALTHCHECK_FlagInterval";
                             case "retries":
                                 return "HEALTHCHECK_FlagRetries";
+                            case "start-interval":
+                                return "HEALTHCHECK_FlagStartInterval";
                             case "start-period":
                                 return "HEALTHCHECK_FlagStartPeriod";
                             case "timeout":

src/dockerMarkdown.ts

@@ -39,7 +39,7 @@ export class MarkdownDocumentation {
         "hoverFromFlagPlatform": "The platform of the image if referencing a multi-platform image.\n\nSince Docker CE 18.04.",
         "hoverHealthcheckFlagInterval": "The seconds to wait for the health check to run after the container has started, and then again the number of seconds to wait before running again after the previous check has completed.",
         "hoverHealthcheckFlagRetries": "The number of consecutive failures of this health check before the container is considered to be `unhealthy`.",
-        "hoverHealthcheckFlagStartInterval": "The number of seconds to wait between health checks  during the start period.",
+        "hoverHealthcheckFlagStartInterval": "The number of seconds to wait between health checks during the start period.",
         "hoverHealthcheckFlagStartPeriod": "The number of seconds to wait for the container to startup. Failures during this grace period will not count towards the maximum number of retries. However, should a health check succeed during this period then any subsequent failures will count towards the maximum number of retries.\n\nSince Docker 17.05.0-ce.",
         "hoverHealthcheckFlagTimeout": "The number of seconds to wait for the check to complete before considering it to have failed.",
 

src/dockerPlainText.ts

@@ -32,7 +32,7 @@ export class PlainTextDocumentation {
         "hoverFromFlagPlatform": "The platform of the image if referencing a multi-platform image.\n\nSince Docker CE 18.04.",
         "hoverHealthcheckFlagInterval": "The seconds to wait for the health check to run after the container has started, and then again the number of seconds to wait before running again after the previous check has completed.",
         "hoverHealthcheckFlagRetries": "The number of consecutive failures of this health check before the container is considered to be `unhealthy`.",
-        "hoverHealthcheckFlagStartInterval": "The number of seconds to wait between health checks  during the start period.",
+        "hoverHealthcheckFlagStartInterval": "The number of seconds to wait between health checks during the start period.",
         "hoverHealthcheckFlagStartPeriod": "The number of seconds to wait for the container to startup. Failures during this grace period will not count towards the maximum number of retries. However, should a health check succeed during this period then any subsequent failures will count towards the maximum number of retries.\n\nSince Docker 17.05.0-ce.",
         "hoverHealthcheckFlagTimeout": "The number of seconds to wait for the check to complete before considering it to have failed.",
 

test/dockerHover.test.ts

@@ -1625,6 +1625,11 @@ describe("Dockerfile hover", function () {
                     assertHover(content, 0, triggerOffset + 17, "HEALTHCHECK_FlagRetries");
                 });
 
+                it("--start-interval", () => {
+                    const content = onbuild + "HEALTHCHECK --start-interval";
+                    assertHover(content, 0, triggerOffset + 17, "HEALTHCHECK_FlagStartInterval");
+                });
+
                 it("--start-period", function () {
                     let content = onbuild + "HEALTHCHECK --start-period";
                     assertHover(content, 0, triggerOffset + 17, "HEALTHCHECK_FlagStartPeriod");