-
Notifications
You must be signed in to change notification settings - Fork 220
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactor Fabric API extension (#1238)
* Refactor Fabric API extension * Fix * Fix * Even more cleanup
- Loading branch information
Showing
9 changed files
with
616 additions
and
349 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
70 changes: 70 additions & 0 deletions
70
src/main/java/net/fabricmc/loom/api/fabricapi/DataGenerationSettings.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
/* | ||
* This file is part of fabric-loom, licensed under the MIT License (MIT). | ||
* | ||
* Copyright (c) 2024 FabricMC | ||
* | ||
* Permission is hereby granted, free of charge, to any person obtaining a copy | ||
* of this software and associated documentation files (the "Software"), to deal | ||
* in the Software without restriction, including without limitation the rights | ||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
* copies of the Software, and to permit persons to whom the Software is | ||
* furnished to do so, subject to the following conditions: | ||
* | ||
* The above copyright notice and this permission notice shall be included in all | ||
* copies or substantial portions of the Software. | ||
* | ||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
* SOFTWARE. | ||
*/ | ||
|
||
package net.fabricmc.loom.api.fabricapi; | ||
|
||
import org.gradle.api.file.RegularFileProperty; | ||
import org.gradle.api.provider.Property; | ||
|
||
/** | ||
* Represents the settings for data generation. | ||
*/ | ||
public interface DataGenerationSettings { | ||
/** | ||
* Contains the output directory where generated data files will be stored. | ||
*/ | ||
RegularFileProperty getOutputDirectory(); | ||
|
||
/** | ||
* Contains a boolean indicating whether a run configuration should be created for the data generation process. | ||
*/ | ||
Property<Boolean> getCreateRunConfiguration(); | ||
|
||
/** | ||
* Contains a boolean property indicating whether a new source set should be created for the data generation process. | ||
*/ | ||
Property<Boolean> getCreateSourceSet(); | ||
|
||
/** | ||
* Contains a string property representing the mod ID associated with the data generation process. | ||
* | ||
* <p>This must be set when {@link #getCreateRunConfiguration()} is set. | ||
*/ | ||
Property<String> getModId(); | ||
|
||
/** | ||
* Contains a boolean property indicating whether strict validation is enabled. | ||
*/ | ||
Property<Boolean> getStrictValidation(); | ||
|
||
/** | ||
* Contains a boolean property indicating whether the generated resources will be automatically added to the main sourceset. | ||
*/ | ||
Property<Boolean> getAddToResources(); | ||
|
||
/** | ||
* Contains a boolean property indicating whether data generation will be compiled and ran with the client. | ||
*/ | ||
Property<Boolean> getClient(); | ||
} |
61 changes: 61 additions & 0 deletions
61
src/main/java/net/fabricmc/loom/api/fabricapi/FabricApiExtension.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
/* | ||
* This file is part of fabric-loom, licensed under the MIT License (MIT). | ||
* | ||
* Copyright (c) 2024 FabricMC | ||
* | ||
* Permission is hereby granted, free of charge, to any person obtaining a copy | ||
* of this software and associated documentation files (the "Software"), to deal | ||
* in the Software without restriction, including without limitation the rights | ||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
* copies of the Software, and to permit persons to whom the Software is | ||
* furnished to do so, subject to the following conditions: | ||
* | ||
* The above copyright notice and this permission notice shall be included in all | ||
* copies or substantial portions of the Software. | ||
* | ||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
* SOFTWARE. | ||
*/ | ||
|
||
package net.fabricmc.loom.api.fabricapi; | ||
|
||
import org.gradle.api.Action; | ||
import org.gradle.api.artifacts.Dependency; | ||
|
||
/** | ||
* A gradle extension with specific functionality related to Fabric API. | ||
*/ | ||
public interface FabricApiExtension { | ||
/** | ||
* Get a {@link Dependency} for a given Fabric API module. | ||
* | ||
* @param moduleName The name of the module. | ||
* @param fabricApiVersion The main Fabric API version. | ||
* @return A {@link Dependency} for the module. | ||
*/ | ||
Dependency module(String moduleName, String fabricApiVersion); | ||
|
||
/** | ||
* Get the version of a Fabric API module. | ||
* @param moduleName The name of the module. | ||
* @param fabricApiVersion The main Fabric API version. | ||
* @return The version of the module. | ||
*/ | ||
String moduleVersion(String moduleName, String fabricApiVersion); | ||
|
||
/** | ||
* Configuration data generation using the default settings. | ||
*/ | ||
void configureDataGeneration(); | ||
|
||
/** | ||
* Configuration data generation using the specified settings. | ||
* @param action An action to configure specific data generation settings. See {@link DataGenerationSettings} for more information. | ||
*/ | ||
void configureDataGeneration(Action<DataGenerationSettings> action); | ||
} |
Oops, something went wrong.