[#467] Add Title Component

docs/ug/cli.md

@@ -31,7 +31,8 @@ The section below provides explanations for each of the flags.
 <div id="section-assets">
 
 **`--assets ASSETS_DIRECTORY`**: Specifies where to place assets for report generation.
-* Parameter: `ASSETS_DIRECTORY` The directory containing the assets files. A `favicon.ico` file can be placed here to customize the favicon of the dashboard.
+* Parameter: `ASSETS_DIRECTORY` The directory containing the assets files. A `favicon.ico` file can be placed here to customize the favicon of the dashboard,
+while a `title.md` file can be placed to customize the header of the report using [Markdown syntax](https://www.markdownguide.org/basic-syntax/).
 * Alias: `-a`
 * Example: `--assets ./assets` or `-a ./assets`
 

frontend/package.json

@@ -19,15 +19,18 @@
  "@fortawesome/free-brands-svg-icons": "^6.0.0",
  "@fortawesome/free-solid-svg-icons": "^6.0.0",
  "@fortawesome/vue-fontawesome": "^3.0.3",
+ "@types/markdown-it": "^13.0.7",
  "@types/minimatch": "^5.1.2",
  "@types/seedrandom": "^3.0.5",
  "core-js": "^3.6.5",
  "highlight.js": "^10.5.0",
  "jszip": "^3.5.0",
+ "markdown-it": "^14.0.0",
  "minimatch": "^5.0.1",
  "muicss": "^0.10.3",
  "normalize.css": "^8.0.1",
  "pug-lint-vue": "^0.4.0",
+ "raw-loader": "^4.0.2",
  "seedrandom": "^3.0.5",
  "vue": "^3.2.47",
  "vue-loading-overlay": "^5.0.3",

frontend/src/components/c-title.vue

@@ -0,0 +1,39 @@
+<template lang="pug">
+.title(v-html="markdownText", v-if="markdownText != ''")
+</template>
+
+<script lang="ts">
+import MarkdownIt from 'markdown-it';
+import { defineComponent } from 'vue';
+
+export default defineComponent({
+ data() {
+ return {
+ markdownText: '',
+ };
+ },
+ beforeMount() {
+ try {
+ fetch('title.md').then((response) => {
+ if (!response.ok) { // file not found
+ return '';
+ }
+ return response.text();
+ }).then((text) => {
+ const md = new MarkdownIt();
+ this.markdownText = md.render(text);
+ });
+ } catch (error) {
+ this.markdownText = (error as Error).toString();
+ }
+ },
+});
+</script>
+
+<style lang="scss" scoped>
+.title {
+ padding: 2rem 1.5rem;
+ // This is needed because the parent summary-wrapper center aligns everything
+ text-align: initial;
+}
+</style>

frontend/src/shims-vue.d.ts

@@ -4,3 +4,8 @@ declare module '*.vue' {
  const component: DefineComponent<{}, {}, any>
  export default component
 }
+
+declare module '*.md' {
+ const str: string
+ export default str
+}

frontend/src/styles/panels.scss

@@ -9,7 +9,6 @@
  display: flex;
  height: 100vh;
  left: 0;
- position: absolute;
  top: 0;
  width: 100%;
  z-index: z-index('app-wrapper');

frontend/src/views/c-home.vue

@@ -4,6 +4,7 @@
  c-resizer
  template(v-slot:left)
  #summary-wrapper
+ c-title(ref="cTitle")
  c-summary.tab-padding(
  ref="summary",
  v-bind:repos="users",
@@ -69,6 +70,7 @@
 <script lang='ts'>
 import { defineComponent } from 'vue';
 
+import cTitle from '../components/c-title.vue';
 import cResizer from '../components/c-resizer.vue';
 import cZoom from './c-zoom.vue';
 import cSummary from './c-summary.vue';
@@ -77,6 +79,7 @@ import cAuthorship from './c-authorship.vue';
 const home = defineComponent({
  name: 'c-home',
  components: {
+ cTitle,
  cResizer,
  cZoom,
  cSummary,

frontend/vue.config.js

@@ -15,6 +15,15 @@ module.exports = {
  files: ['src/**/*.{vue,scss}'],
  }),
  ],
+ module: {
+ rules: [
+ // Markdown Loader
+ {
+ test: /\.md$/,
+ loader: "raw-loader",
+ },
+ ],
+ }
  },
  chainWebpack: (config) => {
  // Pug Loader

src/main/java/reposense/report/ReportGenerator.java

@@ -87,7 +87,7 @@ public class ReportGenerator {
  private static final String LOG_ERROR_CLONING_OR_BRANCHING = "Exception met while cloning or checking out.";
  private static final String LOG_UNEXPECTED_ERROR = "Unexpected error stack trace for %s:\n>%s";
  private static final List<String> assetsFilesWhiteList =
- Collections.unmodifiableList(Arrays.asList(new String[] {"favicon.ico"}));
+ Collections.unmodifiableList(Arrays.asList(new String[] {"favicon.ico", "title.md"}));
 
  private LocalDateTime earliestSinceDate = null;
  private ProgressTracker progressTracker = null;