@sebastienrousseau/sql-config

v0.0.7

Published

13 days ago

Shareable SQL configuration providing standardized SQLFluff and SQL formatter rules adhering to modern 2026 standards.

Downloads

293

0High
0Medium
0Low

sebastienrousseau

config sql-config sql sqlfluff postgres sql-formatter config

Getting started

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

Ecosystem

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

Configuration reference

Why this approach? — design rationale and engineering principles
Dialect-Aware SQLFluff Linting & Formatting — 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/sql-config as a development dependency:

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

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

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

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

Build from source

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

Requirements

Node.js 20.0.0 or newer. Declared in engines.node and proved on every push: the CI matrix runs Node 20, 22, 24 on Linux, macOS and Windows, and fails if the matrix floor and engines.node disagree.
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 SQLFluff / ANSI SQL.

Quick Start

This package ships configuration for a toolchain that does not resolve anything through node_modules. Install it to version and update the presets, then either copy them into place or pass their path to the tool.

Copy the presets into your project

cp node_modules/@sebastienrousseau/sql-config/.sqlfluff ./.sqlfluff
cp node_modules/@sebastienrousseau/sql-config/.sql-formatter.json ./.sql-formatter.json

Or point the tool at the installed file

sqlfluff lint --config node_modules/@sebastienrousseau/sql-config/.sqlfluff queries/

The configuration ecosystem

@sebastienrousseau/sql-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/sql-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.

Dialect-Aware SQLFluff Linting & Formatting

Enforces consistent uppercase SQL keywords, trailing commas, deterministic indentation, and syntax safety across ANSI, Postgres, MySQL, and SQLite.

Before (Unstandardized)

-- unformatted sql
select a,b from tbl where x=1

After (@sebastienrousseau/sql-config Enforced)

[sqlfluff]
dialect = ansi
max_line_length = 100
[sqlfluff:rules:capitalisation.keywords]
capitalisation_policy = upper
[sqlfluff:rules:capitalisation.identifiers]
capitalisation_policy = lower

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 working with proprietary, non-standard enterprise database dialects not parsed by SQLFluff.

Development

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

git clone https://github.com/sebastienrousseau/sql-config.git
cd sql-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.
Supply Chain: Monitored continuously via Dependabot, CodeQL, and SLSA provenance. See SECURITY.md for details.

4B7F16C909C7A8EE9BED338A4F047EDF5F90F638

Signing key Sebastien Rousseau <[email protected]>, ed25519, expires 2028-08-16.

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 20.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