Update CHANGELOG to reflect latest changes

Author: SleepySquash

CHANGELOG.md

@@ -1,3 +1,3 @@
-## 1.0.0
+## 0.1.0
 
 - Initial version.

README.md

@@ -1,4 +1,7 @@
-`artemis_custom_gen` is a `build_runner` custom types generator for `artemis` GraphQL package.
+`artemis_custom_gen`
+====================
+
+`artemis_custom_gen` is a custom types generator for `artemis` GraphQL package.
 
 
 
@@ -7,6 +10,17 @@
 
 To use the package, simply add the following to your `pubspec.yaml`:
 
+
+```yaml
+dependencies:
+  artemis_custom_gen:
+
+dev_dependencies:
+  build_runner:
+```
+
+Or to depend on the latest `main`:
+
 ```yaml
 dependencies:
   artemis_custom_gen:
@@ -41,9 +55,62 @@ class MyCustomType {
 }
 ```
 
-2. Add the `part '....g.dart';` directive after the imports in your Dart file.
-3. Run the `build_runner`: `dart run build_runner build`.
-4. Add the generated type to the `build.yaml` of your package (see `artemis` documentation to learn more):
+__Note__, that for parsing from `String` your custom type __must__ have a single `String` argument constructor. E.g.:
+
+```dart
+@ArtemisCustomType(graphQlType: 'MyGraphQlScalar')
+class MyCustomType {
+  const MyCustomType(this.value); // `this.value` is a `String`.
+  final String value;
+}
+```
+
+```dart
+class Parent {
+  const Parent(this.value);
+  final String value;
+}
+
+@ArtemisCustomType(graphQlType: 'MyGraphQlScalar')
+class MyCustomType extends Parent {
+  const MyCustomType(super.value); // `super.value` is a `String`.
+}
+```
+
+```dart
+@ArtemisCustomType(graphQlType: 'MyGraphQlScalar')
+class MyCustomType {
+  const MyCustomType(this.value);
+
+  // Naming doesn't matter.
+  const MyCustomType.parse(String string) : value = double.parse(string);
+
+  final double value;
+}
+```
+
+And for parsing to `String` currently `artemis_custom_gen` uses `toString()` on your custom type.
+
+2. (Optionally) Configure the output path (default is `lib/api/parsers.g.dart`).
+
+In your `build.yaml`:
+
+```yaml
+targets:
+  $default:
+    builders:
+      artemis_custom_gen:
+        options:
+          output: api/backend/parsers.dart # Without `lib/`.
+```
+
+3. Run the `build_runner`:
+
+```bash
+dart run build_runner build
+```
+
+4. Add the generated type to the `artemis` options in `build.yaml` (see `artemis` documentation to learn more):
 
 ```yaml
 targets:
@@ -53,11 +120,16 @@ targets:
         options:
           scalar_mapping:
             - graphql_type: MyGraphQlScalar
-              custom_parser_import: "package:your_package/path_to_your_model/my_custom_type.dart"
+              custom_parser_import: "package:your_package/path_to_parsed_file.dart"
               dart_type:
                 name: MyCustomType
                 imports:
                   - "package:your_package/path_to_your_model/my_custom_type.dart"
 ```
 
-Note, that `custom_parser_import` and `imports` are the same. That's because of that `part` directive you put.
+
+
+
+## Roadmap
+
+- [ ] Configurable to `String` and from `String` parsers on `ArtemisCustomType`.

lib/src/builder.dart

@@ -46,8 +46,6 @@ class ArtemisCustomTypeBuilder implements Builder {
       }
     }
 
-    print('IMPORTS: ${imports.join('\n')}');
-
     if (items.isEmpty) {
       // Nothing to generate.
       return;
@@ -62,8 +60,6 @@ class ArtemisCustomTypeBuilder implements Builder {
     buffer.writeln();
 
     for (var e in items) {
-      print('Generating for ${e.element.name}');
-
       final List<ConstructorElement> ctors =
           (e.element as ClassElement).constructors;
       final String name = e.element.name!;
@@ -115,6 +111,5 @@ class ArtemisCustomTypeBuilder implements Builder {
 
     final outputId = AssetId(buildStep.inputId.package, 'lib/$output');
     await buildStep.writeAsString(outputId, buffer.toString());
-    print('written to $outputId');
   }
 }

pubspec.yaml

@@ -1,6 +1,6 @@
 name: artemis_custom_gen
 description: Custom types generator for artemis.
-version: 1.0.0
+version: 0.1.0
 repository: https://github.com/lapuske/artemis_custom_gen
 
 environment: