@tahminator/pipeline 1.0.21 → 1.0.22

package/dist/sonar/client.d.ts

@@ -4,23 +4,53 @@ type SonarScannerOpts = {
         token: string;
     };
     run: {
+        /**
+         * Pass in a Bun command
+         *
+         * @example
+         * ```
+         * new SonarScannerClient({
+         *   run: {
+         *     runTestsCmd: $`./mvnw clean verify -Dspring.profiles.active=ci`
+         *   }
+         * })
+         * ```
+         */
         runTestsCmd: $.ShellPromise;
     };
     scan: {
         hostUrl?: string;
+        /**
+         * All args will be formated into `-Dsonar.${key}=${value}`
+         */
         additionalArgs?: Record<string, string | number | boolean>;
         projectKey: string;
         organization: string;
+        /**
+         * Point this at where your source code files reside. e.g. `src/` or `src/java`
+         */
         sourceCodeDir: string;
     };
 };
 /**
- * @beta WIP
+ * Provides a unified way to run tests & upload test coverage to a SonarQube instance.
+ *
+ * This client can be used to wire up test coverage for any language & environment; essentially, if SonarQube
+ * supports it, this client can do it.
  */
 export declare class SonarScannerClient {
     private readonly opts;
+    /**
+     * Get `token`, `projectKey` & `organization` from https://sonarcloud.io/project/configuration/GitHubManual?id=<project_name>
+     */
     constructor(opts: SonarScannerOpts);
+    /**
+     * Runs `opts.run.runTestsCmd`
+     */
     runTests(): Promise<void>;
-    uploadTests(): Promise<void>;
+    /**
+     * Upload test coverage to SonarQube.
+     */
+    uploadTestCoverage(): Promise<void>;
 }
 export {};

package/dist/sonar/client.js

@@ -1,17 +1,29 @@
 import { $ } from "bun";
 import { isCmdAvailable } from "../utils/cmd";
 /**
- * @beta WIP
+ * Provides a unified way to run tests & upload test coverage to a SonarQube instance.
+ *
+ * This client can be used to wire up test coverage for any language & environment; essentially, if SonarQube
+ * supports it, this client can do it.
  */
 export class SonarScannerClient {
     opts;
+    /**
+     * Get `token`, `projectKey` & `organization` from https://sonarcloud.io/project/configuration/GitHubManual?id=<project_name>
+     */
     constructor(opts) {
         this.opts = opts;
     }
+    /**
+     * Runs `opts.run.runTestsCmd`
+     */
     async runTests() {
         await this.opts.run.runTestsCmd;
     }
-    async uploadTests() {
+    /**
+     * Upload test coverage to SonarQube.
+     */
+    async uploadTestCoverage() {
         if (!(await isCmdAvailable("sonar"))) {
             console.log("Sonar is missing, installing globally via NPM...");
             await $ `npm i -g @sonar/scan`;

package/package.json

@@ -3,7 +3,7 @@
   "type": "module",
   "author": "Tahmid Ahmed",
   "description": "A collection of Bun shell scripts that can be re-used in various CICD pipelines.",
-  "version": "1.0.21",
+  "version": "1.0.22",
   "repository": {
     "url": "git+https://github.com/tahminator/pipeline.git"
   },