[S] Stop requiring defaults for @ignored relation fields. (#684)

Fixes #683

---------

Co-authored-by: Sean Nicolay <sean@nicolay.dev>

Author: maxh

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 0.10.2 (2025-05-24)
+
+- [#683](https://github.com/loop-payments/prisma-lint/issues/683) Stop requiring defaults for `@ignored` relation fields.
+
 ## 0.10.1 (2025-04-30)
 
 - [#622](https://github.com/loop-payments/prisma-lint/issues/662) Require case-sensitive compound word match for snake case conversion. Fixes bug introduced in `0.10.0`.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "prisma-lint",
-  "version": "0.10.1",
+  "version": "0.10.2",
   "description": "A linter for Prisma schema files.",
   "repository": {
     "type": "git",

src/common/prisma.ts

@@ -121,3 +121,13 @@ export function assertValueIsStringArray(value: Value): Array<string> {
 
   throw new Error(`value is not a string array ${JSON.stringify(value)}`);
 }
+
+export function looksLikeAssociationFieldType(fieldType: any) {
+  if (typeof fieldType != 'string') {
+    return false;
+  }
+  if (PRISMA_SCALAR_TYPES.has(fieldType)) {
+    return false;
+  }
+  return true;
+}

src/rules/field-name-mapping-snake-case.ts

@@ -3,7 +3,10 @@ import type { Attribute } from '@mrleebo/prisma-ast';
 import { z } from 'zod';
 
 import { getRuleIgnoreParams } from '#src/common/ignore.js';
-import { PRISMA_SCALAR_TYPES, getMappedName } from '#src/common/prisma.js';
+import {
+  getMappedName,
+  looksLikeAssociationFieldType,
+} from '#src/common/prisma.js';
 import type { FieldRuleDefinition } from '#src/common/rule.js';
 import { toSnakeCase } from '#src/common/snake-case.js';
 
@@ -132,7 +135,7 @@ export default {
         if (
           !isEnumField(context.enumNames, fieldType) &&
           !isCustomTypeField(context.customTypeNames, fieldType) &&
-          looksLikeAssociation(fieldType)
+          looksLikeAssociationFieldType(fieldType)
         ) {
           return;
         }
@@ -193,16 +196,6 @@ function findMapAttribute(attributes: Attribute[]): Attribute | undefined {
   return filtered[0];
 }
 
-function looksLikeAssociation(fieldType: any) {
-  if (typeof fieldType != 'string') {
-    return false;
-  }
-  if (PRISMA_SCALAR_TYPES.has(fieldType)) {
-    return false;
-  }
-  return true;
-}
-
 function isAllLowerCase(s: string) {
   return s.toLowerCase() == s;
 }

src/rules/forbid-required-ignored-field.test.ts

@@ -17,6 +17,26 @@ describe('forbid-required-ignored-field', () => {
   describe('forbidding', () => {
     const run = getRunner();
 
+    describe('with ignored relation-only field', () => {
+      it('returns no violations', async () => {
+        const violations = await run(`
+      model User {
+        id    Int    @id @default(autoincrement())
+        posts Post[] @ignore
+      }
+      
+      model Post {
+        id       Int  @id @default(autoincrement())
+        author   User @relation(fields: [authorId], references: [id])
+        authorId Int 
+        title String
+        @@ignore 
+      }
+    `);
+        expect(violations.length).toEqual(0);
+      });
+    });
+
     describe('with optional ignored field', () => {
       it('returns no violations', async () => {
         const violations = await run(`

src/rules/forbid-required-ignored-field.ts

@@ -1,5 +1,6 @@
 import { z } from 'zod';
 
+import { looksLikeAssociationFieldType } from '#src/common/prisma.js';
 import type { FieldRuleDefinition } from '#src/common/rule.js';
 
 const RULE_NAME = 'forbid-required-ignored-field';
@@ -50,6 +51,9 @@ export default {
         if (!isIgnored || hasDefault) return;
         const isRequired = !field.optional;
         if (!isRequired) return;
+        if (looksLikeAssociationFieldType(field.fieldType)) {
+          return;
+        }
         const message =
           'Do not ignore a required field without a default value.';
         context.report({ model, field, message });