feat: Create code gen for design tokens (#521)

tilucasoli · web-flow · commit f6107b190a45 · 2024-11-26T13:19:08.000-03:00
* generate color token

* checkpoint1

* annotation improvements

* improve the SwatchColorToken

* Update mixable_tokens_generator.dart

* Update mixable_tokens_generator.dart

* improve tests

* Update lints_with_dcm.yaml

* remove token from example

* clean PR
diff --git a/examples/todo_list/lib/pages/todo_list_page.dart b/examples/todo_list/lib/pages/todo_list_page.dart
@@ -66,14 +66,18 @@ class _TodoListPageState extends State<TodoListPage> {
         onPressed: () {
           Future.delayed(
             const Duration(milliseconds: 200),
-            () => Navigator.push(
-              context,
-              MaterialPageRoute(
-                builder: (context) => AddTaskPage(
-                  controller: _controller,
-                ),
-              ),
-            ),
+            () {
+              if (mounted) {
+                Navigator.push(
+                  context,
+                  MaterialPageRoute(
+                    builder: (context) => AddTaskPage(
+                      controller: _controller,
+                    ),
+                  ),
+                );
+              }
+            },
           );
         },
       ),
diff --git a/examples/todo_list/pubspec.yaml b/examples/todo_list/pubspec.yaml
@@ -12,17 +12,22 @@ environment:
 dependencies:
   flutter:
     sdk: flutter
-  mix: 
+  mix:
     path: ../../packages/mix
+  mix_annotations:
+    path: ../../packages/mix_annotations
   custom_lint: ^0.6.4
-  google_fonts: ^6.0.0 
+  google_fonts: ^6.0.0
 
   cupertino_icons: ^1.0.6
 
 dev_dependencies:
+  mix_generator:
+    path: ../../packages/mix_generator
+  build_runner:
   flutter_test:
     sdk: flutter
-  mix_lint: 
+  mix_lint:
     path: ../../packages/mix_lint
 
   flutter_lints: ^4.0.0
diff --git a/lints_with_dcm.yaml b/lints_with_dcm.yaml
@@ -12,8 +12,9 @@ dart_code_metrics:
     # avoid-collection-mutating-methods: true
     newline-before-return: true
     avoid-importing-entrypoint-exports:
-        only-in-src: true
+      only-in-src: true
     prefer-match-file-name: false
+    avoid-suspicious-super-overrides: false
     prefer-overriding-parent-equality: false
     prefer-correct-callback-field-name: false
     prefer-single-widget-per-file: false
@@ -33,21 +34,21 @@ dart_code_metrics:
         - child
         - children
     avoid-nested-conditional-expressions:
-        acceptable-level: 3
+      acceptable-level: 3
     member-ordering:
-        order:
-          - public-fields
-          - private-fields
-          - constructors
-          - static-methods
-          - private-methods
-          - private-getters
-          - private-setters
-          - public-getters
-          - public-setters
-          - public-methods
-          - overridden-public-methods
-          - overridden-public-getters
-          - build-method
+      order:
+        - public-fields
+        - private-fields
+        - constructors
+        - static-methods
+        - private-methods
+        - private-getters
+        - private-setters
+        - public-getters
+        - public-setters
+        - public-methods
+        - overridden-public-methods
+        - overridden-public-getters
+        - build-method
     prefer-named-boolean-parameters:
-      ignore-single: true
+      ignore-single: true
diff --git a/packages/mix/lib/src/theme/tokens/text_style_token.dart b/packages/mix/lib/src/theme/tokens/text_style_token.dart
@@ -1,4 +1,3 @@
-//ignore_for_file: avoid-suspicious-super-overrides
 import 'package:flutter/widgets.dart';
 
 import '../../internal/mix_error.dart';
diff --git a/packages/mix_annotations/lib/src/annotations.dart b/packages/mix_annotations/lib/src/annotations.dart
@@ -248,3 +248,24 @@ class MixDeprecatedRenamed extends MixDeprecated {
     required this.updatedName,
   });
 }
+
+class MixableToken {
+  final Object type;
+  final String? namespace;
+  final bool utilityExtension;
+  final bool contextExtension;
+
+  const MixableToken(
+    this.type, {
+    this.namespace,
+    this.utilityExtension = true,
+    this.contextExtension = true,
+  });
+}
+
+class MixableSwatchColorToken {
+  final int scale;
+  final int defaultValue;
+
+  const MixableSwatchColorToken({this.scale = 3, this.defaultValue = 1});
+}
diff --git a/packages/mix_generator/build.yaml b/packages/mix_generator/build.yaml
@@ -2,7 +2,7 @@ targets:
   $default:
     builders:
       spec:
-        enabled: true 
+        enabled: true
         generate_for:
           exclude:
             - test
@@ -14,33 +14,39 @@ targets:
             - test
             - example
 
-
 builders:
   spec:
     import: "package:mix_generator/mix_generator.dart"
     builder_factories: ["specDefinition"]
-    build_extensions: {".dart": ["spec.g.part"]}
+    build_extensions: { ".dart": ["spec.g.part"] }
     auto_apply: dependents
     build_to: cache
     applies_builders: ["source_gen|combining_builder"]
   dto:
     import: "package:mix_generator/mix_generator.dart"
     builder_factories: ["dtoDefinition"]
-    build_extensions: {".dart": ["dto.g.part"]}
+    build_extensions: { ".dart": ["dto.g.part"] }
     auto_apply: dependents
     build_to: cache
     applies_builders: ["source_gen|combining_builder"]
   enum_utility:
     import: "package:mix_generator/mix_generator.dart"
     builder_factories: ["enumUtilityDefinition"]
-    build_extensions: {".dart": ["enum_utility.g.part"]}
+    build_extensions: { ".dart": ["enum_utility.g.part"] }
     auto_apply: dependents
     build_to: cache
     applies_builders: ["source_gen|combining_builder"]
   class_utility:
     import: "package:mix_generator/mix_generator.dart"
     builder_factories: ["classUtilityDefinition"]
-    build_extensions: {".dart": ["class_utility.g.part"]}
+    build_extensions: { ".dart": ["class_utility.g.part"] }
+    auto_apply: dependents
+    build_to: cache
+    applies_builders: ["source_gen|combining_builder"]
+  tokens:
+    import: "package:mix_generator/mix_generator.dart"
+    builder_factories: ["tokensDefinition"]
+    build_extensions: { ".dart": ["tokens.g.part"] }
     auto_apply: dependents
     build_to: cache
     applies_builders: ["source_gen|combining_builder"]
diff --git a/packages/mix_generator/lib/mix_generator.dart b/packages/mix_generator/lib/mix_generator.dart
@@ -1,11 +1,13 @@
 // ignore_for_file: avoid-unused-parameters
 
 import 'package:build/build.dart';
+import 'package:source_gen/source_gen.dart';
+
 import 'src/mixable_class_utility_generator.dart';
 import 'src/mixable_dto_generator.dart';
 import 'src/mixable_enum_utility_generator.dart';
 import 'src/mixable_spec_generator.dart';
-import 'package:source_gen/source_gen.dart';
+import 'src/mixable_tokens_generator.dart';
 
 Builder specDefinition(BuilderOptions options) => SharedPartBuilder(
       [const MixableSpecGenerator()],
@@ -30,3 +32,9 @@ Builder enumUtilityDefinition(BuilderOptions options) => SharedPartBuilder(
       'enum_utility',
       allowSyntaxErrors: true,
     );
+
+Builder tokensDefinition(BuilderOptions options) => SharedPartBuilder(
+      [const MixableTokensGenerator()],
+      'tokens',
+      allowSyntaxErrors: true,
+    );
diff --git a/packages/mix_generator/lib/src/builders/dto/class_utility.dart b/packages/mix_generator/lib/src/builders/dto/class_utility.dart
@@ -20,24 +20,25 @@ String utilityClass(ClassBuilderContext context) {
 
   final instance = ClassInfo(
     name: utilityName,
-    fields: context.fields,
+    fields: context.constructorParameters,
     extendsType: extendsType,
     genericTypes: {'T extends Attribute'},
   );
 
   final className = instance.name;
 
-  final fields = generateUtilityFields(attributeName, context.fields);
+  final fields =
+      generateUtilityFields(attributeName, context.constructorParameters);
 
   final onlyMethod = utilityMethodOnlyBuilder(
     utilityType: attributeName,
-    fields: context.fields,
+    fields: context.constructorParameters,
   );
 
   final valueClassFields = generateUtilityFieldsFromClass(context.classElement);
 
   final callMethodDefinition =
-      isDto ? utilityMethodCallBuilder(context.fields) : '';
+      isDto ? utilityMethodCallBuilder(context.constructorParameters) : '';
 
   final chainGetterDefinition = isDto
       ? ''
diff --git a/packages/mix_generator/lib/src/builders/dto/extension_value.dart b/packages/mix_generator/lib/src/builders/dto/extension_value.dart
@@ -13,7 +13,7 @@ String toRefTypeExtension(ClassBuilderContext<MixableDto> context) {
     params[element.name] = ParameterInfo.ofElement(element);
   });
 
-  final fieldStatements = context.fields.map((field) {
+  final fieldStatements = context.constructorParameters.map((field) {
     final fieldName = field.name;
 
     if (field.hasDto) {
diff --git a/packages/mix_generator/lib/src/builders/spec/class_attribute_spec.dart b/packages/mix_generator/lib/src/builders/spec/class_attribute_spec.dart
@@ -1,9 +1,10 @@
 import 'package:mix_annotations/mix_annotations.dart';
+
+import '../../helpers/field_info.dart';
 import '../method_debug_fill_properties.dart';
 import '../method_equality.dart';
 import '../method_merge.dart';
 import '../method_resolve.dart';
-import '../../helpers/field_info.dart';
 
 String specAttributeClass(ClassBuilderContext<MixableSpec> context) {
   final specName = context.name;
@@ -13,7 +14,7 @@ String specAttributeClass(ClassBuilderContext<MixableSpec> context) {
 
   final attributeInstance = ClassInfo(
     name: context.attributeName,
-    fields: context.fields,
+    fields: context.constructorParameters,
     isBase: specInstance.isBase,
     isFinal: specInstance.isFinal,
     mixinTypes: hasDiagnosticable ? {'Diagnosticable'} : {},
diff --git a/packages/mix_generator/lib/src/helpers/annotation_helpers.dart b/packages/mix_generator/lib/src/helpers/annotation_helpers.dart
@@ -1,12 +1,13 @@
 import 'package:analyzer/dart/constant/value.dart';
 import 'package:analyzer/dart/element/element.dart';
 import 'package:mix_annotations/mix_annotations.dart';
-import 'dart_type_ext.dart';
 import 'package:source_gen/source_gen.dart';
 
+import 'dart_type_ext.dart';
+
 const _specChecker = TypeChecker.fromRuntime(MixableSpec);
 const _utilityChecker = TypeChecker.fromRuntime(MixableUtility);
-
+const _tokenChecker = TypeChecker.fromRuntime(MixableToken);
 MixableSpec readMixableSpec(ClassElement classElement) {
   final annotation = _specChecker.firstAnnotationOfExact(classElement);
 
@@ -109,3 +110,25 @@ MixableFieldDto? _getMixableDto(ConstantReader? reader) {
 
   return MixableFieldDto(type: reader.typeAsString);
 }
+
+MixableToken readMixableToken(ClassElement element) {
+  final annotation = _tokenChecker.firstAnnotationOfExact(element);
+
+  if (annotation == null) {
+    throw InvalidGenerationSource(
+      'No MixableToken annotation found on the class',
+      element: element,
+    );
+  }
+  final reader = ConstantReader(annotation);
+  final type = reader.read('type').typeValue;
+
+  return MixableToken(
+    type,
+    namespace: reader.read('namespace').isNull
+        ? null
+        : reader.read('namespace').stringValue,
+    utilityExtension: reader.read('utilityExtension').boolValue,
+    contextExtension: reader.read('contextExtension').boolValue,
+  );
+}
diff --git a/packages/mix_generator/lib/src/helpers/builder_utils.dart b/packages/mix_generator/lib/src/helpers/builder_utils.dart
@@ -131,6 +131,19 @@ extension EnumElementX on EnumElement {
   }
 }
 
+class TokenAnnotationContext extends AnnotationContext {
+  final Object? type;
+
+  TokenAnnotationContext({
+    required super.element,
+    required this.type,
+  });
+
+  String get name => element.name;
+
+  String get generatedName => element.generatedName;
+}
+
 extension ClassElementX on ClassElement {
   bool get isConst => unnamedConstructor?.isConst ?? false;
 
diff --git a/packages/mix_generator/lib/src/helpers/field_info.dart b/packages/mix_generator/lib/src/helpers/field_info.dart
diff --git a/packages/mix_generator/lib/src/mixable_spec_generator.dart b/packages/mix_generator/lib/src/mixable_spec_generator.dart
diff --git a/packages/mix_generator/lib/src/mixable_tokens_generator.dart b/packages/mix_generator/lib/src/mixable_tokens_generator.dart
diff --git a/packages/mix_generator/pubspec.yaml b/packages/mix_generator/pubspec.yaml

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-//ignore_for_file: avoid-suspicious-super-overrides`
`2`	`1`	`import 'package:flutter/widgets.dart';`
`3`	`2`
`4`	`3`	`import '../../internal/mix_error.dart';`