utilities cleanup

src/utilities/dom.ts

@@ -1,7 +1,7 @@
 import rfdc from 'rfdc'
 
 import { type DateRange } from 'src/types/shared/dateRange'
-import { type FilterState } from 'src/types/shared/filter'
+import { type FilterState } from 'src/types/projects/filter'
 
 export const deepCopy = rfdc()
 

src/utilities/fetch.ts

@@ -1,6 +1,6 @@
 import DOMPurify from 'dompurify'
-import yaml from 'js-yaml'
 import { marked } from 'marked'
+import yaml from 'js-yaml'
 
 /**
  * Config used for DOMPurify.

src/utilities/marked.ts

@@ -6,6 +6,11 @@ let sectionLevel = 1
 const sectionRegexps = new Array(7).fill(undefined).map((_, i) => new RegExp(`^ {0,3}(#{${i + 1}} )[^]*?(?:\\n(?=\\1)|$)`))
 const headingRegex = new RegExp(/^ {0,3}(#{1,6})(?=\s|$)(.*)(?:\n+|$)/)
 
+/**
+ * Extension which creates sections for each heading found in a markdown document,
+ * using the {@link GithubSlugger} to additionally create id's for each section.
+ * @returns marked extension factory
+ */
 export const headingSectionsExtension = (): MarkedExtension => {
   return {
     hooks: {

src/utilities/vuetils.ts

@@ -1,6 +1,12 @@
 import { useRoute } from 'vue-router'
 import { deepCopy } from './dom'
 
+/**
+ * Gets the current route from useRoute
+ * after performing some additional checks
+ * to ensure consistency across the site.
+ * @returns a slightly modified {@link useRoute} route
+ */
 export const getCurrentRoute = () => {
   const route = deepCopy(useRoute())
   if (route.path !== '/' && route.path.endsWith('/')) {