codox icon indicating copy to clipboard operation
codox copied to clipboard

boot-codox declares no dependencies?

Open stuarthalloway opened this issue 7 years ago • 6 comments

I am trying to integrate codox in a boot project, and I noticed that it does not declare its dep on codox.

Is there a motivation for this? It breaks expectations and tooling.

stuarthalloway avatar Jun 12 '17 17:06 stuarthalloway

I don't use Boot, so all the tooling around Boot has been submitted by others. What do you mean by "does not declare its dep on codox"?

weavejester avatar Jun 12 '17 18:06 weavejester

The artifact pom does not mention [codox 0.10.3] presumably because the project file does not include it.

stuarthalloway avatar Jun 12 '17 19:06 stuarthalloway

It adds the dependency in dynamically. This is idiomatic for Leiningen plugins, but perhaps not for Boot. I'd welcome some expert advice on how best to integrate Codox with Boot.

weavejester avatar Jun 12 '17 20:06 weavejester

It may be idiomatic in boot too, I am not sure. I ended up avoiding the problem by skipping the boot code and using codox directly. I am adjusting my expectations around plugins :-) so feel free to close this if you want.

stuarthalloway avatar Jun 13 '17 00:06 stuarthalloway

I'll keep it open for a little longer, just in case a Boot expert happens along :)

Both the Leiningen and Boot plugins are just thin wrappers around the codox.main/generate-docs function, so if you're calling that directly you should be good.

weavejester avatar Jun 13 '17 00:06 weavejester

A wild boot user happens along

boot-codox seems to put codox into a pod. This means that none of the dependencies of codox will pollute the classpath of your main project (see the boot propaganda on pods).

I'd be curious to know which workflow/tooling is broken by this approach? It's possible that the task could expose it's pod so you could run arbitrary code inside a classpath with codox inside. But most likely the boot task should probably take some more options to accomodate what you were trying to do?

SevereOverfl0w avatar Jul 04 '17 20:07 SevereOverfl0w