eslint-plugin-prisma-soft-delete

Introduction

This eslint plugin is used to force developers to use { deleted: null } filter in where query.

Motivation

Prisma does have easy support for implementing soft delete but it is not as neat as other ORMs out there. You can follow this guide to implement soft-delete using Prisma. The problem is you have to add { deleted: null } filter explicitly when querying for data. It is very easy to make mistakes for new teammates if it goes without review in big teams. Hence this plugin.

Installation

npm

npm i -D eslint-plugin-prisma-soft-delete

yarn

yarn add -D eslint-plugin-prisma-soft-delete

// .eslintrc
module.exports = {
  plugins: [
    ...
    "prisma-soft-delete",
  ],
  rules: {
    ...
    'prisma-soft-delete/use-deleted-null': 'error',
  },
}

How to turn off rules from this plugin

// .eslintrc
module.exports = {
  plugins: [
    ...
    "prisma-soft-delete",
  ],
  rules: {
    ...
    'prisma-soft-delete/use-deleted-null': 'off',
  },
}

Rules

prisma-soft-delete/use-deleted-null

// bad
const user = await this.prisma.user.findFirst({
    where: { id: 1 },
});

// good
const user = await this.prisma.user.findFirst({
    where: { deleted: null, id: 1 },
});

From author

Feel free to create an issue on Github if you face any problems or want any enhancements to this plugin.