[DO-557] handle trailing slashes (#42)

* Functionality implemented
* Type error fix
* util function renamed
* util function file renamed
* undefined input disabled
* make linter happy
* Update components/ep/layout/SurroundDocCard.vue

---------

Co-authored-by: Nikolai Dorofeev <[email protected]>

Author: StanG4313

components/content/ProseA.vue

@@ -0,0 +1,37 @@
+<!--
+  ~ Copyright 2023 Exactpro (Exactpro Systems Limited)
+  ~
+  ~ Licensed under the Apache License, Version 2.0 (the "License");
+  ~ you may not use this file except in compliance with the License.
+  ~ You may obtain a copy of the License at
+  ~
+  ~     http://www.apache.org/licenses/LICENSE-2.0
+  ~
+  ~ Unless required by applicable law or agreed to in writing, software
+  ~ distributed under the License is distributed on an "AS IS" BASIS,
+  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  ~ See the License for the specific language governing permissions and
+  ~ limitations under the License.
+  -->
+
+<script setup lang="ts">
+import { withTrailingSlash } from '../../utils/navigation'
+
+defineProps({
+  href: {
+    type: String,
+    default: ''
+  },
+  target: {
+    type: String,
+    default: undefined,
+    required: false
+  }
+})
+</script>
+
+<template>
+  <NuxtLink :href="withTrailingSlash(href)" :target="target">
+    <slot />
+  </NuxtLink>
+</template>

components/ep/layout/ContentNavigationItem.vue

@@ -32,7 +32,7 @@
         @click="showChildren = !showChildren"
       />
       <NuxtLink
-        :to="navItem._path"
+        :to="withTrailingSlash(navItem._path)"
         class="w-full"
         @click="showContentTree = false"
       >
@@ -55,6 +55,7 @@
 <script lang="ts">
 import { defineComponent } from 'vue'
 import { NavItem } from '@nuxt/content/dist/runtime/types'
+import { withTrailingSlash } from '../../../utils/navigation'
 
 export default defineComponent({
   name: 'ContentNavigationItem',
@@ -71,7 +72,8 @@ export default defineComponent({
   setup() {
     return {
       showChildren: ref(false),
-      showContentTree: useShowContentTree()
+      showContentTree: useShowContentTree(),
+      withTrailingSlash
     }
   },
   computed: {

components/ep/layout/SurroundDocCard.vue

@@ -16,6 +16,7 @@
 
 <script lang="ts">
 import { ParsedContent } from '@nuxt/content/dist/runtime/types'
+import { withTrailingSlash } from '../../../utils/navigation'
 export default {
   name: 'EpLayoutSurroundDocCard'
 }
@@ -30,7 +31,7 @@ defineProps<{
 
 <template>
   <NuxtLink
-    :to="doc._path"
+    :to="withTrailingSlash(doc._path ?? '')"
     class="block max-w-sm p-6 bg-white border border-gray-200 rounded-lg shadow hover:bg-gray-100 dark:bg-gray-800 dark:border-gray-700 dark:hover:bg-gray-700"
   >
     <div>

server/routes/sitemap.xml.ts

@@ -16,6 +16,7 @@
 
 import { SitemapStream, streamToPromise } from 'sitemap'
 import { joinURL, parseURL, withProtocol } from 'ufo'
+import { withTrailingSlash } from '../../utils/navigation'
 import { serverQueryContent } from '#content/server'
 const appConfig = useAppConfig()
 
@@ -38,7 +39,7 @@ export default defineEventHandler(async (event) => {
       continue
     }
     sitemap.write({
-      url: joinURL(path.pathname, doc._path),
+      url: withTrailingSlash(joinURL(path.pathname, doc._path)),
       changefreq: 'monthly'
     })
   }

utils/navigation.ts

@@ -0,0 +1,21 @@
+/*
+ * Copyright 2023 Exactpro (Exactpro Systems Limited)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { withTrailingSlash as ufoWithTrailingSlash } from 'ufo'
+
+export function withTrailingSlash(str: string): string {
+  return ufoWithTrailingSlash(str)
+}