Adding issues for TODOs

Signed-off-by: Yannick Bungers <git@innay.de>

backend/src/config/auth.config.ts

@@ -299,6 +299,7 @@ export default registerAs('authConfig', () => {
       idpCert: process.env[`HD_AUTH_SAML_${samlName}_IDP_CERT`],
       clientCert: process.env[`HD_AUTH_SAML_${samlName}_CLIENT_CERT`],
       // ToDo: (default: config.serverURL) will be build on-the-fly in the config/index.js from domain, urlAddPort and urlPath.
+      //  https://github.com/hedgedoc/hedgedoc/issues/5043
       issuer: process.env[`HD_AUTH_SAML_${samlName}_ISSUER`],
       identifierFormat:
         process.env[`HD_AUTH_SAML_${samlName}_IDENTIFIER_FORMAT`],

backend/src/identity/identity.service.ts

@@ -106,7 +106,7 @@ export class IdentityService {
         shouldSave = true;
       }
       if (profilePicture) {
-        // ToDo: sync image
+        // ToDo: sync image (https://github.com/hedgedoc/hedgedoc/issues/5032)
       }
       if (shouldSave) {
         identity.user = Promise.resolve(user);

backend/src/logger/console-logger.service.ts

@@ -149,7 +149,7 @@ export class ConsoleLoggerService implements LoggerService {
       day: '2-digit',
       month: '2-digit',
     };
-    //TODO make timestamp optional
+    //TODO make timestamp optional (https://github.com/hedgedoc/hedgedoc/issues/5033)
     const timestamp = new Date(Date.now()).toLocaleString(
       undefined,
       localeStringOptions,

backend/src/monitoring/monitoring.service.ts

@@ -10,8 +10,7 @@ import { ServerStatusDto } from './server-status.dto';
 
 @Injectable()
 export class MonitoringService {
-  // TODO Implement Server Status and other routes
+  // TODO Implement Server Status and other routes (https://github.com/hedgedoc/hedgedoc/issues/478)
-  // (https://github.com/hedgedoc/hedgedoc/issues/478)
   async getServerStatus(): Promise<ServerStatusDto> {
     return {
       connectionSocketQueueLength: 0,

backend/src/realtime/websocket/websocket.gateway.ts

@@ -67,6 +67,7 @@ export class WebsocketGateway implements OnGatewayConnection {
       );
       if (notePermission < NotePermission.READ) {
         //TODO: [mrdrogdrog] inform client about reason of disconnect.
+        // (https://github.com/hedgedoc/hedgedoc/issues/5034)
         this.logger.log(
           `Access denied to note '${note.id}' for user '${username}'`,
           'handleConnection',

backend/test/app.e2e-spec.ts

@@ -46,9 +46,9 @@ describe('App', () => {
 
     /**
      * TODO: This is not really a regression test, as it does not use the
-     * real initialization code in main.ts.
+     *  real initialization code in main.ts.
-     * Should be fixed after https://github.com/hedgedoc/hedgedoc/issues/2083
+     *  Should be fixed after https://github.com/hedgedoc/hedgedoc/issues/2083
-     * is done.
+     *  is done.
      */
     const app = moduleRef.createNestApplication();
     app.useWebSocketAdapter(new WsAdapter(app));

frontend/cypress/e2e/linkEmbedder.spec.ts

@@ -9,7 +9,9 @@ describe('Link gets replaced with embedding: ', () => {
     cy.visitTestNote()
   })
 
-  // TODO Add general testing of one-click-embedding component. The tests below just test a specific use of the component.
+  // TODO Add general testing of one-click-embedding component.
+  //  The tests below just test a specific use of the component.
+  //  https://github.com/hedgedoc/hedgedoc/issues/5039
 
   it('GitHub Gist', () => {
     cy.setCodemirrorContent('https://gist.github.com/schacon/1')

frontend/src/api/common/api-response.ts

@@ -47,7 +47,7 @@ export class ApiResponse<ResponseType> {
       throw new Error('Response body does not seem to be JSON encoded.')
     }
     // TODO Responses should better be type validated
-    // see https://github.com/hedgedoc/hedgedoc/issues/2910
+    //  see https://github.com/hedgedoc/hedgedoc/issues/2910
     return (await this.response.json()) as ResponseType
   }
 }

frontend/src/api/notes/index.ts

@@ -86,7 +86,7 @@ export const deleteNote = async (noteIdOrAlias: string): Promise<void> => {
     .withJsonBody({
       keepMedia: false
       // TODO Ask whether the user wants to keep the media uploaded to the note.
-      // https://github.com/hedgedoc/hedgedoc/issues/2928
+      //  https://github.com/hedgedoc/hedgedoc/issues/2928
     })
     .sendRequest()
 }

frontend/src/app/(editor)/n/[noteId]/page.tsx

@@ -30,8 +30,7 @@ const EditorPage: NextPage<PageParams> = ({ params }) => {
 
 /*
  TODO: implement these in generateMetadata. We need these only in SSR.
-
+  See https://github.com/hedgedoc/hedgedoc/issues/4766
- See https://github.com/hedgedoc/hedgedoc/issues/4766
 
  But its problematic because we dont get the opengraph meta data via API.
 

frontend/src/components/editor-page/sidebar/sidebar.tsx

@@ -66,6 +66,7 @@ export const Sidebar: React.FC = () => {
           onClick={toggleValue}
         />
         <ShareNoteSidebarEntry hide={selectionIsNotNone} />
+        {/* TODO only show if user has permissions (Owner) (https://github.com/hedgedoc/hedgedoc/issues/5036) */}
         <DeleteNoteSidebarEntry hide={selectionIsNotNone} />
         <PinNoteSidebarEntry hide={selectionIsNotNone} />
       </div>

frontend/src/components/editor-page/sidebar/specific-sidebar-entries/revisions-sidebar-entry/revisions-modal/revision-modal-footer.tsx

@@ -42,7 +42,7 @@ export const RevisionModalFooter: React.FC<RevisionModalFooterProps> = ({
 
   const onRevertToRevision = useCallback(() => {
     // TODO Websocket message handler missing
-    // see https://github.com/hedgedoc/hedgedoc/issues/1984
+    //  see https://github.com/hedgedoc/hedgedoc/issues/1984
     window.alert('Not yet implemented. Requires websocket.')
   }, [])
 

frontend/src/components/history-page/entry-menu/entry-menu.tsx

@@ -76,7 +76,7 @@ export const EntryMenu: React.FC<EntryMenuProps> = ({
 
         <RemoveNoteEntryItem onConfirm={onRemoveFromHistory} noteTitle={title} />
 
-        {/* TODO Check permissions (ownership) before showing option for delete  */}
+        {/* TODO Check permissions (ownership) before showing option for delete  (https://github.com/hedgedoc/hedgedoc/issues/5036)*/}
         <ShowIf condition={userExists}>
           <Dropdown.Divider />
           <DeleteNoteItem onConfirm={onDeleteNote} noteTitle={title} />

frontend/src/components/history-page/history-toolbar/import-history-button.tsx

@@ -65,6 +65,7 @@ export const ImportHistoryButton: React.FC = () => {
       }
       //TODO: [mrdrogdrog] The following whole block can be shortened using our `readFile` util.
       // But I won't do it right now because the whole components needs a make over and that's definitely out of scope for my current PR.
+      // https://github.com/hedgedoc/hedgedoc/issues/5042
       const fileReader = new FileReader()
       fileReader.onload = (event) => {
         if (event.target && event.target.result) {

frontend/src/components/render-page/renderers/document/width-based-table-of-contents.tsx

@@ -22,7 +22,7 @@ const MAX_WIDTH_FOR_BUTTON_VISIBILITY = 1100
  *
  * @param tocAst the {@link TocAst AST} that should be rendered.
  * @param width the width that should be used to determine if the button should be shown.
- * @param baseUrl the base url that will be used to generate the links //TODO: replace with consumer/provider
+ * @param baseUrl the base url that will be used to generate the links //TODO: replace with consumer/provider (https://github.com/hedgedoc/hedgedoc/issues/5035)
  */
 export const WidthBasedTableOfContents: React.FC<DocumentExternalTocProps> = ({ tocAst, width, baseUrl }) => {
   if (width >= MAX_WIDTH_FOR_BUTTON_VISIBILITY) {

frontend/src/extensions/essential-app-extensions/fork-awesome-html-tag/fork-awesome-html-tag-app-extension.ts

@@ -18,7 +18,8 @@ export class ForkAwesomeHtmlTagAppExtension extends AppExtension {
     return [
       new SingleLineRegexLinter(
         forkAwesomeRegex,
-        t('editor.linter.fork-awesome', { link: 'https://docs.hedgedoc.org' }) // ToDo: Add correct link here
+        // ToDo: Add correct link here (https://github.com/hedgedoc/hedgedoc/issues/5021)
+        t('editor.linter.fork-awesome', { link: 'https://docs.hedgedoc.org' })
       )
     ]
   }