feat: implement flag to suppress defaults warnings (#222)

* fix: remove warn logs for defaults

* Revert "fix: remove warn logs for defaults"

This reverts commit 901b09f.

* chore: implement suppress warnings tests

* feat: implement `suppressDefaultsWarning` flag

Author: selfire1

src/cli/drizzle-kit.ts

@@ -12,11 +12,13 @@ export const getDefaultConfig = async ({
   drizzleKitConfigPath,
   tsProject,
   debug,
+  suppressDefaultsWarning,
 }: {
   drizzleSchemaPath: string | undefined;
   drizzleKitConfigPath: string | undefined;
   tsProject: Project;
   debug?: boolean;
+  suppressDefaultsWarning?: boolean;
 }) => {
   const {drizzleSchemaPath: resolvedDrizzleSchemaPath, casing: drizzleCasing} =
     await getFullDrizzleSchemaFilePath({
@@ -36,6 +38,7 @@ export const getDefaultConfig = async ({
   const zeroSchema = drizzleZeroConfig(drizzleSchema, {
     casing: drizzleCasing ?? undefined,
     debug: Boolean(debug),
+    suppressDefaultsWarning: Boolean(suppressDefaultsWarning),
   });
 
   ensureSourceFileInProject({

src/cli/index.ts

@@ -64,6 +64,7 @@ export interface GeneratorOptions {
   skipDeclare?: boolean;
   enableLegacyMutators?: boolean;
   enableLegacyQueries?: boolean;
+  suppressDefaultsWarning?: boolean;
 }
 
 async function main(opts: GeneratorOptions = {}) {
@@ -81,6 +82,7 @@ async function main(opts: GeneratorOptions = {}) {
     skipDeclare,
     enableLegacyMutators,
     enableLegacyQueries,
+    suppressDefaultsWarning,
   } = {...opts};
 
   const resolvedTsConfigPath = tsConfigPath ?? defaultTsConfigFile;
@@ -127,6 +129,7 @@ async function main(opts: GeneratorOptions = {}) {
         drizzleKitConfigPath,
         tsProject,
         debug: Boolean(debug),
+        suppressDefaultsWarning: Boolean(suppressDefaultsWarning),
       });
 
   if (!result?.zeroSchema) {
@@ -216,6 +219,11 @@ function cli() {
       'Enable legacy CRUD queries (sets enableLegacyQueries to true)',
       false,
     )
+    .option(
+      '--suppress-defaults-warning',
+      'Hide warnings for columns with default values',
+      false,
+    )
     .action(async command => {
       console.log(`⚙️  drizzle-zero: Generating zero schema...`);
 
@@ -233,6 +241,7 @@ function cli() {
         skipDeclare: command.skipDeclare,
         enableLegacyMutators: command.enableLegacyMutators,
         enableLegacyQueries: command.enableLegacyQueries,
+        suppressDefaultsWarning: command.suppressDefaultsWarning,
       });
 
       if (command.output) {

src/relations.ts

@@ -321,6 +321,16 @@ const drizzleZeroConfig = <
      * ```
      */
     readonly debug?: boolean;
+    /**
+     * Whether to hide warnings for columns with default values.
+     *
+     * @example
+     * ```ts
+     * { suppressDefaultsWarning: true }
+     * ```
+     * @see https://github.com/rocicorp/drizzle-zero/issues/197
+     */
+    readonly suppressDefaultsWarning?: boolean;
   },
 ): Flatten<DrizzleToZeroSchema<TDrizzleSchema, TColumnConfig>> => {
   let tables: any[] = [];
@@ -377,6 +387,7 @@ const drizzleZeroConfig = <
         tableConfig,
         config?.debug,
         config?.casing,
+        config?.suppressDefaultsWarning,
       );
 
       tables.push(tableSchema);

src/tables.ts

@@ -214,6 +214,10 @@ const createZeroTableBuilder = <
    * The casing to use for the table name.
    */
   casing?: TCasing,
+  /**
+   * Whether to hide warnings for columns with default values.
+   */
+  suppressDefaultsWarning?: boolean,
 ): ZeroTableBuilder<TTableName, TTable, TColumnConfig> => {
   const actualTableName = getTableName(table);
   const tableColumns = getTableColumns(table);
@@ -310,7 +314,7 @@ const createZeroTableBuilder = <
       const hasServerDefault =
         column.hasDefault || typeof column.defaultFn !== 'undefined';
 
-      if (hasServerDefault) {
+      if (hasServerDefault && !suppressDefaultsWarning) {
         const warningKey = `${actualTableName}.${resolvedColumnName}`;
         if (!warnedServerDefaults.has(warningKey)) {
           warnedServerDefaults.add(warningKey);

tests/tables.test.ts

@@ -1957,6 +1957,59 @@ describe('tables', () => {
     expectTableSchemaDeepEqual(result.build()).toEqual(expected.build());
   });
 
+  describe('default value warnings', () => {
+    test('pg - should warn for columns with database defaults when suppressDefaultsWarning is not set', ({
+      expect,
+    }) => {
+      const consoleSpy = vi.spyOn(console, 'warn').mockImplementation(() => {});
+
+      const testTable = pgTable('test_defaults_warn', {
+        id: text().primaryKey(),
+        name: text().notNull().default('unnamed'),
+      });
+
+      createZeroTableBuilder('test_defaults_warn', testTable, {
+        id: true,
+        name: true,
+      });
+
+      expect(consoleSpy).toHaveBeenCalledWith(
+        expect.stringContaining(
+          '⚠️ drizzle-zero: Column test_defaults_warn.name uses a database default',
+        ),
+      );
+
+      consoleSpy.mockRestore();
+    });
+
+    test('pg - should not warn for columns with database defaults when suppressDefaultsWarning is true', ({
+      expect,
+    }) => {
+      const consoleSpy = vi.spyOn(console, 'warn').mockImplementation(() => {});
+
+      const testTable = pgTable('test_defaults_suppressed', {
+        id: text().primaryKey(),
+        name: text().notNull().default('unnamed'),
+      });
+
+      createZeroTableBuilder(
+        'test_defaults_suppressed',
+        testTable,
+        {
+          id: true,
+          name: true,
+        },
+        undefined, // debug
+        undefined, // casing
+        true, // suppressDefaultsWarning
+      );
+
+      expect(consoleSpy).not.toHaveBeenCalled();
+
+      consoleSpy.mockRestore();
+    });
+  });
+
   test('pg - no primary key', ({expect}) => {
     const testTable = pgTable('test', {
       id: text(),