@soos-io/soos-scm-audit 0.2.0-pre.2 → 0.2.0-pre.3

package/bin/index.js

@@ -9,16 +9,11 @@ const utilities_1 = require("@soos-io/api-client/dist/utilities");
 const ContributorAuditArgumentParser_1 = tslib_1.__importDefault(require("./services/ContributorAuditArgumentParser"));
 const ContributorAuditService_1 = tslib_1.__importDefault(require("./services/ContributorAuditService/ContributorAuditService"));
 const enums_1 = require("./enums");
-class SOOSSCMAudit {
+class SOOSContributorAudit {
     args;
     constructor(args) {
         this.args = args;
     }
-    static parseArgs() {
-        const contributorAuditArgumentParser = ContributorAuditArgumentParser_1.default.create();
-        api_client_1.soosLogger.info("Parsing arguments");
-        return contributorAuditArgumentParser.parseArguments();
-    }
     async runAudit() {
         const contributingDeveloperService = ContributorAuditService_1.default.create(this.args.apiKey, this.args.apiURL, this.args.scmType);
         let auditParams;
@@ -51,15 +46,15 @@ class SOOSSCMAudit {
         contributingDeveloperService.saveResults(contributingDevelopers, this.args.saveResults);
     }
     static async createAndRun() {
-        api_client_1.soosLogger.info("Starting SOOS SCM Contributor Audit");
-        api_client_1.soosLogger.logLineSeparator();
         try {
-            const args = this.parseArgs();
+            const contributorAuditArgumentParser = ContributorAuditArgumentParser_1.default.create();
+            const args = contributorAuditArgumentParser.parseArguments();
             api_client_1.soosLogger.setMinLogLevel(args.logLevel);
+            api_client_1.soosLogger.info("Starting SOOS SCM Contributor Audit");
             api_client_1.soosLogger.debug(JSON.stringify((0, utilities_1.obfuscateProperties)(args, ["apiKey", "secret"]), null, 2));
             api_client_1.soosLogger.logLineSeparator();
-            const soosSCMAudit = new SOOSSCMAudit(args);
-            await soosSCMAudit.runAudit();
+            const soosContributorAudit = new SOOSContributorAudit(args);
+            await soosContributorAudit.runAudit();
         }
         catch (error) {
             api_client_1.soosLogger.error(`Error on createAndRun: ${error}`);
@@ -67,4 +62,4 @@ class SOOSSCMAudit {
         }
     }
 }
-SOOSSCMAudit.createAndRun();
+SOOSContributorAudit.createAndRun();

package/bin/services/ContributorAuditArgumentParser.d.ts

@@ -1,6 +1,5 @@
-import { ArgumentParserBase, ICommonArguments } from "@soos-io/api-client";
+import { ArgumentParserBase, ICommonArguments, ParsedOptions } from "@soos-io/api-client";
 import { ScmResultsFormat, ScmType } from "../enums";
-import { Command, OptionValues } from "commander";
 interface IContributorAuditArguments extends ICommonArguments {
     days: number;
     secret: string;
@@ -8,10 +7,12 @@ interface IContributorAuditArguments extends ICommonArguments {
     scmType: ScmType;
 }
 declare class ContributorAuditArgumentParser extends ArgumentParserBase {
-    constructor(argumentParser: Command);
+    constructor(description: string);
     static create(): ContributorAuditArgumentParser;
     addBaseContributorArguments(): void;
-    parseArguments<T extends OptionValues>(): T;
+    parseArguments<T extends ParsedOptions>(argv?: string[]): {
+        [k: string]: string;
+    } & T;
 }
 export default ContributorAuditArgumentParser;
 export { IContributorAuditArguments };

package/bin/services/ContributorAuditArgumentParser.js

@@ -5,45 +5,48 @@ const GitHubContributorAuditProvider_1 = tslib_1.__importDefault(require("./Cont
 const BitbucketCloudContributorAuditProvider_1 = tslib_1.__importDefault(require("./ContributorAuditService/providers/BitbucketCloud/BitbucketCloudContributorAuditProvider"));
 const api_client_1 = require("@soos-io/api-client");
 const enums_1 = require("../enums");
-const commander_1 = require("commander");
 const constants_1 = require("../constants");
+const package_json_1 = require("../../package.json");
 class ContributorAuditArgumentParser extends api_client_1.ArgumentParserBase {
-    constructor(argumentParser) {
-        super(argumentParser);
+    constructor(description) {
+        super(description, api_client_1.ScanType.SCA, package_json_1.version, api_client_1.IntegrationName.SoosScmAudit, api_client_1.IntegrationType.Script);
+        this.addBaseContributorArguments();
     }
     static create() {
-        const parser = commander_1.program.description("SOOS SCM Audit");
-        return new ContributorAuditArgumentParser(parser);
+        return new ContributorAuditArgumentParser("SOOS SCM Audit");
     }
     addBaseContributorArguments() {
-        this.argumentParser.option("--days", "Number of days to look back for commits.", (value) => {
-            const parsedValue = parseInt(value, 10);
-            if (isNaN(parsedValue) || parsedValue <= 0) {
-                throw new Error(`Invalid value for days: ${value}`);
-            }
-            return parsedValue;
-        }, constants_1.SOOS_SCM_AUDIT_CONSTANTS.Parameters.DefaultDaysAgo);
-        this.addEnumArgument("--saveResults", enums_1.ScmResultsFormat, "Save results to file, options available: JSON, TXT.", enums_1.ScmResultsFormat.TXT);
-        this.addEnumArgument("--scmType", enums_1.ScmType, "Scm Type to use for the audit. Options: GitHub, Bitbucket.", enums_1.ScmType.GitHub);
+        this.addArgument("days", "Number of days to look back for commits.", {
+            defaultValue: constants_1.SOOS_SCM_AUDIT_CONSTANTS.Parameters.DefaultDaysAgo,
+            argParser: (value) => {
+                const parsedValue = parseInt(value, 10);
+                if (isNaN(parsedValue) || parsedValue <= 0) {
+                    throw new Error(`Invalid value for days, use a positive integer: ${value}`);
+                }
+                return parsedValue;
+            },
+        });
+        this.addEnumArgument("saveResults", enums_1.ScmResultsFormat, "Save results to file.", {
+            defaultValue: enums_1.ScmResultsFormat.TXT,
+        });
+        this.addEnumArgument("scmType", enums_1.ScmType, "Scm Type to use for the audit.", {
+            required: true,
+            defaultValue: enums_1.ScmType.GitHub,
+        });
     }
-    parseArguments() {
-        this.addCommonArguments();
-        this.addBaseContributorArguments();
-        this.argumentParser.parse();
-        const preProviderArgs = this.argumentParser.opts();
-        switch (preProviderArgs.scmType) {
+    parseArguments(argv) {
+        const preArgs = this.preParseArguments(argv);
+        switch (preArgs.scmType) {
             case enums_1.ScmType.GitHub:
-                GitHubContributorAuditProvider_1.default.addProviderArgs(this.argumentParser);
+                GitHubContributorAuditProvider_1.default.addProviderArgs(this);
                 break;
             case enums_1.ScmType.BitbucketCloud:
-                BitbucketCloudContributorAuditProvider_1.default.addProviderArgs(this.argumentParser);
+                BitbucketCloudContributorAuditProvider_1.default.addProviderArgs(this);
                 break;
             default:
-                throw new Error("Unsupported scmType");
+                throw new Error("Unsupported scmType: " + preArgs.scmType);
         }
-        this.argumentParser.parse();
-        const args = this.argumentParser.opts();
-        return args;
+        return super.parseArguments(argv);
     }
 }
 exports.default = ContributorAuditArgumentParser;

package/bin/services/ContributorAuditService/providers/BitbucketCloud/BitbucketCloudApiClient.d.ts

@@ -1,8 +1,4 @@
 import { IContributorAuditRepositories } from "@soos-io/api-client/dist/api/SOOSHooksApiClient";
-export interface BitbucketRepositoryApiResponse {
-    values: BitbucketCloudRepository[];
-    next?: string;
-}
 export interface BitbucketCloudRepository {
     uuid: string;
     full_name: string;
@@ -11,32 +7,12 @@ export interface BitbucketCloudRepository {
     updated_on: string;
     workspace: BitbucketCloudWorkspace;
 }
-export interface BitbucketCloudWorkspace {
+interface BitbucketCloudWorkspace {
     type: string;
     uuid: string;
     name: string;
     slug: string;
 }
-export interface BitbucketCloudCommitsApiResponse {
-    values: BitbucketCloudCommit[];
-    next?: string;
-}
-export interface BitbucketCloudCommit {
-    author: BitbucketCloudAuthor;
-    date: string;
-}
-export interface BitbucketCloudAuthor {
-    raw: string;
-    name: string;
-    emailAddress: string;
-    displayName: string;
-    user: BitbucketCloudUser;
-}
-interface BitbucketCloudUser {
-    display_name: string;
-    type: string;
-    nickname: string;
-}
 declare class BitbucketCloudApiClient {
     private readonly client;
     private readonly workspace;

package/bin/services/ContributorAuditService/providers/BitbucketCloud/BitbucketCloudContributorAuditProvider.d.ts

@@ -1,14 +1,13 @@
 import { IContributorAuditProvider } from "../../ContributorAuditService";
-import { IContributorAuditArguments } from "../../../ContributorAuditArgumentParser";
+import ContributorAuditArgumentParser, { IContributorAuditArguments } from "../../../ContributorAuditArgumentParser";
 import { IContributorAuditModel } from "@soos-io/api-client/dist/api/SOOSHooksApiClient";
-import { Command } from "commander";
 interface IBitBucketContributorAuditArguments extends IContributorAuditArguments {
     username: string;
     workspace: string;
 }
 declare class BitbucketCloudContributorAuditProvider implements IContributorAuditProvider {
     audit(implementationParams: Record<string, string | number>): Promise<IContributorAuditModel>;
-    static addProviderArgs(argumentParser: Command): void;
+    static addProviderArgs(argumentParser: ContributorAuditArgumentParser): void;
     private getBitbucketCloudRepositoryContributors;
 }
 export default BitbucketCloudContributorAuditProvider;

package/bin/services/ContributorAuditService/providers/BitbucketCloud/BitbucketCloudContributorAuditProvider.js

@@ -27,9 +27,11 @@ class BitbucketCloudContributorAuditProvider {
         return finalContributors;
     }
     static addProviderArgs(argumentParser) {
-        argumentParser.requiredOption("--workspace", "Organization name to use for the audit.");
-        argumentParser.requiredOption("--secret", "Secret to use for api calls, it should be an app password.");
-        argumentParser.requiredOption("--username", "Username for audit.");
+        argumentParser.addArgument("workspace", "Organization name to use for the audit.", {
+            required: true,
+        });
+        argumentParser.addArgument("secret", "Secret to use for api calls, it should be an app password.", { required: true });
+        argumentParser.addArgument("username", "Username for audit.", { required: true });
     }
     async getBitbucketCloudRepositoryContributors(bitbucketApiClient, repositories, batchSize) {
         const contributorsArray = [];

package/bin/services/ContributorAuditService/providers/GitHub/GitHubApiClient.d.ts

@@ -1,5 +1,5 @@
 import { IContributorAuditRepositories } from "@soos-io/api-client/dist/api/SOOSHooksApiClient";
-export interface GitHubOrganization {
+interface GitHubOrganization {
     login: string;
 }
 export interface GitHubRepository {
@@ -10,16 +10,6 @@ export interface GitHubRepository {
     owner: GitHubOrganization;
     pushed_at: string;
 }
-export interface GitHubCommits {
-    commit: {
-        author: GitHubAuthor;
-    };
-}
-export interface GitHubAuthor {
-    name: string;
-    email: string;
-    date: string;
-}
 declare class GitHubApiClient {
     private readonly client;
     private readonly organizationName;

package/bin/services/ContributorAuditService/providers/GitHub/GitHubContributorAuditProvider.d.ts

@@ -1,13 +1,12 @@
 import { IContributorAuditProvider } from "../../ContributorAuditService";
-import { IContributorAuditArguments } from "../../../ContributorAuditArgumentParser";
+import ContributorAuditArgumentParser, { IContributorAuditArguments } from "../../../ContributorAuditArgumentParser";
 import { IContributorAuditModel } from "@soos-io/api-client/dist/api/SOOSHooksApiClient";
-import { Command } from "commander";
 interface IGitHubContributorAuditArguments extends IContributorAuditArguments {
     organizationName: string;
 }
 declare class GitHubContributorAuditProvider implements IContributorAuditProvider {
     audit(implementationParams: Record<string, string | number>): Promise<IContributorAuditModel>;
-    static addProviderArgs(argumentParser: Command): void;
+    static addProviderArgs(argumentParser: ContributorAuditArgumentParser): void;
     private getGitHubRepositoryContributors;
 }
 export default GitHubContributorAuditProvider;

package/bin/services/ContributorAuditService/providers/GitHub/GitHubContributorAuditProvider.js

@@ -30,8 +30,12 @@ class GitHubContributorAuditProvider {
         return finalContributors;
     }
     static addProviderArgs(argumentParser) {
-        argumentParser.requiredOption("--organizationName", "Organization name to use for the audit.");
-        argumentParser.requiredOption("--secret", "Secret to use for api calls, it should be a GPAT.");
+        argumentParser.addArgument("organizationName", "Organization name to use for the audit.", {
+            required: true,
+        });
+        argumentParser.addArgument("secret", "Secret to use for api calls, it should be a GPAT.", {
+            required: true,
+        });
     }
     async getGitHubRepositoryContributors(gitHubApiClient, repositories, batchSize) {
         const contributorsArray = [];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@soos-io/soos-scm-audit",
-  "version": "0.2.0-pre.2",
+  "version": "0.2.0-pre.3",
   "description": "SOOS SCM Audit CLI",
   "main": "bin/index.js",
   "scripts": {
@@ -9,7 +9,7 @@
     "setup:update": "npx npm-check -u",
     "setup:clean": "npx rimraf node_modules && npx rimraf package-lock.json",
     "build": "tsc",
-    "build:clean": "npx rimraf build",
+    "build:clean": "npx rimraf bin",
     "format": "prettier ./src --check",
     "format:fix": "prettier ./src --write",
     "lint": "eslint --max-warnings 0",
@@ -18,7 +18,8 @@
     "check": "npm run format && npm run lint && npm run typecheck && (npm outdated || exit 0)",
     "patch": "npm version patch --no-git-tag-version",
     "patch-api-client": "npm run patch && npm run setup:clean && npm install @soos-io/api-client@latest --save-exact && npm install && npm run check",
-    "link:local": "npm link @soos-io/api-client && npm run build && npm link"
+    "link:local": "npm link @soos-io/api-client && npm run build && npm link",
+    "knip": "knip"
   },
   "repository": {
     "type": "git",
@@ -31,8 +32,8 @@
   },
   "homepage": "https://github.com/soos-io/soos-scm-audit#readme",
   "dependencies": {
-    "@soos-io/api-client": "1.3.0-pre.3",
-    "commander": "^13.1.0",
+    "@soos-io/api-client": "1.3.0",
+    "axios": "^1.8.3",
     "tslib": "^2.6.2"
   },
   "devDependencies": {
@@ -40,6 +41,7 @@
     "@types/node": "^20.11.30",
     "eslint": "^9.21.0",
     "globals": "^16.0.0",
+    "knip": "^5.46.0",
     "prettier": "^3.2.5",
     "typescript": "^5.4.3",
     "typescript-eslint": "^8.24.1"