fix(cheatsheet): refactor cheatsheet to use app extensions as source

Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>

frontend/src/components/markdown-renderer/extensions/basic-markdown-syntax/basic-markdown-syntax-app-extension.ts

@@ -0,0 +1,63 @@
+/*
+ * SPDX-FileCopyrightText: 2023 The HedgeDoc developers (see AUTHORS file)
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+import { AppExtension } from '../../../../extensions/base/app-extension'
+import type { CheatsheetExtension } from '../../../editor-page/cheatsheet/cheatsheet-extension'
+import type { MarkdownRendererExtension } from '../base/markdown-renderer-extension'
+import { BasicMarkdownSyntaxMarkdownExtension } from './basic-markdown-syntax-markdown-extension'
+
+export class BasicMarkdownSyntaxAppExtension extends AppExtension {
+  buildMarkdownRendererExtensions(): MarkdownRendererExtension[] {
+    return [new BasicMarkdownSyntaxMarkdownExtension()]
+  }
+
+  buildCheatsheetExtensions(): CheatsheetExtension[] {
+    return [
+      {
+        i18nKey: 'basics.basicFormatting',
+        categoryI18nKey: 'basic'
+      },
+      {
+        i18nKey: 'basics.abbreviation',
+        categoryI18nKey: 'basic'
+      },
+      {
+        i18nKey: 'basics.footnote',
+        categoryI18nKey: 'basic'
+      },
+      {
+        i18nKey: 'basics.headlines',
+        categoryI18nKey: 'basic',
+        entries: [
+          {
+            i18nKey: 'hashtag'
+          },
+          {
+            i18nKey: 'equal'
+          }
+        ]
+      },
+      {
+        i18nKey: 'basics.code',
+        categoryI18nKey: 'basic',
+        entries: [{ i18nKey: 'inline' }, { i18nKey: 'block' }]
+      },
+      {
+        i18nKey: 'basics.lists',
+        categoryI18nKey: 'basic',
+        entries: [{ i18nKey: 'unordered' }, { i18nKey: 'ordered' }]
+      },
+      {
+        i18nKey: 'basics.images',
+        categoryI18nKey: 'basic',
+        entries: [{ i18nKey: 'basic' }, { i18nKey: 'size' }]
+      },
+      {
+        i18nKey: 'basics.links',
+        categoryI18nKey: 'basic'
+      }
+    ]
+  }
+}

frontend/src/components/markdown-renderer/extensions/basic-markdown-syntax/basic-markdown-syntax-markdown-extension.ts

@@ -3,7 +3,7 @@
  *
  * SPDX-License-Identifier: AGPL-3.0-only
  */
-import { MarkdownRendererExtension } from './base/markdown-renderer-extension'
+import { MarkdownRendererExtension } from '../base/markdown-renderer-extension'
 import { imageSize } from '@hedgedoc/markdown-it-plugins'
 import type MarkdownIt from 'markdown-it'
 import abbreviation from 'markdown-it-abbr'
@@ -17,7 +17,7 @@ import superscript from 'markdown-it-sup'
 /**
  * Adds some common markdown syntaxes to the markdown rendering.
  */
-export class GenericSyntaxMarkdownExtension extends MarkdownRendererExtension {
+export class BasicMarkdownSyntaxMarkdownExtension extends MarkdownRendererExtension {
   public configureMarkdownIt(markdownIt: MarkdownIt): void {
     abbreviation(markdownIt)
     definitionList(markdownIt)

frontend/src/components/markdown-renderer/extensions/bootstrap-icons/bootstrap-icon-app-extension.ts

@@ -0,0 +1,19 @@
+/*
+ * SPDX-FileCopyrightText: 2023 The HedgeDoc developers (see AUTHORS file)
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+import { AppExtension } from '../../../../extensions/base/app-extension'
+import type { CheatsheetExtension } from '../../../editor-page/cheatsheet/cheatsheet-extension'
+import type { MarkdownRendererExtension } from '../base/markdown-renderer-extension'
+import { BootstrapIconMarkdownExtension } from './bootstrap-icon-markdown-extension'
+
+export class BootstrapIconAppExtension extends AppExtension {
+  buildMarkdownRendererExtensions(): MarkdownRendererExtension[] {
+    return [new BootstrapIconMarkdownExtension()]
+  }
+
+  buildCheatsheetExtensions(): CheatsheetExtension[] {
+    return [{ i18nKey: 'bootstrapIcon', readMoreUrl: new URL('https://icons.getbootstrap.com/') }]
+  }
+}

frontend/src/components/markdown-renderer/extensions/emoji/emoji-app-extension.ts

@@ -0,0 +1,24 @@
+/*
+ * SPDX-FileCopyrightText: 2023 The HedgeDoc developers (see AUTHORS file)
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+import { AppExtension } from '../../../../extensions/base/app-extension'
+import type { CheatsheetExtension } from '../../../editor-page/cheatsheet/cheatsheet-extension'
+import type { MarkdownRendererExtension } from '../base/markdown-renderer-extension'
+import { EmojiMarkdownExtension } from './emoji-markdown-extension'
+
+export class EmojiAppExtension extends AppExtension {
+  buildMarkdownRendererExtensions(): MarkdownRendererExtension[] {
+    return [new EmojiMarkdownExtension()]
+  }
+
+  buildCheatsheetExtensions(): CheatsheetExtension[] {
+    return [
+      {
+        i18nKey: 'emoji',
+        readMoreUrl: new URL('https://twemoji.twitter.com/')
+      }
+    ]
+  }
+}

frontend/src/components/markdown-renderer/extensions/iframe-capsule/iframe-capsule-app-extension.ts

@@ -0,0 +1,24 @@
+/*
+ * SPDX-FileCopyrightText: 2023 The HedgeDoc developers (see AUTHORS file)
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+import { AppExtension } from '../../../../extensions/base/app-extension'
+import type { CheatsheetExtension } from '../../../editor-page/cheatsheet/cheatsheet-extension'
+import type { MarkdownRendererExtension } from '../base/markdown-renderer-extension'
+import { IframeCapsuleMarkdownExtension } from './iframe-capsule-markdown-extension'
+
+export class IframeCapsuleAppExtension extends AppExtension {
+  buildMarkdownRendererExtensions(): MarkdownRendererExtension[] {
+    return [new IframeCapsuleMarkdownExtension()]
+  }
+
+  buildCheatsheetExtensions(): CheatsheetExtension[] {
+    return [
+      {
+        i18nKey: 'iframeCapsule',
+        categoryI18nKey: 'embedding'
+      }
+    ]
+  }
+}

frontend/src/components/markdown-renderer/extensions/image-placeholder/image-placeholder-app-extension.ts

@@ -0,0 +1,23 @@
+/*
+ * SPDX-FileCopyrightText: 2023 The HedgeDoc developers (see AUTHORS file)
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+import { AppExtension } from '../../../../extensions/base/app-extension'
+import type { CheatsheetExtension } from '../../../editor-page/cheatsheet/cheatsheet-extension'
+import type { MarkdownRendererExtension } from '../base/markdown-renderer-extension'
+import { ImagePlaceholderMarkdownExtension } from './image-placeholder-markdown-extension'
+
+export class ImagePlaceholderAppExtension extends AppExtension {
+  buildMarkdownRendererExtensions(): MarkdownRendererExtension[] {
+    return [new ImagePlaceholderMarkdownExtension()]
+  }
+
+  buildCheatsheetExtensions(): CheatsheetExtension[] {
+    return [
+      {
+        i18nKey: 'imagePlaceholder'
+      }
+    ]
+  }
+}

frontend/src/components/markdown-renderer/extensions/table-of-contents/table-of-contents-app-extension.ts

@@ -0,0 +1,32 @@
+/*
+ * SPDX-FileCopyrightText: 2023 The HedgeDoc developers (see AUTHORS file)
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+import { AppExtension } from '../../../../extensions/base/app-extension'
+import type { CheatsheetExtension } from '../../../editor-page/cheatsheet/cheatsheet-extension'
+import type { MarkdownRendererExtension } from '../base/markdown-renderer-extension'
+import { TableOfContentsMarkdownExtension } from './table-of-contents-markdown-extension'
+import type EventEmitter2 from 'eventemitter2'
+
+export class TableOfContentsAppExtension extends AppExtension {
+  buildMarkdownRendererExtensions(eventEmitter?: EventEmitter2): MarkdownRendererExtension[] {
+    return [new TableOfContentsMarkdownExtension(eventEmitter)]
+  }
+
+  buildCheatsheetExtensions(): CheatsheetExtension[] {
+    return [
+      {
+        i18nKey: 'toc',
+        entries: [
+          {
+            i18nKey: 'basic'
+          },
+          {
+            i18nKey: 'levelLimit'
+          }
+        ]
+      }
+    ]
+  }
+}

frontend/src/components/markdown-renderer/extensions/table-of-contents/table-of-contents-markdown-extension.ts

@@ -1,10 +1,10 @@
 /*
- * SPDX-FileCopyrightText: 2022 The HedgeDoc developers (see AUTHORS file)
+ * SPDX-FileCopyrightText: 2023 The HedgeDoc developers (see AUTHORS file)
  *
  * SPDX-License-Identifier: AGPL-3.0-only
  */
-import { tocSlugify } from '../../editor-page/table-of-contents/toc-slugify'
-import { MarkdownRendererExtension } from './base/markdown-renderer-extension'
+import { tocSlugify } from '../../../editor-page/table-of-contents/toc-slugify'
+import { MarkdownRendererExtension } from '../base/markdown-renderer-extension'
 import type { TocAst } from '@hedgedoc/markdown-it-plugins'
 import { toc } from '@hedgedoc/markdown-it-plugins'
 import equal from 'fast-deep-equal'

frontend/src/components/markdown-renderer/hooks/use-markdown-extensions.ts

@@ -1,20 +1,14 @@
 /*
- * SPDX-FileCopyrightText: 2022 The HedgeDoc developers (see AUTHORS file)
+ * SPDX-FileCopyrightText: 2023 The HedgeDoc developers (see AUTHORS file)
  *
  * SPDX-License-Identifier: AGPL-3.0-only
  */
 import { optionalAppExtensions } from '../../../extensions/extra-integrations/optional-app-extensions'
 import type { MarkdownRendererExtension } from '../extensions/base/markdown-renderer-extension'
-import { BootstrapIconMarkdownExtension } from '../extensions/bootstrap-icons/bootstrap-icon-markdown-extension'
 import { DebuggerMarkdownExtension } from '../extensions/debugger-markdown-extension'
-import { EmojiMarkdownExtension } from '../extensions/emoji/emoji-markdown-extension'
-import { GenericSyntaxMarkdownExtension } from '../extensions/generic-syntax-markdown-extension'
-import { IframeCapsuleMarkdownExtension } from '../extensions/iframe-capsule/iframe-capsule-markdown-extension'
-import { ImagePlaceholderMarkdownExtension } from '../extensions/image-placeholder/image-placeholder-markdown-extension'
 import { ProxyImageMarkdownExtension } from '../extensions/image/proxy-image-markdown-extension'
 import { LinkAdjustmentMarkdownExtension } from '../extensions/link-replacer/link-adjustment-markdown-extension'
 import { LinkifyFixMarkdownExtension } from '../extensions/linkify-fix/linkify-fix-markdown-extension'
-import { TableOfContentsMarkdownExtension } from '../extensions/table-of-contents-markdown-extension'
 import { UploadIndicatingImageFrameMarkdownExtension } from '../extensions/upload-indicating-image-frame/upload-indicating-image-frame-markdown-extension'
 import { useExtensionEventEmitter } from './use-extension-event-emitter'
 import { useMemo } from 'react'
@@ -35,14 +29,8 @@ export const useMarkdownExtensions = (
     return [
       ...optionalAppExtensions.flatMap((extension) => extension.buildMarkdownRendererExtensions(extensionEventEmitter)),
       ...additionalExtensions,
-      new TableOfContentsMarkdownExtension(),
-      new IframeCapsuleMarkdownExtension(),
-      new ImagePlaceholderMarkdownExtension(),
       new UploadIndicatingImageFrameMarkdownExtension(),
       new LinkAdjustmentMarkdownExtension(baseUrl),
-      new EmojiMarkdownExtension(),
-      new BootstrapIconMarkdownExtension(),
-      new GenericSyntaxMarkdownExtension(),
       new LinkifyFixMarkdownExtension(),
       new DebuggerMarkdownExtension(),
       new ProxyImageMarkdownExtension()