display message for deprecated functions in docs

Author: maxdew-envelio

package/src/array/difference.ts

@@ -4,11 +4,11 @@ import type { ArrayMinLength } from "@type/ArrayMinLength.js";
 import { fastArrayFlat } from "@helpers/fastArrayFlat.js";
 
 /**
- * @deprecated **Deprecated: Use the native [Set.prototype.difference()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set/difference) function instead.**
- * 
  * Create a new array with values from the first array that are not present in the other arrays.
  * Optionally, use a compare function to determine the comparison of elements (default is `===`).
  * 
+ * @deprecated 
+ * **Deprecated: Use the native [Set.prototype.difference()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set/difference) function instead.**
  * 
  * @example
  * difference([2, 1], [2, 3], [6])
@@ -25,12 +25,12 @@ import { fastArrayFlat } from "@helpers/fastArrayFlat.js";
  *
  * difference(arr1, arr2, (a, b) => a.id === b.id)
  * // => [{ id: 1, name: 'Yeet' }]
+ * 
  * @param arraysOrCompareFn Two or more arrays with an optional compare function at the end
  * @template TElem The type of the array elements
  * @template TArrays The type of the arrays provided
  * @returns Returns a new array of filtered values
  */
-
 export function difference<TElem>(...arraysOrCompareFn: ArrayMinLength<TElem[], 2>): TElem[];
 export function difference<TArrays extends ArrayMinLength<unknown[], 2>>(...arraysOrCompareFn: [...TArrays, CompareFunction<TArrays>]): TArrays[0];
 export function difference<TArrays extends ArrayMinLength<unknown[], 2>, TElem>(...arraysOrCompareFn: ArrayMinLength<TElem[], 2> | [...TArrays, CompareFunction<TArrays>]): TArrays[0] {
@@ -54,4 +54,4 @@ export function difference<TArrays extends ArrayMinLength<unknown[], 2>, TElem>(
     }
 
     return difference;
-}
+}

package/src/array/group.ts

@@ -1,6 +1,8 @@
 /**
  * Creates an object with grouped items in the array.
- * @deprecated Use the javascript "Object.groupBy()" version instead.
+ * 
+ * @deprecated
+ * **Deprecated: Use the native "Object.groupBy()" function instead.**
  * 
  * @example
  * group([6.1, 4.2, 6.3], Math.floor)

package/src/array/intersection.ts

@@ -6,13 +6,14 @@ import { fastArrayFlat } from "@helpers/fastArrayFlat.js";
 import { unique } from "./unique.js";
 
 /**
- * @deprecated **Deprecated: Use the native [Set.prototype.intersection()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set/intersection) function instead.**
- * 
  * Create an array with unique values that are present in all arrays.  
  * The order of the values is based on the first array. 
  * 
  * Optionally, use a compare function for element comparison (default is `===`).
  * 
+ * @deprecated 
+ * **Deprecated: Use the native [Set.prototype.intersection()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set/intersection) function instead.**
+ * 
  * @example
  * intersection([2, 1], [2, 3], [6, 2])
  * // => [2]

package/src/validate/isUrl.ts

@@ -1,6 +1,8 @@
 /**
  * Checks if given string is a valid URL
- * @deprecated Use the native "URL.canParse" method instead.
+ * 
+ * @deprecated 
+ * **Deprecated: Use the native "URL.canParse" method instead.**
  * 
  * @example
  * isUrl('https://google.com')

website/src/components/Meta.svelte

@@ -1,11 +1,11 @@
 <script lang="ts">
     import { MetaTags } from "svelte-meta-tags";
 
-
-    import { page } from "$app/stores";
     import icon from "$assets/moderndashIcon.svg?url";
     import logo from "$assets/moderndashLogo.svg?url";
 
+    import { page } from "$app/stores";
+
     export let title = "";
     export let description = "ModernDash is a modern and lightweight alternative to utility libraries like Lodash. It provides important functions while encouraging use of native JS where possible.";
 

website/src/routes/docs/[method]/+page.server.ts

@@ -5,7 +5,7 @@ import { unique } from "moderndash";
 import { docData } from "$utils/docData.js";
 import { markdownParser } from "$utils/markdown.js";
 
-export const load: PageServerLoad = (({ params }) => {
+export const load: PageServerLoad = (async ({ params }) => {
     const methodName = params.method;
 
     const methodDoc = docData.functions.find(func => func.name.toLowerCase() === methodName.toLowerCase());
@@ -14,27 +14,30 @@ export const load: PageServerLoad = (({ params }) => {
 
     const signature = methodDoc?.signatures[0] ?? typeDoc ?? classDoc;
     const fileSource = methodDoc?.source ?? typeDoc?.source ?? classDoc?.source;
+    const deprecated = signature?.comment.blockTags.find(tag => tag.name === "deprecated")?.text;
 
     if (!signature) return { status: 404 };
 
     const codeMarkdown = signature.comment.blockTags.find(tag => tag.name === "example")?.text;
     const code = getEmbedCode(signature.name, codeMarkdown);
 
     const description = signature.comment.description ?? "No description";
-    const parsedMarkdown = markdownParser(description).replace(/{@link ([^}]+)}/g, '<a href="/docs/$1">$1</a>');
+    let [parsedDescription, parsedDeprecated] = await Promise.all([markdownParser(description), markdownParser(deprecated ?? "")]);
+    parsedDescription = parsedDescription.replaceAll(/{@link ([^}]+)}/g, '<a href="/docs/$1">$1</a>');
 
     return {
         name: methodDoc?.name ?? typeDoc?.name ?? classDoc?.name,
         description,
+        parsedDeprecated,
         code,
-        parsedMarkdown,
+        parsedDescription,
         path: fileSource && (fileSource.path + "/" + fileSource.file)
     };
 });
 
-function getEmbedCode(functionName: string, codetext: string | undefined) {
-    if (!codetext) return "";
-    let code = codetext.replace(/```(ts|typescript)\n/, "").replace("```", "");
+function getEmbedCode(functionName: string, codeText: string | undefined) {
+    if (!codeText) return "";
+    let code = codeText.replace(/```(ts|typescript)\n/, "").replace("```", "");
 
     // Deals with Top Level Await Bug in Stackblitz
     if (code.includes("await")) {
@@ -46,7 +49,7 @@ function getEmbedCode(functionName: string, codetext: string | undefined) {
 
 
 function generateImportString(functionName: string, code: string) {
-    const codeWithOutComments = code.replace(/\/\*[\S\s]*?\*\/|(?<=[^:])\/\/.*|^\/\/.*/g, "");
+    const codeWithOutComments = code.replaceAll(/\/\*[\S\s]*?\*\/|(?<=[^:])\/\/.*|^\/\/.*/g, "");
     const foundFunctionNames = codeWithOutComments.match(
         new RegExp(`(?<!\\.)\\b(${docData.functions.map(func => func.name).join("|")})\\b`, "g")
     );

website/src/routes/docs/[method]/+page.svelte

@@ -10,16 +10,22 @@
     $: name = data.name;
     $: description = data.description;
     $: code = data.code;
-    $: parsedMarkdown = data.parsedMarkdown;
+    $: parsedDescription = data.parsedDescription;
     $: path = data.path;
+    $: parsedDeprecated = data.parsedDeprecated;
 </script>
 
 <Meta title={name} {description}/>
 
 {#if name}
     <h2>{name}</h2>
-    {@html parsedMarkdown}
 
+    {#if parsedDeprecated}
+        {@html parsedDeprecated}
+    {/if}
+
+    {@html parsedDescription}
+  
     {#if code}
         <h3>Example</h3>
         <Playground {code}/>