Registry / devops / textlint-formatter-codecov

textlint-formatter-codecov

library1.0.2jsnpmunverified

A textlint formatter that outputs code coverage JSON compatible with Codecov. Version 1.0.2 is the latest stable release. It transforms textlint lint results into a Codecov JSON format allowing text coverage tracking. Differentiates by enabling text coverage metrics in code coverage reports, integrating linting with CI/CD pipelines. Low maintenance cadence; last updated years ago.

devops

npm install textlint-formatter-codecov

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · TEXTLINT-FORMATTER

textlint-formatter-codecov

devopsjavascriptv1.0.2

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default

✓ import formatter from 'textlint-formatter-codecov'

✗ const formatter = require('textlint-formatter-codecov')

Package is ESM-only; CommonJS require may work but is not officially supported.

formatter

✓ import * as codecovFormatter from 'textlint-formatter-codecov'

The package exports a single function as default; named export not available.

CodecovFormatter

✓ import type { CodecovFormatter } from 'textlint-formatter-codecov'

✗ import { CodecovFormatter } from 'textlint-formatter-codecov'

TypeScript types are not shipped; this import will fail. Use default import only.

Shows two usage patterns: CLI pipe to codecov.io and programmatic usage with textlint API.

// quickstart: run textlint with codecov formatter and pipe to codecov.io textlint -f codecov | codecov.io // or programmatically import textlint from 'textlint'; const result = await textlint.lintFiles(['*.md']); const formatter = (await import('textlint-formatter-codecov')).default; const json = formatter(result.results); console.log(JSON.stringify(json));

Debug

Known issues

deprecatedPackage has not been updated in several years; may not work with latest textlint versions.

fix

Consider using textlint's built-in formatters or a maintained alternative.

affects: *

gotchaOutput format matches Codecov JSON coverage schema, not standard textlint formatters.

fix

Only use this formatter when piping to codecov.io or processing Codecov JSON.

affects: *

gotchaRequires textlint to be installed as a peer dependency.

fix

Ensure textlint is installed: npm install textlint

affects: *

Errors

Common errors & fixes

Error: Cannot find module 'textlint-formatter-codecov'

Package not installed or not in node_modules.

fix

Run npm install textlint-formatter-codecov --save-dev

TypeError: formatter is not a function

Incorrect import style; package uses default export.

fix

Use import formatter from 'textlint-formatter-codecov'

textlint: Unknown formatter: codecov

textlint cannot find the formatter module.

fix

Ensure textlint-formatter-codecov is installed globally or locally with correct spelling.

Upgrade

Version history

1.0.2latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

8 hits · last 30 days

node

Resources

githubhttps://github.com/azu/textlint-formatter-codecov ↗

packagetextlint-formatter-codecov ↗

homepagehttps://github.com/azu/textlint-formatter-codecov ↗