gradle cleanup - Githubissues

supersaiyansubtlety commented 2 months ago

Ready!

Tasks

[x] the thisening
[x] the finalening
[x] the line wrappening
[x] the abstractening
[x] the registerening
[x] move all custom tasks to plugins
[x] move (most) task configuration to plugins (makes it easier to see dependencies and makes tasks more reusable)
[x] eliminate buildSrc referencing build.gradle things
[x] eliminate project access in task actions
[x] refine inputs/outputs and dependencies
[x] move more things to QuiltMappingsExtension
[x] separate QuiltMappingsPlugin's contents into several plugins
[x] wait for #659 which fixes tests, make sure tests still pass
[x] resolve a few remaining questions
~~replace TasksTest and depend on gradle test kit~~ maybe in a followup PR
~~apply a checkstyle to buildSrc?~~ maybe in a followup PR

Summary

renames MappingsPlugin/mappings-logic -> QuiltMappingsPlugin/quilt-mappings renames MappingssExtension/mappings -> QuiltMappingsExtension/quiltMappings splits QuiltMappingsPlugin into:

QuiltMappingsBasePlugin
MinecraftJarsPlugin
MapMinecraftJarsPlugin
MapV2Plugin
MapIntermediaryPlugin
ProcessMappingsPlugin
EnigmaMappingsPlugin
TargetDiffPlugin

all implement MappingsProjectPlugin and are applied by QuiltMappingsPlugin

eliminates FileConstants:

some common directories are in MappingsProjectPlugin
files that were the output of one task are now defined where that task's output is set and other tasks take that output as input

adds several extensions that expose objects created by their plugins extensions are accessed via plugin instances which ensures extension have been created

no use of tasks.named(...) to access custom tasks:

instead they're accessed via the provider returned by tasks.register(...)
tasks used outside of the plugin they're defined in are accessed via Tasks objects obtained via extensions, obtained via plugin instances
this makes sure required plugins are applied and the tasks are registered

ensures all custom tasks have a group eliminates MappingsTask and DefaultMappingsTask (some MappingsTask methods are replaced with helper methods in more specific task interfaces and plugins)

moves Constants.MINECRAFT_VERSION to libs.versions.toml and passes it to QuiltMappingsExtension moves Constants.MAPPINGS_VERSION to direct project.version assignment in build.gradle and passes it to QuiltMappingsExtension moves dictionary file url to libs.versions.toml and downloads it with an ivy repository hack eliminates downloadDictionaryFile and passes the dictionary file to mappingLint in build.gradle saves unpickVersion in a QuiltMappingsEntension field and passes it to the constructors of tasks that require it (it's required at configuration time for some tasks so it can't be a property)

extracts a bunch of magic strings to interfaces in constants package moves all task names to their classes and renames all TASK_NAME fields <ACTUAL_NAME>_TASK_NAME adds javadocs to all task names that link the plugin that registers them adds javadocs to each plugin with any configurEaches listing what they do (these can be annoying to track down) adds javadocs to each class that's configureEached and to all their subclasses, linking the plugin that does the configuring (these can be really annoying to track down)

moves almost all outputs to build/* moves combineUnpickDefinitions's output to build/mappings/ eliminates custom clean task logic (everything is in build/ and gets cleaned)

names AbstractArchiveTask outputs using its name composition methods adds ArtifactFileProducingTask which mimics AbstractArchiveTask name composition (implemented by CompressTinyTask) eliminates explicit classifiers for published artifacts in build.gralde

mapped providers are the solution to every problem

moves unpick.json to unpick/ and unpick definitions to unpick/definitions/ moves enimga_profile.json and simple_type_field_names.json5 to enigma/

eliminates decompileClasspath configuration -> passes downloadMinecraftLibraries.librariesDir.fileTree replaces CheckStuffExists/Matches tasks with mapped providers

populates unpickCli configuration using included build :unpick-holders splits enigmaRuntime configuration into enigmaSwing and enigmaServer, populates them using :unpick-holders

replaces de.undercouch.gradle.tasks.download.DownloadAction usage with DownloadUtil methods (which use org.apache.commons.io.FileUtils::copyURLToFile) eliminates de.undercouch:gradle-download-task dependency

adds generateDiff task (Windows users may have to put diff on their PATH)

Future

use generateDiff in gerenate-diff.yml (pass output path to avoid magic string)
move namedSource/ and namedTargetSource/once generateDiff is used in gerenate-diff.yml
update/replace licenser plugin: the last release is from 2021 and it's incompatible with gradle 9
@CachableTask everything
configuration cache

supersaiyansubtlety commented 2 months ago

~~Early reviewers beware: I will probably be rewriting history so any review progress on github may be lost.~~ Ready ~~-ish~~