New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate AE2 recipe system. #3247

Merged
merged 2 commits into from Nov 26, 2017

Conversation

Projects
None yet
3 participants
@fscan
Member

fscan commented Nov 23, 2017

It's going away soon, replaced by custom JSON recipes and CraftTweaker support.

@fscan fscan added this to the rv5.stable - 1.12 milestone Nov 23, 2017

@@ -29,7 +29,7 @@
import appeng.api.exceptions.MissingIngredientException;
import appeng.api.exceptions.RegistrationException;
@Deprecated
public interface IIngredient

This comment has been minimized.

@orod-org

orod-org Nov 23, 2017

MAJOR Add the missing @deprecated Javadoc tag. rule
INFO Do not forget to remove this deprecated code someday. rule

@orod-org

orod-org Nov 23, 2017

MAJOR Add the missing @deprecated Javadoc tag. rule
INFO Do not forget to remove this deprecated code someday. rule

@@ -30,7 +30,7 @@
import appeng.api.exceptions.RecipeException;
import appeng.api.exceptions.RegistrationException;
@Deprecated
public interface ICraftHandler

This comment has been minimized.

@orod-org

orod-org Nov 23, 2017

MAJOR Add the missing @deprecated Javadoc tag. rule
INFO Do not forget to remove this deprecated code someday. rule

@orod-org

orod-org Nov 23, 2017

MAJOR Add the missing @deprecated Javadoc tag. rule
INFO Do not forget to remove this deprecated code someday. rule

@@ -48,6 +48,7 @@
* @param name name of crafthandler
* @param handler class of crafthandler
*/
@Deprecated
void addNewCraftHandler( String name, Class<? extends ICraftHandler> handler );

This comment has been minimized.

@orod-org

orod-org Nov 23, 2017

MAJOR Add the missing @deprecated Javadoc tag. rule
INFO Do not forget to remove this deprecated code someday. rule

@orod-org

orod-org Nov 23, 2017

MAJOR Add the missing @deprecated Javadoc tag. rule
INFO Do not forget to remove this deprecated code someday. rule

@@ -65,11 +66,13 @@
* @return A recipe handler by name, returns null on failure.
*/
@Nullable
@Deprecated
ICraftHandler getCraftHandlerFor( String name );

This comment has been minimized.

@orod-org

orod-org Nov 23, 2017

MAJOR Add the missing @deprecated Javadoc tag. rule
INFO Do not forget to remove this deprecated code someday. rule

@orod-org

orod-org Nov 23, 2017

MAJOR Add the missing @deprecated Javadoc tag. rule
INFO Do not forget to remove this deprecated code someday. rule

ICraftHandler getCraftHandlerFor( String name );
/**
* @return a new recipe handler, which can be used to parse, and read recipe files.
*/
@Deprecated
IRecipeHandler createNewRecipehandler();

This comment has been minimized.

@orod-org

orod-org Nov 23, 2017

MAJOR Add the missing @deprecated Javadoc tag. rule
INFO Do not forget to remove this deprecated code someday. rule

@orod-org

orod-org Nov 23, 2017

MAJOR Add the missing @deprecated Javadoc tag. rule
INFO Do not forget to remove this deprecated code someday. rule

@@ -28,7 +28,7 @@
import javax.annotation.Nonnull;
@Deprecated
public interface IRecipeLoader

This comment has been minimized.

@orod-org

orod-org Nov 23, 2017

CRITICAL Annotate the "IRecipeLoader" interface with the @FunctionalInterface annotation rule
MAJOR Add the missing @deprecated Javadoc tag. rule
INFO Do not forget to remove this deprecated code someday. rule

@orod-org

orod-org Nov 23, 2017

CRITICAL Annotate the "IRecipeLoader" interface with the @FunctionalInterface annotation rule
MAJOR Add the missing @deprecated Javadoc tag. rule
INFO Do not forget to remove this deprecated code someday. rule

@@ -27,6 +27,7 @@
/**
* Represents the AE2 Recipe Loading/Reading Class
*/
@Deprecated
public interface IRecipeHandler

This comment has been minimized.

@orod-org

orod-org Nov 23, 2017

MAJOR Add the missing @deprecated Javadoc tag. rule
INFO Do not forget to remove this deprecated code someday. rule

@orod-org

orod-org Nov 23, 2017

MAJOR Add the missing @deprecated Javadoc tag. rule
INFO Do not forget to remove this deprecated code someday. rule

@yueh

This comment has been minimized.

Show comment
Hide comment
@yueh

yueh Nov 23, 2017

Member

There should be a note about crafttweaker support being temporary due to resource packs are lacking a few features currently and our recipe system needing a major overhaul, which is already obsolete in most cases due to resource packs and the extensions provided by forge for it.

1.13 plans to introduce data packs, which should solve the shortcomings of resource packs and allow for different recipe per server. Should CT have issues with supporting it or cause more issues like the timeout problems due to reloading JEI it will be dropped in favour of a vanilla/forge solution.

Member

yueh commented Nov 23, 2017

There should be a note about crafttweaker support being temporary due to resource packs are lacking a few features currently and our recipe system needing a major overhaul, which is already obsolete in most cases due to resource packs and the extensions provided by forge for it.

1.13 plans to introduce data packs, which should solve the shortcomings of resource packs and allow for different recipe per server. Should CT have issues with supporting it or cause more issues like the timeout problems due to reloading JEI it will be dropped in favour of a vanilla/forge solution.

@orod-org

This comment has been minimized.

Show comment
Hide comment
@orod-org

orod-org Nov 23, 2017

SonarQube analysis reported 20 issues

  • CRITICAL 1 critical
  • MAJOR 12 major
  • INFO 7 info

Watch the comments in this conversation to review them.

5 extra issues

Note: The following issues were found on lines that were not modified in the pull request. Because these issues can't be reported as line comments, they are summarized here:

  1. MAJOR ICraftHandler.java#L53: Refactor this method to throw at most one checked exception instead of: appeng.api.exceptions.RegistrationException, appeng.api.exceptions.MissingIngredientException rule
  2. MAJOR IIngredient.java#L45: Refactor this method to throw at most one checked exception instead of: appeng.api.exceptions.RegistrationException, appeng.api.exceptions.MissingIngredientException rule
  3. MAJOR IIngredient.java#L56: Refactor this method to throw at most one checked exception instead of: appeng.api.exceptions.RegistrationException, appeng.api.exceptions.MissingIngredientException rule
  4. MAJOR IIngredient.java#L91: Refactor this method to throw at most one checked exception instead of: appeng.api.exceptions.RegistrationException, appeng.api.exceptions.MissingIngredientException rule
  5. MAJOR IRecipeLoader.java#L41: Define and throw a dedicated exception instead of using a generic one. rule

orod-org commented Nov 23, 2017

SonarQube analysis reported 20 issues

  • CRITICAL 1 critical
  • MAJOR 12 major
  • INFO 7 info

Watch the comments in this conversation to review them.

5 extra issues

Note: The following issues were found on lines that were not modified in the pull request. Because these issues can't be reported as line comments, they are summarized here:

  1. MAJOR ICraftHandler.java#L53: Refactor this method to throw at most one checked exception instead of: appeng.api.exceptions.RegistrationException, appeng.api.exceptions.MissingIngredientException rule
  2. MAJOR IIngredient.java#L45: Refactor this method to throw at most one checked exception instead of: appeng.api.exceptions.RegistrationException, appeng.api.exceptions.MissingIngredientException rule
  3. MAJOR IIngredient.java#L56: Refactor this method to throw at most one checked exception instead of: appeng.api.exceptions.RegistrationException, appeng.api.exceptions.MissingIngredientException rule
  4. MAJOR IIngredient.java#L91: Refactor this method to throw at most one checked exception instead of: appeng.api.exceptions.RegistrationException, appeng.api.exceptions.MissingIngredientException rule
  5. MAJOR IRecipeLoader.java#L41: Define and throw a dedicated exception instead of using a generic one. rule

@yueh yueh merged commit 5fa2c0a into rv5-1.12 Nov 26, 2017

3 of 4 checks passed

sonarqube SonarQube reported 20 issues, with 1 critical
continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details
jenkins Success
Details

@fscan fscan deleted the deprecate-aerecipes branch Dec 3, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment