Merge pull request #1174 from nextcloud/feat/dynamite/per_spec_config

feat(dynamite): allow per spec configuration

packages/dynamite/dynamite/README.md

@@ -53,6 +53,13 @@ targets:
             - 'factory .*\.fromJson\(Map<String, dynamic> json\) => jsonSerializers\.deserializeWith\(serializer, json\)!;'
             - 'Map<String, dynamic> toJson\(\) => jsonSerializers\.serializeWith\(serializer, this\)! as Map<String, dynamic>;'
             - 'static BuiltSet<.*> get values => _\$.*Values;'
+          overrides:
+            # Tighten linting rules for specific specs
+            # Mark the generated library as experimental
+            lib/my_spec.openapi.json:
+              analyzer_ignores:
+                - camel_case_types
+              experimental: true
 
 ```
 

packages/dynamite/dynamite/lib/src/models/dynamite_config/config.dart

@@ -33,6 +33,66 @@ abstract class DynamiteConfig implements Built<DynamiteConfig, DynamiteConfigBui
 
   /// The specified line with the formatter should use.
   int? get pageWidth;
+
+  /// A collection of dynamite configs for a specific file.
+  ///
+  /// This parameter is only supported for the top level config.
+  // overrides is reserved in the build.yaml
+  BuiltMap<String, DynamiteConfig>? get overrides;
+
+  /// Whether the generated library should be marked with the `@experimental` annotation.
+  bool get experimental;
+
+  @BuiltValueHook(initializeBuilder: true)
+  static void _defaults(final DynamiteConfigBuilder b) {
+    b.experimental ??= false;
+  }
+
+  /// Gets the config for the given [uri].
+  ///
+  /// Returns this if no override is set.
+  DynamiteConfig configFor(final String uri) {
+    if (overrides == null) {
+      return this;
+    }
+
+    DynamiteConfig? override;
+    for (final entry in overrides!.entries) {
+      if (entry.key == uri) {
+        override = entry.value;
+        break;
+      }
+    }
+
+    if (override == null) {
+      return this;
+    }
+
+    return merge(override);
+  }
+
+  /// Merges `this` config with the given [override].
+  ///
+  /// Throws a [ArgumentError] if the override has overrides itself.
+  DynamiteConfig merge(final DynamiteConfig other) {
+    if (other.overrides != null) {
+      throw ArgumentError('Configs can only be merged with a config that does not have further overrides');
+    }
+
+    return rebuild((final b) {
+      final analyzerIgnores = other.analyzerIgnores;
+      if (analyzerIgnores != null) {
+        b.analyzerIgnores.replace(analyzerIgnores);
+      }
+
+      final coverageIgnores = other.coverageIgnores;
+      if (coverageIgnores != null) {
+        b.coverageIgnores.replace(coverageIgnores);
+      }
+
+      b.experimental = other.experimental;
+    });
+  }
 }
 
 @SerializersFor([

packages/dynamite/dynamite/lib/src/openapi_builder.dart

@@ -50,15 +50,15 @@ class OpenAPIBuilder implements Builder {
       }
     }
 
-    try {
-      final inputId = buildStep.inputId;
-      final outputId = inputId.changeExtension('.dart');
+    final inputId = buildStep.inputId;
+    final outputId = inputId.changeExtension('.dart');
 
-      final emitter = DartEmitter(
-        orderDirectives: true,
-        useNullSafetySyntax: true,
-      );
+    final emitter = DartEmitter(
+      orderDirectives: true,
+      useNullSafetySyntax: true,
+    );
 
+    try {
       final spec = switch (inputId.extension) {
         '.json' => openapi.serializers.deserializeWith(
             openapi.OpenAPI.serializer,
@@ -76,7 +76,8 @@ class OpenAPIBuilder implements Builder {
         throw Exception('Only OpenAPI between $minSupportedVersion and $maxSupportedVersion are supported.');
       }
 
-      final state = State(buildConfig);
+      final config = buildConfig.configFor(inputId.path);
+      final state = State(config);
 
       final output = Library((final b) {
         final analyzerIgnores = state.buildConfig.analyzerIgnores;
@@ -114,6 +115,12 @@ class OpenAPIBuilder implements Builder {
             Directive.part(p.basename(outputId.changeExtension('.g.dart').path)),
           );
         }
+
+        if (state.buildConfig.experimental) {
+          b.annotations.add(
+            refer('experimental'),
+          );
+        }
       });
 
       var outputString = output.accept(emitter).toString();

packages/nextcloud/build.yaml

@@ -18,3 +18,10 @@ targets:
             - 'factory .*\.fromJson\(Map<String, dynamic> json\) => jsonSerializers\.deserializeWith\(serializer, json\)!;'
             - 'Map<String, dynamic> toJson\(\) => jsonSerializers\.serializeWith\(serializer, this\)! as Map<String, dynamic>;'
             - 'static BuiltSet<.*> get values => _\$.*Values;'
+          overrides:
+            lib/src/api/news.openapi.json:
+              experimental: true
+            lib/src/api/notes.openapi.json:
+              experimental: true
+            lib/src/api/uppush.openapi.json:
+              experimental: true

packages/nextcloud/lib/src/api/news.openapi.dart

@@ -2,6 +2,7 @@
 // ignore_for_file: no_leading_underscores_for_local_identifiers
 // ignore_for_file: public_member_api_docs, unreachable_switch_case
 
+@experimental
 library news_openapi;
 
 import 'package:built_collection/built_collection.dart';

packages/nextcloud/lib/src/api/notes.openapi.dart

@@ -2,6 +2,7 @@
 // ignore_for_file: no_leading_underscores_for_local_identifiers
 // ignore_for_file: public_member_api_docs, unreachable_switch_case
 
+@experimental
 library notes_openapi;
 
 import 'dart:convert';

packages/nextcloud/lib/src/api/uppush.openapi.dart

@@ -2,6 +2,7 @@
 // ignore_for_file: no_leading_underscores_for_local_identifiers
 // ignore_for_file: public_member_api_docs, unreachable_switch_case
 
+@experimental
 library uppush_openapi;
 
 import 'package:built_collection/built_collection.dart';