@sebastienrousseau/zig-config

v0.0.1

Published

19 hours ago

Shareable Zig configuration providing standardized Zig Language Server (ZLS) and build formatting rules adhering to modern 2026 standards.

0High
0Medium
0Low

sebastienrousseau

config zig-config zig zls build.zig.zon config

Getting started

Install — npm, pnpm, yarn, bun, source
Requirements — runtime floor, platform support
Quick Start — import and extend in seconds

The configuration ecosystem

The configuration ecosystem — @sebastienrousseau/config family map at a glance

Configuration reference

Why this approach? — design rationale and engineering principles
Modern Zig Language Server & Build Standards — before and after rule comparison
Module compatibility — dual CJS/ESM exports and TypeScript declarations

Operational

When not to use this configuration — boundaries and limitations
Development — make targets, validation, test suite
Security — supply chain, audit policies, commit integrity
Documentation — all reference docs
Stability guarantees — SemVer axis, deprecation window
Minimum-toolchain policy — runtime floor guarantees
License — dual license terms

Install

Using a package manager

Install @sebastienrousseau/zig-config as a development dependency:

# npm
npm install --save-dev @sebastienrousseau/zig-config

# pnpm
pnpm add -D @sebastienrousseau/zig-config

# yarn
yarn add -D @sebastienrousseau/zig-config

# bun
bun add -d @sebastienrousseau/zig-config

Build from source

git clone https://github.com/sebastienrousseau/zig-config.git
cd zig-config
make            # check + test

Requirements

Node.js 18.0.0 or newer. Every package manifest declares engines.node, and CI enforces the runtime floor on every push across macOS, Linux, and Windows.
npm 9.0.0 or newer (or modern pnpm / yarn / bun).
Module systems. Full native support for ECMAScript Modules (ESM) and CommonJS (CJS).
Target environment: Optimized for Zig 0.13+ / ZLS.

Quick Start

In `package.json`

{
  "zig": "@sebastienrousseau/zig-config"
}

In CommonJS Configuration

const config = require("@sebastienrousseau/zig-config");
module.exports = config;

In ES Module Configuration

import config from "@sebastienrousseau/zig-config";
export default config;

The configuration ecosystem

@sebastienrousseau/zig-config is a focused satellite of the @sebastienrousseau/config suite — a unified ecosystem of single-purpose, zero-overhead developer configurations designed to share a single design philosophy, strict typing, and zero runtime dependencies.

To adopt the complete suite with a single import, install the master meta-package:

npm install --save-dev @sebastienrousseau/config

Why this approach?

Configuration rot is one of the most common vectors for project decay. Ad-hoc tool configurations copied between repositories quickly drift, leaving security vulnerabilities unpatched, formatting rules inconsistent, and CI times bloated.

@sebastienrousseau/zig-config solves this with three deliberate engineering choices:

Zero Runtime Dependencies: The configuration contains only static, serialisable declarative definitions and clean programmatic adapters.
Dual CJS/ESM Architecture: Ships dedicated CommonJS (index.cjs) and ES Module (index.mjs) entrypoints alongside comprehensive TypeScript declarations (index.d.ts).
Deterministic Governance: Versioned strictly by +0.0.1 per release, cryptographically signed with published PGP keys, and audited continuously.

Modern Zig Language Server & Build Standards

Standardizes ZLS language server options, build.zig.zon package definitions, and deterministic zig fmt style guidelines.

Before (Unstandardized)

// zls.json
{}

After (@sebastienrousseau/zig-config Enforced)

// zls.json
{
  "$schema": "https://raw.githubusercontent.com/zigtools/zls/master/schema.json",
  "enable_autofix": true,
  "enable_snippets": true,
  "warn_style": true,
  "highlight_global_var_declarations": true
}

Module Compatibility

This package exports dual module entrypoints via package.json exports:

"exports": {
  ".": {
    "types": "./index.d.ts",
    "import": "./index.mjs",
    "require": "./index.cjs"
  }
}

Full TypeScript declarations (index.d.ts) are included out of the box, providing rich IDE autocomplete and JSDoc documentation inline.

When not to use this configuration

When compiling against legacy pre-0.11 Zig compilers with incompatible build runners or syntax.

Development

Contributors use a standard POSIX Makefile as the convention-based task runner:

git clone https://github.com/sebastienrousseau/zig-config.git
cd zig-config
make test

Security

Private Reporting: Report security vulnerabilities by emailing [email protected]. Expect an initial response within 48 hours and a mitigation plan within 7 days.
Commit Integrity: All commits on main and release tags are cryptographically signed.
Release Signing Key: The release-signing PGP key is published in KEYS.asc:
```
4B7F16C909C7A8EE9BED338A4F047EDF5F90F638
```
Signing key Sebastien Rousseau <[email protected]>, ed25519, expires 2028-08-16.
Supply Chain: Monitored continuously via Dependabot, CodeQL, and SLSA provenance. See SECURITY.md for details.

Documentation

Architecture — Architectural design, directory structure, and invariants.
Development Guide — Toolchain prerequisites, task reproduction, and CI gates.
Governance — Maintainer-led project model and decision-making framework.
Support Guide — Channels for help, bug reports, and feature requests.
Ecosystem Suite — The @sebastienrousseau/config family repository.

Stability guarantees

SemVer Discipline: Versioning increments strictly by +0.0.1 following the repository lifecycle standard.
Output Stability: A rule change that alters linting or formatting output in consumer code is treated as a notable breaking event, clearly documented in CHANGELOG.md.
Deprecation Window: Deprecated options or configurations remain supported for at least two release cycles before removal.

Minimum-toolchain policy

The minimum supported Node.js version is 18.0.0. The floor may raise only when:

An upstream LTS version reaches official End-of-Life (EOL).
The reason is explicitly recorded in CHANGELOG.md and DEVELOPMENT.md.

License

Dual-licensed under either:

Apache License, Version 2.0 (LICENSE-APACHE)
MIT License (LICENSE-MIT)

at your option.

SPDX-License-Identifier: Apache-2.0 OR MIT