@sprucelabs/jest-jira-reporter 1.0.0 → 1.0.1

package/README.md

@@ -1,76 +1,15 @@
-# Google Sheets Reporter
+# Jira Reporter
 
-Update a Google Sheet when your tests pass or fail.
+Update Jira when your tests pass or fail.
 
-<img src="https://raw.githubusercontent.com/sprucelabsai/jest-sheets-reporter/master/docs/images/overview.png">
+<img src="https://raw.githubusercontent.com/sprucelabsai/jest-jira-reporter/master/docs/images/overview.png">
 
 ## Installing
 
 ```bash
-yarn add -D @sprucelabs/jest-sheets-reporter
+yarn add -D @sprucelabs/jest-jira-reporter
 ```
-```bash
-npm install --dev @sprucelabs/jest-sheets-reporter
-```
-
-## Example Jest config
-Inside your `package.json` there is a `jest` block. 
 
-Add the following configuration:
-```json
-"jest": {
-    "reporters": [
-        "default",
-        [
-            "@sprucelabs/jest-sheets-reporter",
-            {
-                "sheetId": "{{spreadsheetId}}",
-                "worksheetId": 0,
-                "testMap": {
-                    "testName": "destinationCell",
-                    "getsGoodHealthCheckAndNothingElse": "C5",
-                    "canGetLatestVersionBasedOnDir": "C16",
-                    "canBuildSkill": "C24",
-                    "canWatchAndBuild": "C25"
-                }
-            }
-        ]
-    ]
-},
+```bash
+npm install --dev @sprucelabs/jest-jira-reporter
 ```
-
-## How does it work
-
-This simple reporter matches the name of your test against what is in your `jest` config and updates the cell whose name matches.
-
-If a test passes, the cell is set to 1. 
-
-If a test fails, the cell is set to 0.
-
-
-## Making it pretty
-
-You can change the look of a cell by using conditional formatting:
-
-<img src="https://raw.githubusercontent.com/sprucelabsai/jest-sheets-reporter/master/docs/images/conditional.png">
-
-Then we set the background and the text color based on the value being exactly `1` or `0`.
-
-<img src="https://raw.githubusercontent.com/sprucelabsai/jest-sheets-reporter/master/docs/images/stylerules.png">
-
-
-## Getting your account credentials
-
-1. Visit the [Google Console](https://console.developers.google.com/)
-2. Create a new project, call it Test Integrations
-3. After creation, go to the project dashboard and in the left meno go "API's & Services" -> "Enabled API's & Services"
-4. Click "+ Enable API's and Services"
-5. Find sheets and enable it.
-6. After save, click "Create Credentials" in the upper right.
-7. Give it a name, leave everything else blank and save
-9. On the service account details page, click "KEYS" tab
-10. Click Add Key -> JSON
-11. Take the download private key and open it
-12. client_email -> GOOGLE_SERVICE_EMAIL
-13. private_key -> GOOGLE_SERVICE_PRIVATE_KEY
-14. Remember to invite the service email to any spreadsheet you want it to update!

package/build/.spruce/errors/errors.types.d.ts

@@ -3,7 +3,7 @@ import * as SpruceSchema from '@sprucelabs/schema';
 export declare namespace SpruceErrors.JestJiraReporter {
     interface TransitionNotFound {
         /** Transition. */
-        'transition': ("In Progress" | "Done");
+        transition: 'In Progress' | 'Done';
     }
     interface TransitionNotFoundSchema extends SpruceSchema.Schema {
         id: 'transitionNotFound';
@@ -11,18 +11,21 @@ export declare namespace SpruceErrors.JestJiraReporter {
         name: 'Transition not found';
         fields: {
             /** Transition. */
-            'transition': {
+            transition: {
                 label: 'Transition';
                 type: 'select';
                 isRequired: true;
                 options: {
-                    choices: [{
-                        "value": "In Progress";
-                        "label": "In Progress";
-                    }, {
-                        "value": "Done";
-                        "label": "Done";
-                    }];
+                    choices: [
+                        {
+                            value: 'In Progress';
+                            label: 'In Progress';
+                        },
+                        {
+                            value: 'Done';
+                            label: 'Done';
+                        }
+                    ];
                 };
             };
         };

package/build/.spruce/errors/errors.types.js

@@ -1,4 +1,2 @@
 "use strict";
-/* eslint-disable @typescript-eslint/no-namespace */
-/* eslint-disable no-redeclare */
 Object.defineProperty(exports, "__esModule", { value: true });

package/build/.spruce/errors/jestJiraReporter/transitionNotFound.schema.js

@@ -7,13 +7,18 @@ const transitionNotFoundSchema = {
     name: 'Transition not found',
     fields: {
         /** Transition. */
-        'transition': {
+        transition: {
             label: 'Transition',
             type: 'select',
             isRequired: true,
-            options: { choices: [{ "value": "In Progress", "label": "In Progress" }, { "value": "Done", "label": "Done" }], }
+            options: {
+                choices: [
+                    { value: 'In Progress', label: 'In Progress' },
+                    { value: 'Done', label: 'Done' },
+                ],
+            },
         },
-    }
+    },
 };
 schema_1.SchemaRegistry.getInstance().trackSchema(transitionNotFoundSchema);
 exports.default = transitionNotFoundSchema;

package/build/.spruce/errors/options.types.d.ts

@@ -1,5 +1,5 @@
-import { SpruceErrors } from "./errors.types";
-import { ErrorOptions as ISpruceErrorOptions } from "@sprucelabs/error";
+import { ErrorOptions as ISpruceErrorOptions } from '@sprucelabs/error';
+import { SpruceErrors } from './errors.types';
 export interface TransitionNotFoundErrorOptions extends SpruceErrors.JestJiraReporter.TransitionNotFound, ISpruceErrorOptions {
     code: 'TRANSITION_NOT_FOUND';
 }

package/build/.spruce/schemas/fields/fields.types.d.ts

@@ -1 +1 @@
-export { FieldDefinitions, FieldDefinitionMap, FieldValueTypeGeneratorMap, FieldMap } from '@sprucelabs/schema';
+export { FieldDefinitions, FieldDefinitionMap, FieldValueTypeGeneratorMap, FieldMap, } from '@sprucelabs/schema';

package/build/JestReporter.js

@@ -7,14 +7,19 @@ const schema_1 = require("@sprucelabs/schema");
 const jira_client_1 = __importDefault(require("jira-client"));
 const SpruceError_1 = __importDefault(require("./errors/SpruceError"));
 class JestReporter {
+    client;
+    static JiraApi = jira_client_1.default;
+    testMap;
+    statusMap = {
+        passed: 'Done',
+        failed: 'In Progress',
+    };
+    transitions;
+    transitionLoadPromise;
     constructor(options) {
-        this.statusMap = {
-            passed: 'Done',
-            failed: 'In Progress',
-        };
         const username = process.env.JIRA_USERNAME;
         const password = process.env.JIRA_PASSWORD;
-        const { protocol, host, apiVersion, strictSSL, testMap } = (0, schema_1.assertOptions)(Object.assign(Object.assign({}, options), { env: process.env }), [
+        const { protocol, host, apiVersion, strictSSL, testMap } = (0, schema_1.assertOptions)({ ...options, env: process.env }, [
             'host',
             'apiVersion',
             'testMap',
@@ -75,5 +80,4 @@ class JestReporter {
         return this.testMap[title];
     }
 }
-JestReporter.JiraApi = jira_client_1.default;
 exports.default = JestReporter;

package/build/errors/SpruceError.d.ts

@@ -1,5 +1,5 @@
 import BaseSpruceError from '@sprucelabs/error';
-import ErrorOptions from "./../.spruce/errors/options.types";
+import ErrorOptions from './../.spruce/errors/options.types';
 export default class SpruceError extends BaseSpruceError<ErrorOptions> {
     /** an easy to understand version of the errors */
     friendlyMessage(): string;

package/build/errors/SpruceError.js

@@ -9,7 +9,7 @@ class SpruceError extends error_1.default {
     friendlyMessage() {
         const { options } = this;
         let message;
-        switch (options === null || options === void 0 ? void 0 : options.code) {
+        switch (options?.code) {
             case 'TRANSITION_NOT_FOUND':
                 message = 'A Transition not found just happened!';
                 break;

package/build/esm/.spruce/errors/errors.types.d.ts

@@ -3,7 +3,7 @@ import * as SpruceSchema from '@sprucelabs/schema';
 export declare namespace SpruceErrors.JestJiraReporter {
     interface TransitionNotFound {
         /** Transition. */
-        'transition': ("In Progress" | "Done");
+        transition: 'In Progress' | 'Done';
     }
     interface TransitionNotFoundSchema extends SpruceSchema.Schema {
         id: 'transitionNotFound';
@@ -11,18 +11,21 @@ export declare namespace SpruceErrors.JestJiraReporter {
         name: 'Transition not found';
         fields: {
             /** Transition. */
-            'transition': {
+            transition: {
                 label: 'Transition';
                 type: 'select';
                 isRequired: true;
                 options: {
-                    choices: [{
-                        "value": "In Progress";
-                        "label": "In Progress";
-                    }, {
-                        "value": "Done";
-                        "label": "Done";
-                    }];
+                    choices: [
+                        {
+                            value: 'In Progress';
+                            label: 'In Progress';
+                        },
+                        {
+                            value: 'Done';
+                            label: 'Done';
+                        }
+                    ];
                 };
             };
         };

package/build/esm/.spruce/errors/errors.types.js

@@ -1,3 +1 @@
-/* eslint-disable @typescript-eslint/no-namespace */
-/* eslint-disable no-redeclare */
 export {};

package/build/esm/.spruce/errors/options.types.d.ts

@@ -1,5 +1,5 @@
-import { SpruceErrors } from "./errors.types";
-import { ErrorOptions as ISpruceErrorOptions } from "@sprucelabs/error";
+import { ErrorOptions as ISpruceErrorOptions } from '@sprucelabs/error';
+import { SpruceErrors } from './errors.types';
 export interface TransitionNotFoundErrorOptions extends SpruceErrors.JestJiraReporter.TransitionNotFound, ISpruceErrorOptions {
     code: 'TRANSITION_NOT_FOUND';
 }

package/build/esm/errors/SpruceError.d.ts

@@ -1,5 +1,5 @@
 import BaseSpruceError from '@sprucelabs/error';
-import ErrorOptions from "./../.spruce/errors/options.types";
+import ErrorOptions from './../.spruce/errors/options.types';
 export default class SpruceError extends BaseSpruceError<ErrorOptions> {
     /** an easy to understand version of the errors */
     friendlyMessage(): string;

package/build/esm/integrationTest.js

@@ -7,7 +7,7 @@ const reporter = new JestReporter({
     strictSSL: true,
     testMap: { test1: 'LTEST-1', test2: 'LTEST-2' },
 });
-reporter.onTestComplete({}, {
+void reporter.onTestComplete({}, {
     testResults: [
         { title: 'test1', status: 'failed' },
         { title: 'test2', status: 'passed' },

package/build/integrationTest.js

@@ -12,7 +12,7 @@ const reporter = new JestReporter_1.default({
     strictSSL: true,
     testMap: { test1: 'LTEST-1', test2: 'LTEST-2' },
 });
-reporter.onTestComplete({}, {
+void reporter.onTestComplete({}, {
     testResults: [
         { title: 'test1', status: 'failed' },
         { title: 'test2', status: 'passed' },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sprucelabs/jest-jira-reporter",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "files": [
     "build"
   ],
@@ -16,57 +16,62 @@
   ],
   "license": "MIT",
   "skill": {
-    "namespace": "jest-jira-reporter"
+    "namespace": "jest-jira-reporter",
+    "upgradeIgnoreList": [
+      "@sprucelabs/spruce-core-schemas",
+      "@sprucelabs/spruce-skill-utils",
+      "@sprucelabs/spruce-test-fixtures"
+    ]
   },
   "scripts": {
-    "build.ci": "yarn build.tsc && yarn build.resolve-paths && yarn lint",
-    "build.dev": "yarn build.tsc --sourceMap ; yarn resolve-paths.lint",
+    "build.ci": "yarn run build.tsc && yarn run build.resolve-paths && yarn run lint",
+    "build.dev": "yarn run build.tsc --sourceMap ; yarn run resolve-paths.lint",
     "build.dist": "tsc --project tsconfig.dist.json && yarn build.resolve-paths && mv build esm && yarn build.esm-postbuild && yarn build.tsc && yarn build.resolve-paths && mv esm build/ && yarn clean.dist",
     "build.copy-files": "mkdir -p build && rsync -avzq --exclude='*.ts' ./src/ ./build/",
-    "build.esm-postbuild": "esm-postbuild --target esm --patterns '**/*.js'", 
+    "build.esm-postbuild": "esm-postbuild --target esm --patterns '**/*.js'",
     "build.resolve-paths": "resolve-path-aliases --target build --patterns '**/*.js,**/*.d.ts'",
-    "build.tsc": "yarn build.copy-files && tsc",
-    "clean": "yarn clean.build",
-    "clean.all": "yarn clean.dependencies && yarn clean.build",
+    "build.tsc": "yarn run build.copy-files && tsc",
+    "clean": "yarn run clean.build",
+    "clean.all": "yarn run clean.dependencies && yarn run clean.build",
     "clean.build": "rm -rf build/",
     "clean.dependencies": "rm -rf node_modules/ package-lock.json yarn.lock",
     "clean.dist": "rm -rf build/__tests__ build/esm/__tests__",
     "fix.lint": "eslint --fix --cache '**/*.ts'",
     "lint": "eslint --cache '**/*.ts'",
     "lint.tsc": "tsc -p . --noEmit",
-    "post.watch.build": "yarn build.copy-files && yarn build.resolve-paths",
-    "rebuild": "yarn clean.all && yarn && yarn build.dev",
+    "post.watch.build": "yarn run build.copy-files && yarn run build.resolve-paths",
+    "rebuild": "yarn run clean.all && yarn install && yarn run build.dev",
     "release": "semantic-release",
-    "resolve-paths.lint": "yarn build.resolve-paths ; yarn lint",
+    "resolve-paths.lint": "yarn run build.resolve-paths ; yarn run lint",
     "test": "jest",
-    "update.dependencies": "yarn clean.dependencies && yarn",
-    "watch.build.dev": "tsc-watch --sourceMap --onCompilationComplete 'yarn post.watch.build'",
-    "watch.lint": "concurrently 'yarn lint' \"chokidar 'src/**/*' -c 'yarn lint.tsc'\"",
-    "watch.rebuild": "yarn clean.all && yarn && yarn watch.build.dev",
+    "update.dependencies": "yarn run clean.dependencies && yarn",
+    "watch.build.dev": "tsc-watch --sourceMap --onCompilationComplete 'yarn run post.watch.build'",
+    "watch.lint": "concurrently 'yarn run lint' \"chokidar 'src/**/*' -c 'yarn run lint.tsc'\"",
+    "watch.rebuild": "yarn run clean.all && yarn install && yarn run watch.build.dev",
     "watch.tsc": "tsc -w"
   },
   "devDependencies": {
-    "@sprucelabs/esm-postbuild": "^5.0.47",
-    "@sprucelabs/jest-json-reporter": "^7.0.69",
-    "@sprucelabs/resolve-path-aliases": "^1.1.234",
-    "@sprucelabs/semantic-release": "^4.0.8",
-    "@sprucelabs/spruce-test-fixtures": "^60.0.41",
-    "@sprucelabs/test": "^8.0.5",
-    "@sprucelabs/test-utils": "^4.0.12",
-    "@types/jira-client": "^7.1.6",
-    "@types/node": "^20.4.8",
-    "@types/photoshop": "^25.0.0",
+    "@sprucelabs/esm-postbuild": "^6.0.5",
+    "@sprucelabs/jest-json-reporter": "^8.0.4",
+    "@sprucelabs/resolve-path-aliases": "^2.0.7",
+    "@sprucelabs/semantic-release": "^5.0.1",
+    "@sprucelabs/spruce-test-fixtures": "^61.1.35",
+    "@sprucelabs/test": "^9.0.6",
+    "@sprucelabs/test-utils": "^5.0.5",
+    "@types/jira-client": "^7.1.9",
+    "@types/node": "^20.12.7",
+    "@types/photoshop": "^25.0.4",
     "chokidar-cli": "^3.0.0",
-    "concurrently": "^8.2.0",
-    "eslint": "^8.46.0",
-    "eslint-config-spruce": "^10.12.0",
-    "jest": "^29.6.2",
-    "jest-circus": "^29.6.2",
-    "prettier": "2.8.8",
-    "ts-node": "^10.9.1",
-    "tsc-watch": "^6.0.4",
+    "concurrently": "^8.2.2",
+    "eslint": "^9.1.1",
+    "eslint-config-spruce": "^11.2.12",
+    "jest": "^29.7.0",
+    "jest-circus": "^29.7.0",
+    "prettier": "^3.2.5",
+    "ts-node": "^10.9.2",
+    "tsc-watch": "^6.2.0",
     "tsconfig-paths": "^4.2.0",
-    "typescript": "^5.1.6"
+    "typescript": "^5.4.5"
   },
   "jest": {
     "testRunner": "jest-circus/runner",
@@ -87,10 +92,10 @@
     }
   },
   "dependencies": {
-    "@sprucelabs/error": "^5.1.19",
-    "@sprucelabs/schema": "^29.0.23",
-    "@sprucelabs/spruce-core-schemas": "^39.0.29",
-    "@sprucelabs/spruce-skill-utils": "^29.1.50",
+    "@sprucelabs/error": "^6.0.5",
+    "@sprucelabs/schema": "^30.0.6",
+    "@sprucelabs/spruce-core-schemas": "^39.0.294",
+    "@sprucelabs/spruce-skill-utils": "^30.4.29",
     "jira-client": "^8.2.2"
   }
 }