feat: log annotations with warning if results are ignored

Codex- · Oct 31, 2023 · ff4c545 · ff4c545
1 parent 5c0c84e
commit ff4c545
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 11 deletions.
diff --git a/dist/index.mjs b/dist/index.mjs
diff --git a/src/main.ts b/src/main.ts
@@ -44,7 +44,7 @@ async function run(): Promise<void> {
     );
 
     if (config.annotations) {
-      await updateCheckAnnotations(checkId!, knipAnnotations);
+      await updateCheckAnnotations(checkId!, knipAnnotations, config.ignoreResults);
     }
 
     if (!config.ignoreResults && knipSections.length > 0) {

diff --git a/src/tasks/check.ts b/src/tasks/check.ts
@@ -20,8 +20,13 @@ type Annotation = NonNullable<Unpacked<NonNullable<CheckOutput>["annotations"]>>
 export async function updateCheckAnnotations(
   checkId: number,
   minimalAnnotations: MinimalAnnotation[],
+  ignoreResults = false,
 ): Promise<void> {
-  core.debug(`[updateCheckAnnotations]: Begin pushing annotations (${minimalAnnotations.length})`);
+  core.debug(
+    `[updateCheckAnnotations]: Begin pushing annotations (${
+      minimalAnnotations.length
+    }) with level '${ignoreResults ? "warning" : "failure"}'`,
+  );
 
   let i = 0;
   while (i < minimalAnnotations.length) {
@@ -34,9 +39,9 @@ export async function updateCheckAnnotations(
         path: ma.path,
         start_line: ma.start_line,
         end_line: ma.start_line,
-        // start_column: ma.start_column,
-        // end_column: ma.start_column + ma.identifier.length,
-        annotation_level: "failure",
+        start_column: ma.start_column,
+        end_column: ma.start_column + ma.identifier.length,
+        annotation_level: ignoreResults ? "warning" : "failure",
         message: `\`${ma.identifier}\` is unused`,
       };
       return annotation;