Move rewrite.yml from src/resources/META-INF to root directory

[Anmol202005]

The rewrite.yml file is currently located in src/resources/META-INF/ but should be in the project root directory.

There are two different purposes for rewrite.yml files:

• META-INF/rewrite.yml = Recipe definitions that get packaged and distributed for other projects to use
• ./rewrite.yml (root) = Configuration file for transforming your own project

[rdiachenko]

@Anmol202005 could you explain why we need to do this?

[Anmol202005]

There are two places where you can define an OpenRewrite YAML file:

• Within the rewrite.yml file of a project that applies rewrite recipes via the rewrite-gradle-plugin or rewrite-maven-plugin
• Inside the META-INF/rewrite folder of a JAR (such as in the rewrite-testing-frameworks)

If you define a recipe or style in the rewrite.yml file, they will not be included in the JARs published from your project.

If you want to distribute a recipe or a style and apply them to other projects, you'll need to create them inside of the META-INF/rewrite folder of a JAR.
@rdiachenko Reference: https://docs.openrewrite.org/reference/yaml-format-reference#where-openrewrite-yaml-files-can-exist

[Anmol202005]

We want user to provide the violation report path and configration file path hence, we need to implement the 1st option.

[rdiachenko]

We want it to be a part of a jar file with default values for violation report and config file. If user want to overwrite those default values, they should create rewrite.yml and override it there.

What's the priority recipe configuration when you have custom rewrite.yml in your project's root and same recipe is configurated in META-INF? If rewrite.yml in the project takes higher priority we don't need to change anything. Could you check this please?

[Anmol202005]

We want it to be a part of a jar file with default values for violation report and config file. If user want to overwrite those default values, they should create rewrite.yml and override it there.

What's the priority recipe configuration when you have custom rewrite.yml in your project's root and same recipe is configurated in META-INF? If rewrite.yml in the project takes higher priority we don't need to change anything. Could you check this please?

@rdiachenko The META-INF/recipes.yml is executed even if an external configuration is present.

[rdiachenko]

@Anmol202005 do I understand it correctly: when you have both approaches, and autofix recipe is configured in both, the one in META-INF/recipes.yml takes priority and overrides values with default ones?

[Anmol202005]

@Anmol202005 do I understand it correctly: when you have both approaches, and autofix recipe is configured in both, the one in META-INF/recipes.yml takes priority and overrides values with default ones?

@rdiachenko Yes.

[rdiachenko]

Resolved by #100