chore: SP-1543 Fixes linter warnings

.github/linters/.eslintrc.yml

@@ -45,7 +45,7 @@ rules:
     'no-unused-vars': 'off',
     'prettier/prettier': 'error',
     'semi': 'off',
-    'no-shadow': 'warn',
+    'no-shadow': 'off',
     '@typescript-eslint/array-type': 'error',
     '@typescript-eslint/await-thenable': 'error',
     '@typescript-eslint/ban-ts-comment': 'error',

__tests__/copyleft-policy-check.test.ts

@@ -26,13 +26,13 @@ describe('CopyleftPolicyCheck', () => {
 
   beforeEach(() => {
     jest.clearAllMocks();
+
+    policyCheck = new CopyleftPolicyCheck();
     jest.spyOn(PolicyCheck.prototype, 'uploadArtifact').mockImplementation(async () => {
       return Promise.resolve({ id: 123456 });
     });
-    jest.spyOn(PolicyCheck.prototype, 'run').mockImplementation();
+    jest.spyOn(PolicyCheck.prototype, 'initStatus').mockImplementation();
     jest.spyOn(PolicyCheck.prototype, 'finish').mockImplementation();
-
-    policyCheck = new CopyleftPolicyCheck();
   });
 
   it('should pass the policy check when no copyleft components are found', async () => {

__tests__/undeclared-policy-check.test.ts

@@ -28,11 +28,11 @@ describe('UndeclaredPolicyCheck', () => {
 
   beforeEach(() => {
     jest.clearAllMocks();
-    jest.spyOn(PolicyCheck.prototype, 'uploadArtifact').mockImplementation(async () => {
+    jest.spyOn(UndeclaredPolicyCheck.prototype, 'uploadArtifact').mockImplementation(async () => {
       return Promise.resolve({ id: 123456 });
     });
-    jest.spyOn(PolicyCheck.prototype, 'run').mockImplementation();
-    jest.spyOn(PolicyCheck.prototype, 'updateCheck').mockImplementation();
+    jest.spyOn(PolicyCheck.prototype, 'initStatus').mockImplementation();
+    jest.spyOn(UndeclaredPolicyCheck.prototype, 'updateCheck').mockImplementation();
 
     scannerResults = JSON.parse(resultsMock[3].content);
 

package.json

@@ -1,7 +1,7 @@
 {
   "name": "scanoss-code-scan-action",
   "description": "SCANOSS Code Scan Action",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "author": "SCANOSS",
   "private": true,
   "homepage": "https://github.com/scanoss/code-scan-action/",
@@ -74,6 +74,7 @@
     "@actions/github": "^6.0.0"
   },
   "devDependencies": {
+    "@octokit/types": "^13.5.0",
     "@types/jest": "^29.5.12",
     "@types/node": "^20.11.20",
     "@typescript-eslint/eslint-plugin": "^6.19.1",

src/policies/copyleft-policy-check.ts

@@ -66,7 +66,7 @@ export class CopyleftPolicyCheck extends PolicyCheck {
   }
 
   async run(scannerResults: ScannerResults): Promise<void> {
-    super.run(scannerResults);
+    super.initStatus();
     const components = getComponents(scannerResults);
 
     // Filter copyleft components

src/policies/policy-check.ts

@@ -30,6 +30,10 @@ import { GitHub } from '@actions/github/lib/utils';
 import * as inputs from '../app.input';
 import { DefaultArtifactClient, UploadArtifactResponse } from '@actions/artifact';
 import path from 'path';
+import type { Endpoints } from '@octokit/types';
+
+type ChecksCreateResponse = Endpoints['POST /repos/{owner}/{repo}/check-runs']['response'];
+type CheckRun = ChecksCreateResponse['data'];
 
 export enum CONCLUSION {
   ActionRequired = 'action_required',
@@ -58,7 +62,7 @@ export abstract class PolicyCheck {
 
   private checkRunId: number;
 
-  private _raw: any;
+  private _raw?: CheckRun;
 
   private _status: STATUS;
 
@@ -78,7 +82,9 @@ export abstract class PolicyCheck {
 
   abstract getPolicyName(): string;
 
-  async start(runId: number): Promise<any> {
+  abstract run(scannerResults: ScannerResults): Promise<void>;
+
+  async start(runId: number): Promise<CheckRun> {
     const result = await this.octokit.rest.checks.create({
       owner: context.repo.owner,
       repo: context.repo.repo,
@@ -103,15 +109,15 @@ export abstract class PolicyCheck {
     return this._conclusion;
   }
 
-  get raw(): any {
+  get raw(): CheckRun | undefined {
     return this._raw;
   }
 
   get url(): string {
-    return `${context.serverUrl}/${context.repo.owner}/${context.repo.repo}/actions/runs/${this._firstRunId}/job/${this.raw.id}`;
+    return `${context.serverUrl}/${context.repo.owner}/${context.repo.repo}/actions/runs/${this._firstRunId}/job/${this.raw?.id}`;
   }
 
-  async run(scannerResults: ScannerResults): Promise<void> {
+  initStatus(): void {
     if (this._status === STATUS.UNINITIALIZED)
       throw new Error(`Error on finish. Policy "${this.checkName}" is not created.`);
 

src/policies/undeclared-policy-check.ts

@@ -44,7 +44,7 @@ export class UndeclaredPolicyCheck extends PolicyCheck {
   }
 
   async run(scannerResults: ScannerResults): Promise<void> {
-    super.run(scannerResults);
+    super.initStatus();
 
     const nonDeclaredComponents: Component[] = [];
     let declaredComponents: Partial<Component>[] = [];

src/services/result.interfaces.ts

@@ -98,7 +98,10 @@ export interface ScannerComponent extends CommonComponent {
     score: string;
     source: string;
   }[];
-  cryptography: any[];
+  cryptography: {
+    algorithm: string;
+    strength: string;
+  }[];
   health: {
     creation_date: string;
     issues: number;

src/utils/github.utils.ts

@@ -24,10 +24,15 @@
 import { context, getOctokit } from '@actions/github';
 import * as core from '@actions/core';
 import * as inputs from '../app.input';
+import type { Endpoints } from '@octokit/types';
 
 const prEvents = ['pull_request', 'pull_request_review', 'pull_request_review_comment'];
 const FIND_FIRST_RUN_EVENT = 'workflow_dispatch';
 
+// Use the types from @octokit/types
+type WorkflowRunsResponse = Endpoints['GET /repos/{owner}/{repo}/actions/runs']['response'];
+type WorkflowRun = WorkflowRunsResponse['data']['workflow_runs'][number];
+
 export function isPullRequest(): boolean {
   return prEvents.includes(context.eventName);
 }
@@ -68,7 +73,7 @@ export async function getFirstRunId(): Promise<number> {
   return firstRunId;
 }
 
-async function loadFirstRun(owner: string, repo: string): Promise<any | null> {
+async function loadFirstRun(owner: string, repo: string): Promise<WorkflowRun | null> {
   const octokit = getOctokit(inputs.GITHUB_TOKEN);
   const sha = getSHA();
 

tsconfig.json

@@ -18,5 +18,5 @@
   "rules": {
     "@typescript-eslint/no-explicit-any": "off"
   },
-  "exclude": ["./dist", "./node_modules", "./__tests__", "./coverage"]
+  "exclude": ["./dist", "./node_modules", "./__tests__", "./coverage", "./tsconfig.json", "./.prettierrc.json"]
 }