@overkill-dev/output-renderer-github-actions 0.0.1 → 0.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Overkill contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/output-renderers/github-actions-output-renderer.d.ts

@@ -0,0 +1,3 @@
+import type { OutputRenderer } from '@overkill-dev/engine';
+export declare function createGithubActionsOutputRenderer(): OutputRenderer;
+//# sourceMappingURL=github-actions-output-renderer.d.ts.map

package/output-renderers/github-actions-output-renderer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"github-actions-output-renderer.d.ts","sourceRoot":"","sources":["../../../../source/output-renderers/github-actions-output-renderer.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAoB,cAAc,EAAE,MAAM,sBAA8B,CAAC;AA2DrF,wBAAgB,iCAAiC,IAAI,cAAc,CAMlE"}

package/output-renderers/github-actions-output-renderer.js

@@ -0,0 +1,51 @@
+function escapeCommandValue(value) {
+    return value
+        .replaceAll('%', '%25')
+        .replaceAll('\r', '%0D')
+        .replaceAll('\n', '%0A');
+}
+function escapeCommandProperty(value) {
+    return escapeCommandValue(value)
+        .replaceAll(':', '%3A')
+        .replaceAll(',', '%2C');
+}
+function renderProperty(name, value) {
+    return value === null ? null : `${name}=${escapeCommandProperty(value)}`;
+}
+function renderableLocation(annotation) {
+    const location = annotation?.location ?? null;
+    if (location === null || location.file.length === 0 || location.line === null) {
+        return null;
+    }
+    return {
+        ...location,
+        line: location.line
+    };
+}
+function renderGitHubAnnotation(intent) {
+    const { annotation } = intent;
+    const location = renderableLocation(annotation);
+    if (annotation === null || location === null) {
+        return null;
+    }
+    const column = location.column === null ? null : String(location.column);
+    const properties = [
+        `file=${escapeCommandProperty(location.file)}`,
+        `line=${location.line}`,
+        renderProperty('col', column),
+        renderProperty('title', annotation.title)
+    ]
+        .filter(function isProperty(property) {
+        return property !== null;
+    })
+        .join(',');
+    return `::${annotation.severity} ${properties}::${escapeCommandValue(intent.text)}`;
+}
+export function createGithubActionsOutputRenderer() {
+    return {
+        render(intent) {
+            return renderGitHubAnnotation(intent) ?? intent.text;
+        }
+    };
+}
+//# sourceMappingURL=github-actions-output-renderer.js.map

package/output-renderers/github-actions-output-renderer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"github-actions-output-renderer.js","sourceRoot":"","sources":["../../../../source/output-renderers/github-actions-output-renderer.ts"],"names":[],"mappings":"AAOA,SAAS,kBAAkB,CAAC,KAAa;IACrC,OAAO,KAAK;SACP,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC;SACtB,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC;SACvB,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AACjC,CAAC;AAED,SAAS,qBAAqB,CAAC,KAAa;IACxC,OAAO,kBAAkB,CAAC,KAAK,CAAC;SAC3B,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC;SACtB,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AAChC,CAAC;AAED,SAAS,cAAc,CAAC,IAAY,EAAE,KAAoB;IACtD,OAAO,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,qBAAqB,CAAC,KAAK,CAAC,EAAE,CAAC;AAC7E,CAAC;AAED,SAAS,kBAAkB,CAAC,UAA0C;IAClE,MAAM,QAAQ,GAAG,UAAU,EAAE,QAAQ,IAAI,IAAI,CAAC;IAE9C,IAAI,QAAQ,KAAK,IAAI,IAAI,QAAQ,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,QAAQ,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;QAC5E,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,OAAO;QACH,GAAG,QAAQ;QACX,IAAI,EAAE,QAAQ,CAAC,IAAI;KACtB,CAAC;AACN,CAAC;AAED,SAAS,sBAAsB,CAAC,MAAwB;IACpD,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;IAC9B,MAAM,QAAQ,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;IAEhD,IAAI,UAAU,KAAK,IAAI,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;QAC3C,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IACzE,MAAM,UAAU,GAAG;QACf,QAAQ,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;QAC9C,QAAQ,QAAQ,CAAC,IAAI,EAAE;QACvB,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC;QAC7B,cAAc,CAAC,OAAO,EAAE,UAAU,CAAC,KAAK,CAAC;KAC5C;SACI,MAAM,CAAC,SAAS,UAAU,CAAC,QAAQ;QAChC,OAAO,QAAQ,KAAK,IAAI,CAAC;IAC7B,CAAC,CAAC;SACD,IAAI,CAAC,GAAG,CAAC,CAAC;IAEf,OAAO,KAAK,UAAU,CAAC,QAAQ,IAAI,UAAU,KAAK,kBAAkB,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;AACxF,CAAC;AAED,MAAM,UAAU,iCAAiC;IAC7C,OAAO;QACH,MAAM,CAAC,MAAM;YACT,OAAO,sBAAsB,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC;QACzD,CAAC;KACJ,CAAC;AACN,CAAC"}

package/package.json

@@ -1,7 +1,34 @@
 {
-  "name": "@overkill-dev/output-renderer-github-actions",
-  "version": "0.0.1",
-  "description": "Placeholder claiming the npm package name \"@overkill-dev/output-renderer-github-actions\" so a trusted publisher can be configured. See https://github.com/npm/cli/issues/8544.",
-  "license": "MIT",
-  "deprecated": "Placeholder published as a workaround so a Trusted Publisher could be configured. See https://github.com/npm/cli/issues/8544."
-}
+    "author": "Christian Rackerseder <git@echooff.de>",
+    "bugs": {
+        "url": "https://github.com/enormora/overkill/issues"
+    },
+    "description": "GitHub Actions renderer for Overkill managed output.",
+    "engines": {
+        "node": "^26"
+    },
+    "exports": {
+        ".": {
+            "import": "./packages/output-renderer-github-actions/output-renderer-github-actions.entry-point.js",
+            "types": "./packages/output-renderer-github-actions/output-renderer-github-actions.entry-point.d.ts"
+        }
+    },
+    "homepage": "https://github.com/enormora/overkill#readme",
+    "keywords": [
+        "tdd",
+        "test",
+        "tests"
+    ],
+    "license": "MIT",
+    "name": "@overkill-dev/output-renderer-github-actions",
+    "peerDependencies": {
+        "@overkill-dev/engine": "0.0.12"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/enormora/overkill.git"
+    },
+    "sideEffects": false,
+    "type": "module",
+    "version": "0.0.2"
+}

package/packages/output-renderer-github-actions/output-renderer-github-actions.entry-point.d.ts

@@ -0,0 +1,2 @@
+export { createGithubActionsOutputRenderer } from '../../output-renderers/github-actions-output-renderer.ts';
+//# sourceMappingURL=output-renderer-github-actions.entry-point.d.ts.map

package/packages/output-renderer-github-actions/output-renderer-github-actions.entry-point.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"output-renderer-github-actions.entry-point.d.ts","sourceRoot":"","sources":["../../../../../source/packages/output-renderer-github-actions/output-renderer-github-actions.entry-point.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iCAAiC,EAAE,MAAM,0DAA0D,CAAC"}

package/packages/output-renderer-github-actions/output-renderer-github-actions.entry-point.js

@@ -0,0 +1,2 @@
+export { createGithubActionsOutputRenderer } from "../../output-renderers/github-actions-output-renderer.js";
+//# sourceMappingURL=output-renderer-github-actions.entry-point.js.map

package/packages/output-renderer-github-actions/output-renderer-github-actions.entry-point.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"output-renderer-github-actions.entry-point.js","sourceRoot":"","sources":["../../../../../source/packages/output-renderer-github-actions/output-renderer-github-actions.entry-point.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iCAAiC,EAAE,MAAM,0DAA0D,CAAC"}

package/readme.md

@@ -1,7 +1,18 @@
-# @overkill-dev/output-renderer-github-actions
+# `@overkill-dev/output-renderer-github-actions`
 
-This version is a placeholder published only to claim the npm name `@overkill-dev/output-renderer-github-actions` so a Trusted Publisher
-can subsequently be configured for it. It contains no real package content and is published already
-deprecated.
+GitHub Actions renderer for Overkill managed output intents.
 
-Workaround context: https://github.com/npm/cli/issues/8544
+```ts
+import { defineConfig } from '@overkill-dev/run/command-line';
+import { createBriefReporter } from '@overkill-dev/reporter-brief';
+import { createGithubActionsOutputRenderer } from '@overkill-dev/output-renderer-github-actions';
+
+export default defineConfig({
+    outputRenderer: createGithubActionsOutputRenderer(),
+    reporters: [ createBriefReporter() ]
+});
+```
+
+Located diagnostics render as GitHub workflow commands. Other managed output
+renders as plain text. The renderer does not use the Checks API and is not
+enabled automatically.

package/sbom.cdx.json

@@ -0,0 +1,50 @@
+{
+    "$schema": "http://cyclonedx.org/schema/bom-1.6.schema.json",
+    "bomFormat": "CycloneDX",
+    "specVersion": "1.6",
+    "version": 1,
+    "metadata": {
+        "tools": {
+            "components": [
+                {
+                    "type": "application",
+                    "name": "packtory",
+                    "version": "0.0.92"
+                }
+            ]
+        },
+        "component": {
+            "type": "library",
+            "name": "@overkill-dev/output-renderer-github-actions",
+            "version": "0.0.2",
+            "bom-ref": "pkg:npm/@overkill-dev/output-renderer-github-actions@0.0.2",
+            "purl": "pkg:npm/@overkill-dev/output-renderer-github-actions@0.0.2"
+        }
+    },
+    "components": [
+        {
+            "type": "library",
+            "name": "@overkill-dev/engine",
+            "version": "0.0.12",
+            "bom-ref": "pkg:npm/@overkill-dev/engine@0.0.12",
+            "scope": "optional",
+            "licenses": [
+                {
+                    "expression": "MIT"
+                }
+            ],
+            "purl": "pkg:npm/@overkill-dev/engine@0.0.12"
+        }
+    ],
+    "dependencies": [
+        {
+            "ref": "pkg:npm/@overkill-dev/engine@0.0.12"
+        },
+        {
+            "ref": "pkg:npm/@overkill-dev/output-renderer-github-actions@0.0.2",
+            "dependsOn": [
+                "pkg:npm/@overkill-dev/engine@0.0.12"
+            ]
+        }
+    ]
+}