@sebastienrousseau/c8-config

What is @sebastienrousseau/c8-config?

@sebastienrousseau/c8-config is an enterprise-grade, shareable configuration for c8—the zero-instrumentation native V8 code coverage tool for Node.js. Designed to deliver vetted, deterministic defaults, this package eliminates manual setup boilerplate and establishes rigorous code quality standards across modern software development pipelines.

By adopting this configuration, engineering teams ensure unified consistency across local development, continuous integration, and automated deployments. The package adheres strictly to the OpenSSF Best Practices badge program (ID: 14506) and achieves top-tier security ratings via Scorecard audits.

Explore the complete Installation Guide, review the comprehensive Usage Documentation, inspect the API Reference, or discover AI integrations via the Model Context Protocol (MCP).

Why Developers Choose @sebastienrousseau/c8-config

Modern JavaScript and TypeScript repositories frequently suffer from configuration drift, fragmented standards, and maintenance overhead. @sebastienrousseau/c8-config directly solves these challenges:

• Battle-Tested Standards: Curated rules engineered for high maintainability, deterministic builds, and defect prevention.
• Zero Runtime Dependencies: The package adds exactly zero runtime dependencies to your production bundle, eliminating supply-chain attack vectors.
• Dual Module Compatibility: Out-of-the-box support for both ECMAScript Modules (import) and CommonJS (require).
• TypeScript Type Safety: Bundled TypeScript definitions ensure all configuration objects and functions validate under strict tsc checks.
• Enterprise Security & Supply Chain Defense: Cryptographically signed commits and automated OpenSSF Scorecard auditing, SLSA Provenance generation, and continuous CodeQL security scanning.

How to Get Started in 3 Steps

Integrating @sebastienrousseau/c8-config into any new or existing repository requires only three simple steps.

Step 1: Install the Package

Install the configuration as a development dependency using your preferred package manager:

# Using npm
npm install --save-dev @sebastienrousseau/c8-config

# Using pnpm
pnpm add -D @sebastienrousseau/c8-config

# Using yarn
yarn add -D @sebastienrousseau/c8-config

For advanced package manager configurations and offline workflows, consult our Installation Guide.

Step 2: Configure .c8rc.json

Create or update your .c8rc.json file at the root of your project to extend the shared configuration:

{
  "extends": "@sebastienrousseau/c8-config"
}

Learn how to customize specific rules and override settings in the Usage Guide.

Step 3: Run c8 in Your Workflow

Execute c8 directly or configure standard quality scripts in your package.json:

c8 npm test

Execute test suite with native V8 code coverage analysis and text/HTML summary generation.

Key Features & Architecture

For a detailed breakdown of all exported configuration files and schema fields, visit the Reference Guide.

Frequently Asked Questions (FAQ)

Why choose c8 over traditional Istanbul/nyc?

c8 extracts coverage metrics directly from Node.js's built-in V8 engine without instrumenting source code, resulting in dramatically faster test executions and 100% accurate source maps.

Can I override individual rules in my project?

Yes. Every configuration allows local overrides directly within your .c8rc.json file or inline settings. Detailed override recipes are documented in the Usage Guide.

Is @sebastienrousseau/c8-config safe for production CI/CD?

Yes. The package complies with OpenSSF Best Practices criteria, carries an active OpenSSF Scorecard audit, and contains zero runtime dependencies. Every release undergoes continuous automated regression testing and CodeQL analysis.

How does this package support AI and agentic workflows?

The project includes a Model Context Protocol (MCP) configuration, enabling LLM coding assistants and AI agents to understand, validate, and execute repository configuration tasks autonomously.