More use of triggers

[davidmorgan]

I added use of the "triggers" feature to built_value a while back now and nobody has complained :) so I wonder if it's time to add it more builders, I guess json_serializable is next in line.

It would help in cases where in the first run log output today you see e.g. "123 no-op" for a builder output, that means the builder ran but it decided not to output anything. With triggers it could just be skipped.

If anyone is interested in experimenting with triggers on their local build, that's fully supported using your own build.yaml

https://pub.dev/packages/build_config#triggers

and then we can look at up streaming any config that's useful to the builders themselves.

[amrgetment]

@davidmorgan This is my build.yaml, I wonder how could I add trigger there, is it only run_only_if_triggered: true

global_options:
  freezed:
    runs_before:
      - json_serializable
  json_serializable:
    options:
      explicit_to_json: true
      checked: true
    runs_before:
      - retrofit_generator

targets:
  $default:
    builders:
      auto_route_generator:auto_route_generator: # this for @RoutePage
        options:
          enable_cached_builds: true
        generate_for:
          - lib/core/routers/routes/**.dart
      auto_route_generator:auto_router_generator: # this for @AutoRouterConfig
        options:
          enable_cached_builds: true
        generate_for:
          - lib/core/routers/app_router.dart

[amrgetment]

yes it works but I won't see a big difference in performance except if all builders supported it
at least the popular packages (freezed, auto route, injectable, retrofit_generator)

[davidmorgan]

Hmm that's true, it will only save analyzing files if every generator that does analysis is using triggers.

So I guess something along the lines of ... guessing here :)

triggers:
  injectable_generator:injectable_builder:
    - annotation module
    - annotation factoryMethod
    - annotation Injectable
    - annotation LazySingleton
  injectable_generator:injectable_config_builder:
    - annotation InjectableInit
  auto_route_generator:
    - annotation AutoRouterConfig
    - annotation RoutePage
  retrofit_generator:
    - annotation RestApi

plus setting "run_only_if_triggered" for them all.

If it's working you should see "not triggered" in the log output, e.g.

11s json_serializable on 5001 inputs: 4999 not triggered, 2 output; spent 6s sdk, 3s analyzing                                                                                                                                                                

[amrgetment]

but why it is not automatic, like the libraries add a list of its annotations somewhere then build_runner parse it instead of adding all of those annotations on every project build.yaml

[davidmorgan]

That's the plan :) I didn't follow up for a while as the AOT change turned out to be a surprisingly big refactor.

[davidmorgan]

The wrong config warnings should be fixed with the 2.10.1 release. Now you do actually need to follow the warnings and write the full names e.g. json_serializable:json_serializable for the triggers.

[gmpassos]

@davidmorgan quick question: how is the trigger annotation detected? Since it should be a fast process.

Best regards.

[davidmorgan]

The file is parsed to AST, but not resolved. So yes, it's pretty fast :)