Create annotations from relevant issues

Author: matejchalk

__tests__/fixtures/code-pushup.config.ts

@@ -20,16 +20,25 @@ const config: CoreConfig = {
           directory: fileURLToPath(dirname(import.meta.url)),
           pattern: /\.[jt]s$/
         })
-        const jsFileCount = paths.filter(path => path.endsWith('.js')).length
-        const tsFileCount = paths.filter(path => path.endsWith('.ts')).length
+        const jsPaths = paths.filter(path => path.endsWith('.js'))
+        const tsPaths = paths.filter(path => path.endsWith('.ts'))
+        const jsFileCount = jsPaths.length
+        const tsFileCount = tsPaths.length
         const ratio = tsFileCount / (jsFileCount + tsFileCount)
         const percentage = Math.round(ratio * 100)
         return [
           {
             slug: 'ts-files',
             value: percentage,
             score: ratio,
-            displayValue: `${percentage}% converted`
+            displayValue: `${percentage}% converted`,
+            details: {
+              issues: jsPaths.map(file => ({
+                message: 'Use .ts file extension instead of .js',
+                severity: 'warning',
+                source: { file }
+              }))
+            }
           }
         ]
       }

__tests__/main.test.ts

@@ -59,6 +59,8 @@ describe('code-pushup action', () => {
             return true
           case 'artifacts':
             return true
+          case 'annotations':
+            return true
           default:
             return false
         }
@@ -195,28 +197,31 @@ describe('code-pushup action', () => {
 
   describe('pull request event', () => {
     beforeEach(async () => {
-      github.context.payload = {
-        pull_request: {
-          number: 42,
-          base: {
-            ref: 'main'
-          }
-        }
-      }
-
       await git.checkoutLocalBranch('feature-1')
 
       await rename(join(workDir, 'index.js'), join(workDir, 'index.ts'))
 
       await git.add('index.ts')
       await git.commit('Convert JS file to TS')
+
+      github.context.payload = {
+        pull_request: {
+          number: 42,
+          head: { ref: 'feature-1', sha: await git.revparse('feature-1') },
+          base: { ref: 'main', sha: await git.revparse('main') }
+        }
+      }
     })
 
     it('should compare reports', async () => {
       await run(artifact, git)
 
       expect(core.setFailed).not.toHaveBeenCalled()
 
+      expect(core.error).toHaveBeenCalledTimes(0)
+      expect(core.warning).toHaveBeenCalledTimes(0)
+      expect(core.notice).toHaveBeenCalledTimes(0)
+
       expect(core.setOutput).toHaveBeenCalledWith('comment-id', 10)
 
       const mdPromise = readFile(

action.yml

@@ -31,6 +31,10 @@ inputs:
   retention:
     description: Artifact retention period in days
     required: false
+  annotations:
+    description: Create file annotations in GitHub
+    required: true
+    default: true
 
 outputs:
   artifact-id:

badges/coverage.svg

@@ -0,0 +1,28 @@
+import * as core from '@actions/core'
+import type { SourceFileIssue } from './issues'
+
+export function createAnnotationsFromIssues(issues: SourceFileIssue[]): void {
+  for (const issue of issues) {
+    const message = issue.message
+    const properties: core.AnnotationProperties = {
+      title: issue.audit.title,
+      file: issue.source.file,
+      startLine: issue.source.position?.startLine,
+      startColumn: issue.source.position?.startColumn,
+      endLine: issue.source.position?.endLine,
+      endColumn: issue.source.position?.endColumn
+    }
+
+    switch (issue.severity) {
+      case 'error':
+        core.error(message, properties)
+        break
+      case 'warning':
+        core.warning(message, properties)
+        break
+      case 'info':
+        core.notice(message, properties)
+        break
+    }
+  }
+}

dist/index.js

@@ -0,0 +1,20 @@
+import { DiffNameStatus, simpleGit } from 'simple-git'
+
+export async function listChangedFiles(
+  refs: {
+    base: { ref: string; sha: string }
+    head: { ref: string; sha: string }
+  },
+  git = simpleGit()
+): Promise<string[]> {
+  const statuses: DiffNameStatus[] = [
+    DiffNameStatus.ADDED,
+    DiffNameStatus.MODIFIED
+  ]
+  const { files } = await git.diffSummary([
+    `--diff-filter=${statuses.join('')}`,
+    refs.base.sha,
+    refs.head.sha
+  ])
+  return files.filter(({ binary }) => !binary).map(({ file }) => file)
+}

dist/index.js.map

@@ -9,6 +9,7 @@ export type ActionInputs = {
   silent: boolean
   artifacts: boolean
   retention: number | null
+  annotations: boolean
 }
 
 export function parseInputs(): ActionInputs {
@@ -19,6 +20,7 @@ export function parseInputs(): ActionInputs {
   const silent = core.getBooleanInput('silent')
   const artifacts = core.getBooleanInput('artifacts')
   const retention = parseInteger(core.getInput('retention'))
+  const annotations = core.getBooleanInput('annotations')
 
   return {
     token,
@@ -27,7 +29,8 @@ export function parseInputs(): ActionInputs {
     directory,
     silent,
     artifacts,
-    retention
+    retention,
+    annotations
   }
 }