feat: add class annotation for component code generators

2023-02-06 18:41:54 +01:00
parent c70d4c6650
commit b025247002
20 changed files with 504 additions and 5 deletions
@@ -0,0 +1,25 @@
+// Copyright (C) 2023 WYATT GROUP
+// Please see the AUTHORS file for details.
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+import 'package:meta/meta_meta.dart';
+import 'package:wyatt_component_copy_with_extension/component_copy_with_extension.dart';
+
+/// Annotation used to indicate that the `copyWith` extension
+/// should be generated for the compononent.
+@Target({TargetKind.classType})
+class ComponentCopyWithExtension extends ComponentAnnotation {
+  const ComponentCopyWithExtension({super.skipFields});
+}
@@ -0,0 +1,25 @@
+// Please see the AUTHORS file for details.
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+import 'package:meta/meta_meta.dart';
+
+@Target({TargetKind.classType})
+class ComponentProxyExtension {
+  const ComponentProxyExtension({
+    this.skipFields = true,
+  });
+
+  final bool? skipFields;
+}
@@ -0,0 +1,24 @@
+// Copyright (C) 2023 WYATT GROUP
+// Please see the AUTHORS file for details.
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+abstract class ComponentAnnotation {
+  const ComponentAnnotation({this.skipFields = true});
+
+  /// Prevent the library from generating `copyWith` functions for individual
+  /// fields e.g. `instance.copyWith.id("123")`. If you want to use only
+  /// copyWith(...) function. Default is `true`.
+  final bool? skipFields;
+}
@@ -0,0 +1,17 @@
+// Copyright (C) 2023 WYATT GROUP
+// Please see the AUTHORS file for details.
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+export './component_annotation.dart';