Skip to content

refactor: mutualize header for generated files #3728

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
simolus3 merged 1 commit into from
Dec 23, 2025
+9 −8
Merged

refactor: mutualize header for generated files #3728

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions drift_dev/lib/src/cli/commands/schema/generate_utils.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import 'dart:io';

import 'package:args/command_runner.dart';
import 'package:drift_dev/src/utils/header.dart';
import 'package:path/path.dart' as p;
import 'package:collection/collection.dart';
import 'package:sqlparser/sqlparser.dart';
Expand Down Expand Up @@ -88,8 +89,6 @@ class GenerateUtilsCommand extends Command {

class GenerateUtils {
static String _filenameForVersion(int version) => 'schema_v$version.dart';
static const _prefix = '// GENERATED CODE, DO NOT EDIT BY HAND.\n'
'// ignore_for_file: type=lint';

/// Generates Dart code for a specific schema version.
static Future<String> generateSchemaCode(
Expand Down Expand Up @@ -126,7 +125,7 @@ class GenerateUtils {
// We need to use the core drift package without an import alias because it
// can be referenced in snippets that are part of the schema files.
writer.leaf()
..writeln(_prefix)
..writeln(generatedHeader)
..writeln("import 'package:drift/drift.dart';");

final database = DriftDatabase(
Expand Down Expand Up @@ -161,7 +160,7 @@ class GenerateUtils {
static Future<String> generateLibraryCode(
DriftDevCli cli, Iterable<int> versions) async {
final buffer = StringBuffer()
..writeln(_prefix)
..writeln(generatedHeader)
..writeln("import 'package:drift/drift.dart';")
..writeln("import 'package:drift/internal/migrations.dart';");

Expand Down
4 changes: 4 additions & 0 deletions drift_dev/lib/src/utils/header.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
const String generatedHeader = '''
// GENERATED BY drift_dev, DO NOT MODIFY.
// ignore_for_file: type=lint,unused_import
// ''';
6 changes: 2 additions & 4 deletions drift_dev/lib/src/writer/schema_version_writer.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import 'package:collection/collection.dart';
import 'package:drift/drift.dart' show DriftSqlType;
import 'package:drift_dev/src/utils/header.dart';
import 'package:sqlparser/sqlparser.dart' as sql;
import 'package:sqlparser/utils/node_to_text.dart';

Expand Down Expand Up @@ -347,10 +348,7 @@ class SchemaVersionWriter {
}

void write() {
libraryScope.leaf()
..writeln('// ignore_for_file: type=lint,unused_import')
..writeln('// GENERATED BY drift_dev, DO NOT MODIFY.');

libraryScope.leaf().writeln(generatedHeader);
// There is no need to generate schema classes for the first version, we
// only need them for versions targeted by migrations.
for (final version in versions.skip(1)) {
Expand Down
Loading