apex-code-coverage-transformer 1.6.8 → 1.7.0

package/README.md

@@ -56,6 +56,28 @@ EXAMPLES
     $ sf apex-code-coverage transformer transform -j "coverage.json" -x "coverage.xml"
 ```
 
+## Hook
+
+A post-run hook has been configured if you elect to use it.
+
+The post-run hook will automatically transform the code coverage JSON file into a generic test coverage report XML after every Salesforce CLI deployment (`sf project deploy start`, `sf project deploy validate`, `sf project deploy report`, `sf project deploy resume` commands) if the JSON is found.
+
+The hook requires you to create this file in the root of your repo: `.apexcodecovtransformer.config.json`
+
+The `.apexcodecovtransformer.config.json` should look like this:
+
+```json
+{
+  "coverageJsonPath": "coverage/coverage/coverage.json",
+  "coverageXmlPath": "coverage.xml"
+}
+```
+
+- `coverageJsonPath` is required and should be the path to the code coverage JSON created by the Salesforce CLI. Recommend using a relative path.
+- `coverageXmlPath` is optional and should be the path to the code coverage XML created by this plugin. Recommend using a relative path. If this isn't provided, it will default to `coverage.xml` in the working directory.
+
+If the `.apexcodecovtransformer.config.json` file isn't found, the hook will be skipped.
+
 ## Errors and Warnings
 
 Any file in the coverage JSON that isn't found in any package directory will result in this warning:

package/lib/helpers/types.d.ts

@@ -37,4 +37,8 @@ export interface CoverageObject {
         '@version': string;
     };
 }
+export interface ConfigFile {
+    coverageJsonPath: string;
+    coverageXmlPath: string;
+}
 export {};

package/lib/hooks/postrun.d.ts

@@ -0,0 +1,2 @@
+import { Hook } from '@oclif/core';
+export declare const postrun: Hook<'postrun'>;

package/lib/hooks/postrun.js

@@ -0,0 +1,44 @@
+'use strict';
+import { existsSync } from 'node:fs';
+import { readFile } from 'node:fs/promises';
+import { resolve } from 'node:path';
+import { simpleGit } from 'simple-git';
+import TransformerTransform from '../commands/apex-code-coverage/transformer/transform.js';
+export const postrun = async function (options) {
+    if (['project:deploy:validate', 'project:deploy:start', 'project:deploy:report', 'project:deploy:resume'].includes(options.Command.id)) {
+        let configFile;
+        const gitOptions = {
+            baseDir: process.cwd(),
+            binary: 'git',
+            maxConcurrentProcesses: 6,
+            trimmed: true,
+        };
+        const git = simpleGit(gitOptions);
+        const repoRoot = (await git.revparse('--show-toplevel')).trim();
+        const configPath = resolve(repoRoot, '.apexcodecovtransformer.config.json');
+        try {
+            const jsonString = await readFile(configPath, 'utf-8');
+            configFile = JSON.parse(jsonString);
+        }
+        catch (error) {
+            return;
+        }
+        const coverageJson = configFile.coverageJsonPath || '.';
+        const coverageXml = configFile.coverageXmlPath || 'coverage.xml';
+        if (coverageJson.trim() === '.') {
+            return;
+        }
+        const coverageJsonPath = resolve(coverageJson);
+        const coverageXmlPath = resolve(coverageXml);
+        if (!existsSync(coverageJsonPath)) {
+            return;
+        }
+        const commandArgs = [];
+        commandArgs.push('--coverage-json');
+        commandArgs.push(coverageJsonPath);
+        commandArgs.push('--xml');
+        commandArgs.push(coverageXmlPath);
+        await TransformerTransform.run(commandArgs);
+    }
+};
+//# sourceMappingURL=postrun.js.map

package/lib/hooks/postrun.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"postrun.js","sourceRoot":"","sources":["../../src/hooks/postrun.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EAAE,SAAS,EAA+B,MAAM,YAAY,CAAC;AACpE,OAAO,oBAAoB,MAAM,yDAAyD,CAAC;AAG3F,MAAM,CAAC,MAAM,OAAO,GAAoB,KAAK,WAAW,OAAO;IAC7D,IACE,CAAC,yBAAyB,EAAE,sBAAsB,EAAE,uBAAuB,EAAE,uBAAuB,CAAC,CAAC,QAAQ,CAC5G,OAAO,CAAC,OAAO,CAAC,EAAE,CACnB,EACD,CAAC;QACD,IAAI,UAAsB,CAAC;QAC3B,MAAM,UAAU,GAA8B;YAC5C,OAAO,EAAE,OAAO,CAAC,GAAG,EAAE;YACtB,MAAM,EAAE,KAAK;YACb,sBAAsB,EAAE,CAAC;YACzB,OAAO,EAAE,IAAI;SACd,CAAC;QAEF,MAAM,GAAG,GAAc,SAAS,CAAC,UAAU,CAAC,CAAC;QAC7C,MAAM,QAAQ,GAAG,CAAC,MAAM,GAAG,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAChE,MAAM,UAAU,GAAG,OAAO,CAAC,QAAQ,EAAE,qCAAqC,CAAC,CAAC;QAE5E,IAAI,CAAC;YACH,MAAM,UAAU,GAAW,MAAM,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;YAC/D,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAe,CAAC;QACpD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO;QACT,CAAC;QAED,MAAM,YAAY,GAAW,UAAU,CAAC,gBAAgB,IAAI,GAAG,CAAC;QAChE,MAAM,WAAW,GAAW,UAAU,CAAC,eAAe,IAAI,cAAc,CAAC;QAEzE,IAAI,YAAY,CAAC,IAAI,EAAE,KAAK,GAAG,EAAE,CAAC;YAChC,OAAO;QACT,CAAC;QAED,MAAM,gBAAgB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;QAC/C,MAAM,eAAe,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;QAE7C,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,EAAE,CAAC;YAClC,OAAO;QACT,CAAC;QAED,MAAM,WAAW,GAAa,EAAE,CAAC;QACjC,WAAW,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QACpC,WAAW,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACnC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1B,WAAW,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAClC,MAAM,oBAAoB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAC9C,CAAC;AACH,CAAC,CAAC"}

package/oclif.manifest.json

@@ -63,5 +63,5 @@
       ]
     }
   },
-  "version": "1.6.8"
+  "version": "1.7.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "apex-code-coverage-transformer",
   "description": "Transforms the Apex code coverage JSON created during Salesforce deployments into the Generic Test Coverage Format (XML).",
-  "version": "1.6.8",
+  "version": "1.7.0",
   "dependencies": {
     "@oclif/core": "^3.18.1",
     "@salesforce/core": "^6.4.7",
@@ -58,6 +58,9 @@
     "commands": "./lib/commands",
     "bin": "sf",
     "topicSeparator": " ",
+    "hooks": {
+      "postrun": "./lib/hooks/postrun"
+    },
     "devPlugins": [
       "@oclif/plugin-help"
     ],