Add issues table to function page

Author: FileEX

web/src/pages/reference/[func].astro

@@ -9,7 +9,7 @@ import { Code } from '@astrojs/starlight/components';
 import { MTA_CURRENT_VERSION } from '@src/content.constants';
 
 import NoteBox from '@src/components/NoteBox.astro';
-import type { NotesType } from '@src/utils/types';
+import type { NotesType, IssuesTable } from '@src/utils/types';
 
 import SeeAlsoSection from '@src/components/SeeAlsoSection.astro';
 import CodeExamplesSection from '@src/components/CodeExamplesSection.astro';
@@ -298,6 +298,26 @@ let funcSyntaxes = parseFunctionSyntaxes(func.id, func.data);
         <!-- Changelog -->
         <ChangelogList entries={changelogEntries} />
 
+        <!-- Issues -->
+        {funcInfo.issues && funcInfo.issues.length > 0 && (
+            <h4>Issues</h4>
+            <table>
+                <tbody>
+                    <tr>
+                        <th>ID</th>
+                        <th>Description</th>
+                    </tr>
+
+                {funcInfo.issues.map((issue) => (
+                    <tr>
+                        <td><a href={`https://github.com/multitheftauto/mtasa-blue/issues/${issue.id}`}>{issue.id}</a></td>
+                        <td>{issue.description}</td>
+                    </tr>
+                ))}
+                </tbody>
+            </table>
+        )}
+
         <SeeAlsoSection seeAlsoLinks={getSeeAlsoLinksForItem(func)} currentId={func.id} />
     </StarlightPage>
 </div>

web/src/utils/functions.ts

@@ -1,63 +1,7 @@
 import { getCollection } from 'astro:content';
 import path from 'path';
 
-import type { FunctionType, NotesType } from './types';
-
-type FunctionItem = Awaited<ReturnType<typeof getCollection>>[number];
-
-type BaseOOP = {
-  element: string;
-  note?: string;
-};
-
-// /!\ constructor is a reserved word in JS/TS, so we use constructorclass
-type MethodOOP = BaseOOP & {
-  method: string;
-  static: boolean;
-  variable?: string;
-  constructorclass?: never; // mutually exclusive with constructor
-};
-
-type ConstructorOOP = BaseOOP & {
-  constructorclass: string;
-  method?: never;      // mutually exclusive with method
-  static?: never;
-  variable?: never;
-};
-
-export type OOPInfo = MethodOOP | ConstructorOOP;
-
-export type FunctionInfo = {
-    description: string;
-    incomplete?: boolean;
-    type: FunctionType;
-    typePretty: string;
-    pair?: string;
-    preview_images?: string[];
-    oop?: OOPInfo;
-    notes?: NotesType;
-    version?: VersionInfo
-};
-
-type VersionInfo = {
-  added?: string;
-  updated?: string;
-  removed?: string;
-};
-
-type FunctionsByCategory = {
-    [folder: string]: FunctionItem[];
-};
-type FunctionsByTypeByCategory = {
-    [key in FunctionType]: FunctionsByCategory;
-};
-
-
-export type FunctionData = {
-    shared?: any;
-    client?: any;
-    server?: any;
-};
+import type { FunctionData, FunctionInfo, FunctionsByCategory, FunctionsByTypeByCategory, FunctionType, Parameter, ReturnBlock, Syntax } from './types';
 
 export const functionTypePrettyName = {
     'client': 'Client-side',
@@ -75,34 +19,6 @@ function getFunctionTypePretty(data: FunctionData): string {
     return functionTypePrettyName[funcType];
 }
 
-
-type Parameter = {
-  name: string;
-  type: string;
-  description: string;
-  default?: string;
-  templateList?: string;
-};
-
-type ReturnValue = {
-  type: string;
-  name: string;
-  templateList?: string;
-};
-
-type ReturnBlock = {
-  description?: string;
-  values: ReturnValue[];
-};
-
-type Syntax = {
-  type: 'shared' | 'server' | 'client';
-  parameters: Parameter[];
-  returns: ReturnBlock | null;
-  syntaxString: string;
-};
-
-
 // return_type func_name ( param1, param2, [ optional param1 ] )
 // e.g. bool setCursorPosition ( int cursorX, int cursorY )
 function buildSyntaxString(

web/src/utils/types.ts

@@ -1,6 +1,95 @@
+import type { getCollection } from "astro:content";
+
 export type FunctionType = 'shared' | 'client' | 'server';
 export type NotesTypeType = 'info' | 'warning' | 'important' | 'tip' | 'needs_checking';
 export type NotesType = {
     type: NotesTypeType
     content: string;
-}[];
+}[];
+
+export type FunctionItem = Awaited<ReturnType<typeof getCollection>>[number];
+
+export type BaseOOP = {
+  element: string;
+  note?: string;
+};
+
+// /!\ constructor is a reserved word in JS/TS, so we use constructorclass
+export type MethodOOP = BaseOOP & {
+  method: string;
+  static: boolean;
+  variable?: string;
+  constructorclass?: never; // mutually exclusive with constructor
+};
+
+export type ConstructorOOP = BaseOOP & {
+  constructorclass: string;
+  method?: never;      // mutually exclusive with method
+  static?: never;
+  variable?: never;
+};
+
+export type OOPInfo = MethodOOP | ConstructorOOP;
+
+export type FunctionInfo = {
+    description: string;
+    incomplete?: boolean;
+    type: FunctionType;
+    typePretty: string;
+    pair?: string;
+    preview_images?: string[];
+    oop?: OOPInfo;
+    notes?: NotesType;
+    version?: VersionInfo;
+    issues?: IssuesTable;
+};
+
+export type FunctionData = {
+    shared?: any;
+    client?: any;
+    server?: any;
+};
+
+export type VersionInfo = {
+  added?: string;
+  updated?: string;
+  removed?: string;
+};
+
+export type IssuesTable = {
+    id: number|string
+    description: string
+}[];
+
+export type FunctionsByCategory = {
+    [folder: string]: FunctionItem[];
+};
+export type FunctionsByTypeByCategory = {
+    [key in FunctionType]: FunctionsByCategory;
+};
+
+export type Parameter = {
+  name: string;
+  type: string;
+  description: string;
+  default?: string;
+  templateList?: string;
+};
+
+export type ReturnValue = {
+  type: string;
+  name: string;
+  templateList?: string;
+};
+
+export type ReturnBlock = {
+  description?: string;
+  values: ReturnValue[];
+};
+
+export type Syntax = {
+  type: 'shared' | 'server' | 'client';
+  parameters: Parameter[];
+  returns: ReturnBlock | null;
+  syntaxString: string;
+};