JavaDoctor / NG Parchment Support | The NeoForged Project | Page 1

full meteor Dec 22, 2023, 7:58 PM

#

Getting JavaDoctor into NeoGradle and making it read Parchment directly

#

@soft scroll bop

#

I'd probably start by making a bundle classifier version that cobbles it all together into one jar file? We need that to refer to it as a tool from NG

soft scroll Dec 22, 2023, 8:01 PM

#

full meteor I'd probably start by making a bundle classifier version that cobbles it all tog...

it's already a shaded cli tool. but I think you should focus on modularising the source processor

#

so we have the infra for ats in the future without needing to rework it again

full meteor Dec 22, 2023, 8:03 PM

#

Okay but would I remove the abstraction over javaparser/spon for that?

#

and make the API depend on PSI?

soft scroll Dec 22, 2023, 8:04 PM

#

err I don't think you should do it in javadoctor lol, that repo is focused on javadocs and has more than the injector

#

just get me the api and stuff for the source modifier and I can handle the javadoctor integration

full meteor Dec 22, 2023, 8:05 PM

#

But I already have Javadoc integration 😅

#

I thought I'd just add the parameter stuff to javaDoctor instead hehehehehehe

soft scroll Dec 22, 2023, 8:05 PM

#

and the at stuff too? LUL

full meteor Dec 22, 2023, 8:06 PM

#

Five minute job! I promise! 👀

#

But how would serviceloader help if the tool has to be a self-contained jar?

#

Thinking about how you would make use of an SPI

soft scroll Dec 22, 2023, 8:07 PM

#

full meteor But how would serviceloader help if the tool has to be a self-contained jar?

can ng not add additional libs to the cp?

full meteor Dec 22, 2023, 8:07 PM

#

Not at the moment, no

#

It's essentially doing a non-transitive artifact id resolution and uses the resulting JAR as the single executable jar

#

But TBH that could (and probably should) be fixed

#

Hm okay, I have a vague idea of how we could do that 🤔

robust ember Dec 22, 2023, 8:08 PM

#

We already have an option to supply the classpath

#

I think

soft scroll Dec 22, 2023, 8:09 PM

#

yeah i'm not really sold on plonking all the source transformations together. sounds like a recipe for pain when updates to relevant projects (like ats) want to be done

full meteor Dec 22, 2023, 8:09 PM

#

It's just running a synthetic NeoForm execute task that we configure in Java anyway. So yes, we could simply allow for a list of extra dependencies. But I am not sure yet how that would help us for the default case where it should just work ™️

#

The common platform isn't bad for two reasons in my opinion:

we need parsing to update anyway when breaking Java updates happen. only having to update it once is a plus
performance. we definitely don't want to repeat this step multiple times in front of recompile

soft scroll Dec 22, 2023, 8:11 PM

#

yes 2. is solved by a classpath. 1. is solved by updating just the root transformer project (the one with the API and the likes)

full meteor Dec 22, 2023, 8:11 PM

#

Yeah true. We'll have a bad time with configuration of all that, I guess. And you already know my take on having too many GH projects

#

But the artifacts would be shipped individually

#

We should however try to avoid working on a generalized framework for weeks when the actual transform tasks would take us 2-3 days to implement

soft scroll Dec 22, 2023, 8:12 PM

#

what do you think my take on "plonk it all together" is? :P. plus we'd need a new repo anyways, javadoctor is more than just applying javadocs, can't just keep throwing stuff on it, there's already like 5 projects

full meteor Dec 22, 2023, 8:13 PM

#

And I see a problem with splitting Method Parameters and Javadoc in that I also remap Parameters in javadoc 🤔
Well I suppose that could be solved by ordering transforms

neat compass Dec 22, 2023, 8:14 PM

#

So this is looking into applying the parchment names at source level rather than binary level?

soft scroll Dec 22, 2023, 8:14 PM

#

full meteor And I see a problem with splitting Method Parameters and Javadoc in that I also ...

as long as javadoctor happens after params it's fine

#

as i said, javadoctor uses param indexes never names

#

not even for generic types

full meteor Dec 22, 2023, 8:14 PM

#

neat compass So this is looking into applying the parchment names at source level rather than...

Yes, I already have a tool. This Thread is to merge it with existing tooling and avoid toolsplosion.

#

How do you merge existing javadoc parameters with new parameters?

soft scroll Dec 22, 2023, 8:15 PM

#

uh?

full meteor Dec 22, 2023, 8:15 PM

#

Well I suppose indexOf heh

#

Before:

#

After:

#

With parameter renames for x->newX, y->newY and javadoc only added for x and z

soft scroll Dec 22, 2023, 8:16 PM

#

javadoc merging is at metadata level, not at source level, it doesn't parse existing docs. and i already have the code there to strip javadocs from the final patcjes

full meteor Dec 22, 2023, 8:17 PM

#

Hm, but that means we need to pull extra parameter metadata that matches the NeoForge version the project refers to in userdev, right?

#

And then have JavaDoctor merge it?

#

The approach I took pulls the parsed JavaDoc comments from PSI and then merges those with the new comments

soft scroll Dec 22, 2023, 8:17 PM

#

full meteor Hm, but that means we need to pull extra parameter metadata that matches the Ne...

recomp already has neo sources injected

#

if the neo sources are there then the AP-generated javadoctor.json metadata is there too. and javadoctor searches for that file when injecting too (besides the option for additional files which would be used for the parchment javadoctor metadata)

full meteor Dec 22, 2023, 8:19 PM

#

Oh you mean as part of compiling NF itself?

#

So the javadoctor.json would be part of neoforge-universal?

soft scroll Dec 22, 2023, 8:20 PM

#

mhhm

full meteor Dec 22, 2023, 8:21 PM

#

Since it can't be generated in userdev. We're injecting before recompile runs, so no APs got applied yet

soft scroll Dec 22, 2023, 8:22 PM

#

it's an AP applied in neodev

#

APs applied at userdev level are rather pointless since it's the last step anyways lol

full meteor Dec 22, 2023, 8:23 PM

#

Yes so the json would have to be in neoforge-universal, then gets injected into the source-jar we're processing. Got that so far

#

That still is more complicated than taking the javadoc IJ has already parsed for us anyway 😅

soft scroll Dec 22, 2023, 8:24 PM

#

the javadoc IJ gave you is in AST format abolbstare

full meteor Dec 22, 2023, 8:24 PM

#

Well, it wasn't hard to massage 😛

soft scroll Dec 22, 2023, 8:25 PM

#

while you massage your AST my approach is written and unit tested 😛

full meteor Dec 22, 2023, 8:25 PM

#

So is mine 😛

#

And in any case, writing APs is not fun work

soft scroll Dec 22, 2023, 8:25 PM

#

you're implying dealing with IJ's apis is

full meteor Dec 22, 2023, 8:26 PM

#

It isn't, but we have to bite that bullet in any case

soft scroll Dec 22, 2023, 8:26 PM

#

(why did i put the popcorn away)

#

plus we're going to use mixins in neo at some point

#

and the AP handles javadocs on vanilla methods through mixins

full meteor Dec 22, 2023, 8:27 PM

#

Wait, Mixins that are source visible? How are we doing that??

soft scroll Dec 22, 2023, 8:27 PM

#

ducker

full meteor Dec 22, 2023, 8:28 PM

#

Do you have a link for me?

soft scroll Dec 22, 2023, 8:28 PM

#

anyways whatever impl we decide on did you work on that replacement api already stabolb

#

github.com/neoforged/ducker

full meteor Dec 22, 2023, 8:29 PM

#

..... there's something missing in that repo. Can you guess what it is? 😄

soft scroll Dec 22, 2023, 8:30 PM

#

docs? the tool wasn't ever used 😛 it was waiting on a jdk bug fix for the longest time

full meteor Dec 22, 2023, 8:30 PM

#

Yes, README.md 😄 😄 😄

#

I always get so confused when I am greeted by the code of conduct instead

#

Well the question I was trying to answer for my mental model: where does that fit into the toolchain?

#

Since without source visibility, there isn't much worth Javadoc-documenting in a Mixin.

robust ember Dec 22, 2023, 8:38 PM

#

Are you guys talking Ducker again 😄

soft scroll Dec 30, 2023, 10:03 AM

#

@full meteor what do you want from my life wrt the new repo

robust ember Dec 30, 2023, 10:06 AM

#

soft scroll <@84313704874663936> what do you want from my life wrt the new repo

All of it

#

All of your life will be sunken into it 😄

full meteor Dec 30, 2023, 11:25 AM

#

@soft scroll nooo just what does need done to get that to publish like the other repos 😅

soft scroll Dec 30, 2023, 11:36 AM

#

also why are you using mapping io instead of srgutils

#

as of right now we have no policy regarding use of external libraries made by other loaders (read: don't)

full meteor Dec 30, 2023, 11:40 AM

#

wtf do I know 😄

#

Also why are libraries "by other loaders" treated any differently from any other maven central library?

soft scroll Dec 30, 2023, 11:42 AM

#

just repeating the same thing i've heard against fabric mixin and unpick ¯_(ツ)_/¯

robust ember Dec 30, 2023, 11:43 AM

#

I mean as maintainers I would be open to vote that rule away

#

I find it annoying

#

Mapping io can do what srgutil can

full meteor Dec 30, 2023, 11:43 AM

#

unpick isnt on central I think

#

I can see problems with adding extra repos, but mappings io is on central

#

i just didn't know about srgutils

#

so, mappings io isn't needed for parchment in userdev, that's just for reverting parchment parameter names later if we want to use this down the line in NF-dev

soft scroll Dec 30, 2023, 11:44 AM

#

anyways do we want to publish this on central

full meteor Dec 30, 2023, 11:44 AM

#

But using an in-house library we have anyway sounds fine, so I can replace that today

#

I'd say we don't need to, we just need it where all of our other tools are

#

so NG picks it up without further changes

#

But alright, TODO for today: [ ] mappings io -> srgutil

soft scroll Dec 30, 2023, 11:46 AM

#

markdown failure smh

#

also this is compiling with java 8, correct?

#

nope it's not

#

why no toolchain Stabby

full meteor Dec 30, 2023, 12:15 PM

#

soft scroll why no toolchain <:Stabby:1017156697678164090>

because forgot 😄

#

Heh now I obviously can't push anymore.

#

@soft scroll https://github.com/neoforged/JavaSourceTransformer/pull/1/files

#

srgutils, another library with no readme 😄

soft scroll Dec 30, 2023, 12:32 PM

#

full meteor Heh now I obviously can't push anymore.

mhh, sounds intended /s

robust ember Dec 30, 2023, 12:35 PM

#

@soft scroll how about we bump him to full toolchain member

#

Instead of just ng7

#

?

#

Or is this project simply not configured to allow push access by the toolchain team, while he is already in it? I forgot what we set for him...

full meteor Dec 30, 2023, 12:38 PM

#

It's actually fine, four eye principle or however that translates to english lol

#

maty shuld just push merge 😛 stabolb

sonic tapir Dec 30, 2023, 12:41 PM

#

https://www.unido.org/overview/member-states/change-management/faq/what-four-eyes-principle
it's still called the four eyes principle

molten pine Dec 30, 2023, 12:42 PM

#

The four eyes principle: people with glasses are smarter than you, even if you have glasses too?

#

Hey, that rhymes

sonic tapir Dec 30, 2023, 12:50 PM

#

I have glasses! does that mean I can push directly to main now thinkies

soft scroll Dec 30, 2023, 1:06 PM

#

robust ember <@561254664750891009> how about we bump him to full toolchain member

he is toolchain, but the repo has no team set

robust ember Dec 30, 2023, 1:06 PM

#

Ah okey 😄

#

Configured for management by Toolchain team now

soft scroll Dec 30, 2023, 2:39 PM

#

it's not published screm

#

where is it

#

feels like something ate it

full meteor Dec 30, 2023, 2:43 PM

#

🤔

soft scroll Dec 30, 2023, 2:51 PM

#

Task :cli:publishPlainPublicationToForgeRepository
the task's run too

full meteor Dec 30, 2023, 2:54 PM

#

Yeah I was about to ask, there's no publish repo defined, does your thing do that automatically? 🤔

soft scroll Dec 30, 2023, 2:54 PM

#

    repositories {
        maven gradleutils.publishingMaven
    }

#

added it in ee42db07343bd65675506ec83baf8ac925a7a801

full meteor Dec 30, 2023, 2:57 PM

#

Also funny, I can run that locally without having any credentials set 🤔

#

And it doesn't error or print anything, what?!

soft scroll Dec 30, 2023, 2:57 PM

#

german issue

#

OH

#

i forgot to give it the creds

#

knew i forgot something pffft

robust ember Dec 30, 2023, 2:58 PM

#

Lol

soft scroll Dec 30, 2023, 2:58 PM

#

so annoying that gradle doesnțt fail the taks if itțs a 403

#

fuck diacritics

#

https://github.com/neoforged/actions/actions/runs/7364757277 creds are being added

full meteor Dec 30, 2023, 3:01 PM

#

There it is! https://maven.neoforged.net/#/releases/net/neoforged/jst/jst-cli-bundle/1.0.29 🙂

#

Thank you maty!

#JavaDoctor / NG Parchment Support