Add text-instead-badge option implementation (#235)

* Add text-instead-badge option to display coverage as text

Implemented the text-instead-badge input option to allow users to display
coverage information as plain text instead of badge images, matching the
functionality available in jest-coverage-comment.

- Added text-instead-badge input to action.yml (defaults to 'false')
- Updated src/index.js to read the new input option
- Modified src/parse.js toHtml function to show text format when enabled
- Text format displays as: XX% (covered/statements)
- Built dist/index.js with updated changes

* Fix text-instead-badge to use correct property names

Use total.stmts and total.miss instead of non-existent properties.
Calculate covered statements as (stmts - miss).

* docs: add text-instead-badge option to README

Add documentation for the new text-instead-badge input option:
- Added to Display Options table with description and default value
- Added usage example in Advanced Features section
- Explained benefits: no external dependencies, faster rendering, simpler appearance

* docs: enhance text-instead-badge documentation

- Add Complete Configuration section showing all parameters
- Add Text Mode example in Result Examples section with visual comparison
- Show text-instead-badge: false in complete configuration example
- Include benefits and use cases for text mode
- Match documentation style of jest-coverage-comment

* docs: simplify text-instead-badge documentation

Remove verbose benefits lists and keep documentation minimal

* docs: remove Complete Configuration section

* chore: bump version to 1.2.0 and update CHANGELOG

* feat: update CHANGELOG for version 1.2.0, add text-instead-badge option and automatic server URL detection

---------

Co-authored-by: Claude <noreply@anthropic.com>

Author: MishaKav

CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog of the Pytest Coverage Comment
 
+## [Pytest Coverage Comment 1.2.0](https://github.com/MishaKav/pytest-coverage-comment/tree/v1.2.0)
+
+**Release Date:** 2025-11-15
+
+#### Changes
+
+- feat: add `text-instead-badge` option to display coverage as simple text instead of badge images (#235)
+- text format displays as `XX% (covered/total)` (e.g., `85% (42/50)`)
+- applies to all coverage reports: main summary and multiple-files tables
+- fully backward compatible - badge mode remains the default
+- feat: add automatic server URL detection for self-hosted GitHub instances (#234)
+
+**Note:** Starting from this version, version bumps follow conventional semantic versioning (MAJOR.MINOR.PATCH) instead of only bumping PATCH versions.
+
 ## [Pytest Coverage Comment 1.1.59](https://github.com/MishaKav/pytest-coverage-comment/tree/v1.1.59)
 
 **Release Date:** 2025-11-08

README.md

@@ -171,6 +171,7 @@ jobs:
 | `remove-link-from-badge`    | `false`           | Remove hyperlink from coverage badge (badge becomes plain image)    |
 | `remove-links-to-files`     | `false`           | Remove file links from coverage table to reduce comment size        |
 | `remove-links-to-lines`     | `false`           | Remove line number links from coverage table to reduce comment size |
+| `text-instead-badge`        | `false`           | Use simple text instead of badge images for coverage display        |
 
 </details>
 
@@ -392,6 +393,22 @@ Here's what the generated coverage comment looks like:
 
 ## 🔬 Advanced Features
 
+<details>
+<summary>📝 Text-Based Coverage Display</summary>
+
+```yaml
+- name: Coverage comment
+  uses: MishaKav/pytest-coverage-comment@main
+  with:
+    pytest-coverage-path: ./pytest-coverage.txt
+    junitxml-path: ./pytest.xml
+    text-instead-badge: true
+```
+
+Displays coverage as `85% (42/50)` instead of a badge image.
+
+</details>
+
 <details>
 <summary>📊 Using Output Variables</summary>
 
@@ -528,6 +545,18 @@ If you want auto-update the coverage badge on your README, you can see the [work
 
 ![Multiple Files](https://user-images.githubusercontent.com/289035/122121939-ddd0c500-ce34-11eb-8546-89a8a769e065.png)
 
+### Text Mode (text-instead-badge: true)
+
+With `text-instead-badge: true`, coverage displays as simple text:
+
+```
+85% (42/50)
+```
+
+Instead of a badge image:
+
+![Coverage Badge](https://img.shields.io/badge/Coverage-85%25-green.svg)
+
 </details>
 
 ## 🔧 Troubleshooting

action.yml

@@ -114,6 +114,11 @@ inputs:
     default: 'false'
     required: false
 
+  text-instead-badge:
+    description: 'Use simple text instead of badge images for coverage display'
+    default: 'false'
+    required: false
+
 outputs:
   coverage:
     description: 'Coverage percentage from pytest report (e.g., 85%)'

dist/index.js

@@ -36953,6 +36953,7 @@ const toHtml = (data, options, dataFromXml = null) => {
     hideReport,
     reportOnlyChangedFiles,
     removeLinkFromBadge,
+    textInsteadBadge,
   } = options;
   const table = hideReport ? '' : toTable(data, options, dataFromXml);
   const total = dataFromXml ? dataFromXml.total : getTotal(data);
@@ -36963,7 +36964,10 @@ const toHtml = (data, options, dataFromXml = null) => {
   const badgeWithLink = removeLinkFromBadge
     ? badge
     : `<a href="${readmeHref}">${badge}</a>`;
-  const badgeHtml = hideBadge ? '' : badgeWithLink;
+  const covered = total.stmts - total.miss;
+  const textBadge = `${total.cover} (${covered}/${total.stmts})`;
+  const badgeContent = textInsteadBadge ? textBadge : badgeWithLink;
+  const badgeHtml = hideBadge ? '' : badgeContent;
   const reportHtml = hideReport
     ? ''
     : `<details><summary>${title} ${onlyChnaged}</summary>${table}</details>`;
@@ -39487,6 +39491,9 @@ const main = async () => {
   const removeLinksToLines = core.getBooleanInput('remove-links-to-lines', {
     required: false,
   });
+  const textInsteadBadge = core.getBooleanInput('text-instead-badge', {
+    required: false,
+  });
   const uniqueIdForComment = core.getInput('unique-id-for-comment', {
     required: false,
   });
@@ -39533,6 +39540,7 @@ const main = async () => {
     removeLinkFromBadge,
     removeLinksToFiles,
     removeLinksToLines,
+    textInsteadBadge,
     defaultBranch,
     xmlTitle,
     multipleFiles,

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "pytest-coverage-comment",
-  "version": "1.1.59",
+  "version": "1.2.0",
   "description": "Comments a pull request with the pytest code coverage badge, full report and tests summary",
   "author": "Misha Kav",
   "license": "MIT",

package.json

@@ -180,6 +180,9 @@ const main = async () => {
   const removeLinksToLines = core.getBooleanInput('remove-links-to-lines', {
     required: false,
   });
+  const textInsteadBadge = core.getBooleanInput('text-instead-badge', {
+    required: false,
+  });
   const uniqueIdForComment = core.getInput('unique-id-for-comment', {
     required: false,
   });
@@ -226,6 +229,7 @@ const main = async () => {
     removeLinkFromBadge,
     removeLinksToFiles,
     removeLinksToLines,
+    textInsteadBadge,
     defaultBranch,
     xmlTitle,
     multipleFiles,

src/index.js

@@ -194,6 +194,7 @@ const toHtml = (data, options, dataFromXml = null) => {
     hideReport,
     reportOnlyChangedFiles,
     removeLinkFromBadge,
+    textInsteadBadge,
   } = options;
   const table = hideReport ? '' : toTable(data, options, dataFromXml);
   const total = dataFromXml ? dataFromXml.total : getTotal(data);
@@ -204,7 +205,10 @@ const toHtml = (data, options, dataFromXml = null) => {
   const badgeWithLink = removeLinkFromBadge
     ? badge
     : `<a href="${readmeHref}">${badge}</a>`;
-  const badgeHtml = hideBadge ? '' : badgeWithLink;
+  const covered = total.stmts - total.miss;
+  const textBadge = `${total.cover} (${covered}/${total.stmts})`;
+  const badgeContent = textInsteadBadge ? textBadge : badgeWithLink;
+  const badgeHtml = hideBadge ? '' : badgeContent;
   const reportHtml = hideReport
     ? ''
     : `<details><summary>${title} ${onlyChnaged}</summary>${table}</details>`;