Registry / database / eslint-plugin-safe-kysely

eslint-plugin-safe-kysely

library1.0.1jsnpmunverified

eslint-plugin-safe-kysely is an ESLint plugin designed to improve data safety in applications utilizing the Kysely query builder. Currently at version 1.0.1, this plugin enforces the inclusion of a `where` clause in all `updateTable` and `deleteFrom` Kysely call chains. Its primary goal is to prevent accidental mass data modification or deletion of entire tables by requiring explicit targeting of rows for such operations. Unlike runtime checks, this plugin performs static analysis during development, providing immediate feedback through ESLint warnings or errors before code is deployed. This ensures that potentially destructive database queries are identified and corrected early in the development lifecycle, significantly reducing the risk of data loss. While a specific release cadence is not yet established for this relatively new plugin, its initial stable release indicates a commitment to Kysely ecosystem safety. It differentiates itself by offering Kysely-specific static analysis for a critical aspect of database interaction.

database testing

npm install eslint-plugin-safe-kysely

package ↗

INSTALL

IMPORT

SIG · ESLINT-PLUGIN-SAFE

eslint-plugin-safe-kysely

databasejavascriptv1.0.1

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

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

Plugin Registration (JSON Config)

✓ { "plugins": ["safe-kysely"], "rules": { "safe-kysely/enforce-where-clause": "error" } }

ESLint plugins are activated by listing their short name (without the `eslint-plugin-` prefix) in the `plugins` array of your `.eslintrc.json` file. Rules are then enabled under the `rules` section, prefixed with the plugin name.

Plugin Object (JavaScript Config)

✓ const safeKyselyPlugin = require('eslint-plugin-safe-kysely'); module.exports = { plugins: [safeKyselyPlugin], rules: { "safe-kysely/enforce-where-clause": "error" } };

✗ import safeKyselyPlugin from 'eslint-plugin-safe-kysely'; // CommonJS 'require' is typically used for .eslintrc.js

For JavaScript-based ESLint configurations (`.eslintrc.js`), the plugin module can be directly `require`d and passed as an object into the `plugins` array.

Rule Configuration (Specific Options)

✓ "safe-kysely/enforce-where-clause": ["error", { /* optional specific rule settings */ }]

✗ "enforce-where-clause": "error" // Missing plugin name prefix

Individual rules provided by plugins must always be prefixed with the plugin's registered name (e.g., `safe-kysely/rule-name`) when enabling them in the `rules` section.

Demonstrates the installation of the plugin, ESLint configuration to enable the rule, and a Kysely update operation that correctly includes a `where` clause, satisfying the `enforce-where-clause` rule.

npm install eslint --save-dev npm install eslint-plugin-safe-kysely --save-dev # .eslintrc.json { "env": { "node": true, "es2021": true }, "extends": [ "eslint:recommended" ], "parserOptions": { "ecmaVersion": "latest", "sourceType": "module" }, "plugins": [ "safe-kysely" ], "rules": { "safe-kysely/enforce-where-clause": "error" } } // example.ts (assuming Kysely and database client setup) import { Kysely, PostgresDialect } from 'kysely'; import { Pool } from 'pg'; interface Database { person: { id: string; first_name: string; last_name: string; age: number; }; } const db = new Kysely<Database>({ dialect: new PostgresDialect({ pool: new Pool({ connectionString: process.env.DATABASE_URL ?? 'postgresql://user:password@host:port/database', }), }), }); async function updatePersonAge(id: string, newAge: number) { // This operation is valid as it includes a .where() clause await db .updateTable('person') .set({ age: newAge }) .where('id', '=', id) .execute(); console.log(`Person ${id} age updated to ${newAge}.`); } // Example of an invalid operation (would be flagged by ESLint) // await db.updateTable('person').set({ age: 0 }).execute(); updatePersonAge('123', 30);

Debug

Known issues

gotchaForgetting to add `safe-kysely` to the `plugins` array in your ESLint configuration will prevent the rule from being recognized or applied.

fix

Ensure `"safe-kysely"` is included in the `plugins` array in your `.eslintrc.json` or `.eslintrc.js` file.

affects: >=1.0.0

gotchaWhen enabling rules from `eslint-plugin-safe-kysely`, you must prefix the rule name with `safe-kysely/`. Omitting this prefix (e.g., just `enforce-where-clause`) will result in ESLint not finding the rule.

fix

Always use the full rule identifier, such as `"safe-kysely/enforce-where-clause": "error"`.

affects: >=1.0.0

gotchaThis plugin specifically targets `updateTable` and `deleteFrom` methods for `where` clause enforcement. It does not provide checks for other potentially unsafe Kysely operations, such as raw SQL queries or complex builder patterns outside of its defined scope.

fix

Supplement this plugin with manual code reviews or additional static analysis tools for comprehensive database query safety beyond `updateTable` and `deleteFrom`.

affects: >=1.0.0

Errors

Common errors & fixes

ESLint: Definition for rule 'safe-kysely/enforce-where-clause' was not found

The `eslint-plugin-safe-kysely` package is not installed, or it's not listed in the `plugins` array of your ESLint configuration.

fix

Run `npm install eslint-plugin-safe-kysely --save-dev` and ensure `"safe-kysely"` is added to the `plugins` array in your `.eslintrc.json` or `.eslintrc.js` file.

Missing `where` clause with updateTable (or Missing `where` clause with deleteFrom)

An `updateTable` or `deleteFrom` operation is attempted without a subsequent `.where()` call in the Kysely query builder chain.

fix

Add a `.where()` method call to your Kysely query chain to specify the rows to be affected, e.g., `.where('id', '=', 1)` or `.where({ foo: 'bar' })`.

Upgrade

Version history

1.0.1latest on npm

Audit

Dependencies

eslintrequiredRequired peer dependency for ESLint configuration and execution.

Agent activity

8 hits · last 30 days

node

Resources

packagehttps://www.npmjs.com/package/eslint-plugin-safe-kysely ↗