htmlSanityCheck icon indicating copy to clipboard operation
htmlSanityCheck copied to clipboard

Published 20 hours ago • verified publisher icon aim42

Modularize Build

Open ascheman opened this issue 2 years ago • 5 comments

As users we would like to make HSC more modular in order to enable integration it with other build tools (e.g., Maven) or even UIs (like a GUI and a CLI tool for HSC).

Note: This is already foreseen in the architecture.

Background

In our contexts we had already the demand to use HTML Sanity Checker in other tool chains, e.g.,

  • as part of a Maven build: The respective organisation has written an inner source Maven plugin based on the sources of HSC as there was no Maven plugin available (perhaps this organisation would now be willing to contribute their Maven adaption?)
  • for docToolchain it was discussed to make embedded components like HSC more lightweight to get rid of an Gradle based build in the long run.

Authors / Proof of Concept

  • The idea to request this was already born in internal discussions with some client organisations long ago (@ascheman)
  • The mentioned discussions in the docToolchain context with @rdmueller and others contributed to this idea
  • In the CyberLand Code Camp of Oct. 11th we found more allies to implement a Proof-of-Concept (coming soon): @BjoernKasteleiner and @johthor

ascheman avatar Oct 19 '23 05:10 ascheman

Do you like this RfE and our PoC (cf. #310), @gernotstarke / @rdmueller? At least I would then adjust the documentation accordingly and make the PR final. I have already additional ideas to implement a CLI layer on top of the new core module and hope that some of the others will provide a Maven plugin for HSC.

ascheman avatar Oct 19 '23 06:10 ascheman

sounds good to me, no objections at all. Currently I cannot support you, though.

gernotstarke avatar Oct 19 '23 06:10 gernotstarke

Awesome! @rdmueller and i had a chat yesterday and we agreed to go that road with docToolchain as well. I already implemented a core component in dtc here and will release a RC soon. Good to see HSC evolves in the same direction because we then have the possibility to integrate the HSC core module decoupled from Gradle, which is nice. For reference: modularize dtc ADR

PacoVK avatar Oct 19 '23 08:10 PacoVK

Build modularization completed, kudos to @truhroth, @johthor and other contributors during the CyberLand Open Source Camps!

ascheman avatar Apr 18 '24 07:04 ascheman

We seem to need a little bit of documentation for the modularization before we could release it

ascheman avatar Apr 22 '24 16:04 ascheman

First release candidate (rc0) of modularised build was published to Maven Central on 23rd of June 2024.

ascheman avatar Aug 07 '24 10:08 ascheman