Fix #148: DevUI Card and Readme (#152)

README.md

@@ -1,9 +1,13 @@
-# Quarkus - JGit
-<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors-)
-<!-- ALL-CONTRIBUTORS-BADGE:END -->
+<div align="center">
+<img src="https:/quarkiverse/quarkus-jgit/blob/main/docs/modules/ROOT/assets/images/quarkus.svg" width="67" height="70" ><img src="https:/quarkiverse/quarkus-jgit/blob/main/docs/modules/ROOT/assets/images/plus-sign.svg" height="70" ><img src="https:/quarkiverse/quarkus-jgit/blob/main/docs/modules/ROOT/assets/images/jgit.svg" height="70" >
+
+# Quarkus JGit
+</div>
+<br>
 
 [![Version](https://img.shields.io/maven-central/v/io.quarkiverse.jgit/quarkus-jgit?logo=apache-maven&style=flat-square)](https://search.maven.org/artifact/io.quarkiverse.jgit/quarkus-jgit)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=flat-square)](https://opensource.org/licenses/Apache-2.0)
+[![Build](https:/quarkiverse/quarkus-jgit/actions/workflows/build.yml/badge.svg)](https:/quarkiverse/quarkus-jgit/actions/workflows/build.yml)
 
 ## Introduction
 
@@ -40,4 +44,4 @@ Thanks go to these wonderful people ([emoji key](https://allcontributors.org/doc
 
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
-This project follows the [all-contributors](https:/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+This project follows the [all-contributors](https:/all-contributors/all-contributors) specification. Contributions of any kind welcome!

deployment/src/main/java/io/quarkus/jgit/deployment/devui/GiteaDevUIProcessor.java

@@ -2,25 +2,39 @@
 
 import java.util.Optional;
 
+import org.eclipse.jgit.api.Git;
+
 import io.quarkus.deployment.IsDevelopment;
 import io.quarkus.deployment.annotations.BuildProducer;
 import io.quarkus.deployment.annotations.BuildStep;
 import io.quarkus.devui.spi.page.CardPageBuildItem;
+import io.quarkus.devui.spi.page.ExternalPageBuilder;
 import io.quarkus.devui.spi.page.Page;
 import io.quarkus.jgit.deployment.GiteaDevServiceInfoBuildItem;
 
 public class GiteaDevUIProcessor {
 
  @BuildStep(onlyIf = IsDevelopment.class)
  void createCard(Optional<GiteaDevServiceInfoBuildItem> info, BuildProducer<CardPageBuildItem> cardPage) {
+ CardPageBuildItem card = new CardPageBuildItem();
+
  info.ifPresent(i -> {
  String url = "http://" + i.host() + ":" + i.httpPort();
- CardPageBuildItem card = new CardPageBuildItem();
  card.addPage(Page.externalPageBuilder("Gitea Dashboard")
  .doNotEmbed()
  .icon("font-awesome-solid:code-branch")
  .url(url, url));
- cardPage.produce(card);
  });
+
+ final ExternalPageBuilder versionPage = Page.externalPageBuilder("JGit Version")
+ .icon("font-awesome-solid:tag")
+ .url("https://www.eclipse.org/jgit/")
+ .doNotEmbed()
+ .staticLabel(Git.class.getPackage().getImplementationVersion());
+
+ card.addPage(versionPage);
+
+ card.setCustomCard("qwc-jgit-card.js");
+ cardPage.produce(card);
  }
-}
+}

deployment/src/main/resources/dev-ui/qwc-jgit-card.js

@@ -0,0 +1,86 @@
+import { LitElement, html, css} from 'lit';
+import { pages } from 'build-time-data';
+import 'qwc/qwc-extension-link.js';
+
+const NAME = "JGit";
+export class QwcJGitCard extends LitElement {
+
+ static styles = css`
+ .identity {
+ display: flex;
+ justify-content: flex-start;
+ }
+
+ .description {
+ padding-bottom: 10px;
+ }
+
+ .logo {
+ padding-bottom: 10px;
+ margin-right: 5px;
+ }
+
+ .card-content {
+ color: var(--lumo-contrast-90pct);
+ display: flex;
+ flex-direction: column;
+ justify-content: flex-start;
+ padding: 2px 2px;
+ height: 100%;
+ }
+
+ .card-content slot {
+ display: flex;
+ flex-flow: column wrap;
+ padding-top: 5px;
+ }
+ `;
+
+ static properties = {
+ description: {type: String}
+ };
+
+ constructor() {
+ super();
+ }
+
+ connectedCallback() {
+ super.connectedCallback();
+ }
+
+ render() {
+ return html`<div class="card-content" slot="content">
+ <div class="identity">
+ <div class="logo">
+ <img src="data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI5MnB0IiBoZWlnaHQ9IjkycHQiIHZpZXdCb3g9IjAgMCA5MiA5MiI+PGRlZnM+PGNsaXBQYXRoIGlkPSJhIj48cGF0aCBkPSJNMCAuMTEzaDkxLjg4N1Y5MkgwWm0wIDAiLz48L2NsaXBQYXRoPjwvZGVmcz48ZyBjbGlwLXBhdGg9InVybCgjYSkiPjxwYXRoIHN0eWxlPSJzdHJva2U6bm9uZTtmaWxsLXJ1bGU6bm9uemVybztmaWxsOiNmMDNjMmU7ZmlsbC1vcGFjaXR5OjEiIGQ9Ik05MC4xNTYgNDEuOTY1IDUwLjAzNiAxLjg0OGE1LjkxOCA1LjkxOCAwIDAgMC04LjM3MiAwbC04LjMyOCA4LjMzMiAxMC41NjYgMTAuNTY2YTcuMDMgNy4wMyAwIDAgMSA3LjIzIDEuNjg0IDcuMDM0IDcuMDM0IDAgMCAxIDEuNjY5IDcuMjc3bDEwLjE4NyAxMC4xODRhNy4wMjggNy4wMjggMCAwIDEgNy4yNzggMS42NzIgNy4wNCA3LjA0IDAgMCAxIDAgOS45NTcgNy4wNSA3LjA1IDAgMCAxLTkuOTY1IDAgNy4wNDQgNy4wNDQgMCAwIDEtMS41MjgtNy42NmwtOS41LTkuNDk3VjU5LjM2YTcuMDQgNy4wNCAwIDAgMSAxLjg2IDExLjI5IDcuMDQgNy4wNCAwIDAgMS05Ljk1NyAwIDcuMDQgNy4wNCAwIDAgMSAwLTkuOTU4IDcuMDYgNy4wNiAwIDAgMSAyLjMwNC0xLjUzOVYzMy45MjZhNy4wNDkgNy4wNDkgMCAwIDEtMy44Mi05LjIzNEwyOS4yNDIgMTQuMjcyIDEuNzMgNDEuNzc3YTUuOTI1IDUuOTI1IDAgMCAwIDAgOC4zNzFMNDEuODUyIDkwLjI3YTUuOTI1IDUuOTI1IDAgMCAwIDguMzcgMGwzOS45MzQtMzkuOTM0YTUuOTI1IDUuOTI1IDAgMCAwIDAtOC4zNzEiLz48L2c+PC9zdmc+"
+ alt="${NAME}" 
+ title="${NAME}"
+ width="32" 
+ height="32">
+ </div>
+ <div class="description">${this.description}</div>
+ </div>
+ ${this._renderCardLinks()}
+ </div>
+ `;
+ }
+
+ _renderCardLinks(){
+ return html`${pages.map(page => html`
+ <qwc-extension-link slot="link"
+ extensionName="${NAME}"
+ iconName="${page.icon}"
+ displayName="${page.title}"
+ staticLabel="${page.staticLabel}"
+ dynamicLabel="${page.dynamicLabel}"
+ streamingLabel="${page.streamingLabel}"
+ path="${page.id}"
+ ?embed=${page.embed}
+ externalUrl="${page.metadata.externalUrl}"
+ webcomponent="${page.componentLink}" >
+ </qwc-extension-link>
+ `)}`;
+ }
+
+}
+customElements.define('qwc-jgit-card', QwcJGitCard);

runtime/src/main/resources/META-INF/quarkus-extension.yaml

@@ -6,5 +6,8 @@ metadata:
  - "git"
  categories:
  - "miscellaneous"
+ config:
+ - "quarkus.jgit."
  guide: https://quarkiverse.github.io/quarkiverse-docs/quarkus-jgit/dev/index.html
- status: "stable"
+ icon-url: "https://raw.githubusercontent.com/quarkiverse/quarkus-jgit/main/docs/modules/ROOT/assets/images/jgit.svg"
+ status: "stable"