0.2.18

PlayForm · Oct 17, 2023 · 6e7310c · 6e7310c
1 parent 6ac707d
commit 6e7310c
Show file tree

Hide file tree

Showing 77 changed files with 926 additions and 363 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 0.2.18
+
+-   Cleanup
+
 ## 0.2.17
 
 -   Cleanup

diff --git a/Documentation/Class/Theme.Theme.html b/Documentation/Class/Theme.Theme.html
diff --git a/Documentation/Function/Build.Build.html b/Documentation/Function/Build.Build.html
diff --git a/Documentation/Function/Build.Exec.html b/Documentation/Function/Build.Exec.html
diff --git a/Documentation/Function/Build.Merge.html b/Documentation/Function/Build.Merge.html
diff --git a/Documentation/Function/Build.resolve.html b/Documentation/Function/Build.resolve.html
diff --git a/Documentation/Function/Exec.Exec.html b/Documentation/Function/Exec.Exec.html
diff --git a/Documentation/Function/File.File.html b/Documentation/Function/File.File.html
diff --git a/Documentation/Function/JSON.JSON.html b/Documentation/Function/JSON.JSON.html
diff --git a/Documentation/Function/Load.load-1.html b/Documentation/Function/Load.load-1.html
diff --git a/Documentation/Function/Merge.Merge.html b/Documentation/Function/Merge.Merge.html
diff --git a/Documentation/Function/Theme.applyAnchorUrl.html b/Documentation/Function/Theme.applyAnchorUrl.html
diff --git a/Documentation/Function/Theme.getUrl.html b/Documentation/Function/Theme.getUrl.html
diff --git a/Documentation/Interface/Build.Type.html b/Documentation/Interface/Build.Type.html
diff --git a/Documentation/Interface/Exec.Type.html b/Documentation/Interface/Exec.Type.html
diff --git a/Documentation/Interface/File.Type.html b/Documentation/Interface/File.Type.html
diff --git a/Documentation/Interface/Mapping.Type.html → ...ion/Interface/Interface_Mapping.Type.html b/Documentation/Interface/Mapping.Type.html → ...ion/Interface/Interface_Mapping.Type.html
diff --git a/Documentation/Interface/Interface_Merge.Generic.html b/Documentation/Interface/Interface_Merge.Generic.html
diff --git a/Documentation/Interface/Interface_Merge.Type.html b/Documentation/Interface/Interface_Merge.Type.html
diff --git a/Documentation/Interface/Interface_Theme.Type.html b/Documentation/Interface/Interface_Theme.Type.html
diff --git a/Documentation/Interface/JSON.Type.html b/Documentation/Interface/JSON.Type.html
diff --git a/Documentation/Interface/Load.Type.html b/Documentation/Interface/Load.Type.html
diff --git a/Documentation/Module/Build.html b/Documentation/Module/Build.html
diff --git a/Documentation/Module/ESBuild.html b/Documentation/Module/ESBuild.html
diff --git a/Documentation/Module/Exec.html b/Documentation/Module/Exec.html
diff --git a/Documentation/Module/File.html b/Documentation/Module/File.html
diff --git a/Documentation/Module/Interface_Value.html → Documentation/Module/Interface_Mapping.html b/Documentation/Module/Interface_Value.html → Documentation/Module/Interface_Mapping.html
diff --git a/Documentation/Module/Interface_Merge.html b/Documentation/Module/Interface_Merge.html
diff --git a/Documentation/Module/Interface_Theme.html b/Documentation/Module/Interface_Theme.html
diff --git a/Documentation/Module/JSON.html b/Documentation/Module/JSON.html
diff --git a/Documentation/Module/Load.html b/Documentation/Module/Load.html
diff --git a/Documentation/Module/Merge.html b/Documentation/Module/Merge.html
diff --git a/Documentation/Module/Theme.html b/Documentation/Module/Theme.html
diff --git a/Documentation/Module/TypeScriptESBuild.html b/Documentation/Module/TypeScriptESBuild.html
diff --git a/Documentation/Module/Mapping.html → Documentation/Module/Value.html b/Documentation/Module/Mapping.html → Documentation/Module/Value.html
diff --git a/Documentation/Type/Interface_Value.Type.html → Documentation/Type/Value.Type.html b/Documentation/Type/Interface_Value.Type.html → Documentation/Type/Value.Type.html
diff --git a/Documentation/Variable/Build.Current.html b/Documentation/Variable/Build.Current.html
diff --git a/Documentation/Variable/Build.Pipe.html b/Documentation/Variable/Build.Pipe.html
diff --git a/Documentation/Variable/ESBuild.ESBuild.html b/Documentation/Variable/ESBuild.ESBuild.html
diff --git a/Documentation/Variable/Load.Load.html b/Documentation/Variable/Load.Load.html
diff --git a/Documentation/Variable/Load.Theme.html b/Documentation/Variable/Load.Theme.html
diff --git a/Documentation/Variable/Theme.Class.html b/Documentation/Variable/Theme.Class.html
diff --git a/Documentation/Variable/Theme.DeclarationReflection.html b/Documentation/Variable/Theme.DeclarationReflection.html
diff --git a/Documentation/Variable/Theme.Enum.html b/Documentation/Variable/Theme.Enum.html
diff --git a/Documentation/Variable/Theme.Interface.html b/Documentation/Variable/Theme.Interface.html
diff --git a/Documentation/Variable/Theme.Module.html b/Documentation/Variable/Theme.Module.html
diff --git a/Documentation/Variable/Theme.Namespace.html b/Documentation/Variable/Theme.Namespace.html
diff --git a/Documentation/Variable/Theme.TypeAlias.html b/Documentation/Variable/Theme.TypeAlias.html
diff --git a/Documentation/Variable/Theme.URL_PREFIX.html b/Documentation/Variable/Theme.URL_PREFIX.html
diff --git a/Documentation/Variable/Theme.UrlMapping.html b/Documentation/Variable/Theme.UrlMapping.html
diff --git a/...tation/Variable/Theme.ReflectionKind.html → Documentation/Variable/Theme.Variable.html b/...tation/Variable/Theme.ReflectionKind.html → Documentation/Variable/Theme.Variable.html
diff --git a/...entation/Variable/Theme.DefaultTheme.html → Documentation/Variable/Theme._Function.html b/...entation/Variable/Theme.DefaultTheme.html → Documentation/Variable/Theme._Function.html
diff --git a/Documentation/Variable/TypeScriptESBuild.TypeScriptESBuild.html b/Documentation/Variable/TypeScriptESBuild.TypeScriptESBuild.html
diff --git a/Documentation/assets/navigation.js b/Documentation/assets/navigation.js
diff --git a/Documentation/assets/search.js b/Documentation/assets/search.js
diff --git a/Documentation/index.html b/Documentation/index.html
diff --git a/README.md b/README.md
@@ -22,7 +22,7 @@ npm install -D -E typescript-esbuild
 		"prepublishOnly": "TypeScriptESBuild 'Source/**/*.ts'"
 	},
 	"devDependencies": {
-		"typescript-esbuild": "0.2.17"
+		"typescript-esbuild": "0.2.18"
 	}
 }
 ```

diff --git a/Source/Class/Theme.ts b/Source/Class/Theme.ts
@@ -10,16 +10,8 @@ export default class
 		const { Directory } = this._Mapping(Reflection) ?? {};
 
 		if (Directory) {
-			if (
-				!(
-					Reflection.url &&
-					DefaultTheme.URL_PREFIX.test(Reflection.url)
-				)
-			) {
-				const URL = [
-					Directory,
-					`${DefaultTheme.getUrl(Reflection)}.html`,
-				].join("/");
+			if (!(Reflection.url && URL_PREFIX.test(Reflection.url))) {
+				const URL = [Directory, `${getUrl(Reflection)}.html`].join("/");
 
 				URLs.push(
 					new UrlMapping(URL, Reflection, this.reflectionTemplate)
@@ -33,13 +25,13 @@ export default class
 				if (Child instanceof DeclarationReflection) {
 					this.buildUrls(Child, URLs);
 				} else {
-					DefaultTheme.applyAnchorUrl(Child, Reflection);
+					applyAnchorUrl(Child, Reflection);
 				}
 
 				return true;
 			});
 		} else if (Reflection.parent) {
-			DefaultTheme.applyAnchorUrl(Reflection, Reflection.parent);
+			applyAnchorUrl(Reflection, Reflection.parent);
 		}
 
 		return URLs;
@@ -50,31 +42,31 @@ export default class
 
 	Mapping: Mapping[] = [
 		{
-			Kind: [ReflectionKind.Class],
+			Kind: [Class],
 			Directory: "Class",
 		},
 		{
-			Kind: [ReflectionKind.Interface],
+			Kind: [Interface],
 			Directory: "Interface",
 		},
 		{
-			Kind: [ReflectionKind.Enum],
+			Kind: [Enum],
 			Directory: "Enum",
 		},
 		{
-			Kind: [ReflectionKind.Namespace, ReflectionKind.Module],
+			Kind: [Namespace, Module],
 			Directory: "Module",
 		},
 		{
-			Kind: [ReflectionKind.TypeAlias],
+			Kind: [TypeAlias],
 			Directory: "Type",
 		},
 		{
-			Kind: [ReflectionKind.Function],
+			Kind: [_Function],
 			Directory: "Function",
 		},
 		{
-			Kind: [ReflectionKind.Variable],
+			Kind: [Variable],
 			Directory: "Variable",
 		},
 	];
@@ -85,7 +77,16 @@ import type Type from "../Interface/Theme.js";
 
 export const {
 	DeclarationReflection,
-	DefaultTheme,
-	ReflectionKind,
+	DefaultTheme: { URL_PREFIX, getUrl, applyAnchorUrl },
+	ReflectionKind: {
+		Interface,
+		Class,
+		Enum,
+		Namespace,
+		Module,
+		TypeAlias,
+		Function: _Function,
+		Variable,
+	},
 	UrlMapping,
 } = await import("typedoc");
diff --git a/Source/Interface/Build.ts b/Source/Interface/Build.ts
@@ -18,8 +18,8 @@ export default interface Type {
 	(
 		File: Pattern[],
 		Option?: {
-			ESBuild?: string | undefined;
-			TypeScript?: string | undefined;
+			ESBuild?: string;
+			TypeScript?: string;
 		}
 	): Promise<void>;
 }

diff --git a/Source/Interface/Exec.ts b/Source/Interface/Exec.ts
@@ -7,11 +7,11 @@ export default interface Type {
 	 * The 'Exec' function is an asynchronous function that executes a command and logs the
 	 * stdout of the child process.
 	 *
-	 * @param {string} Command - The 'Command' parameter is a string that represents the
+	 * @param Command - The 'Command' parameter is a string that represents the
 	 * command you want to execute. It can be any valid command that can be executed in a
 	 * terminal or command prompt.
 	 *
-	 * @param {boolean|function} [Echo] - An optional parameter that controls whether the stdout
+	 * @param Echo - An optional parameter that controls whether the stdout
 	 * of the child process should be logged. If set to 'false', no logging will occur. If set
 	 * to a function, the function will be called with the stdout data as a parameter for custom
 	 * logging. If not provided, stdout will be logged to the console by default.

diff --git a/Source/Interface/File.ts b/Source/Interface/File.ts
@@ -12,7 +12,7 @@ export default interface Type {
 	 *
 	 * Finally, it imports and returns the default export of the processed JavaScript module.
 	 *
-	 * @param {string} Path - The 'Path' parameter is a string that represents the file path of the file
+	 * @param Path - The 'Path' parameter is a string that represents the file path of the file
 	 * you want to process.
 	 *
 	 */

diff --git a/Source/Interface/Mapping.ts b/Source/Interface/Mapping.ts
@@ -1,10 +1,10 @@
 /**
+ * @module Mapping
+ *
  * Defines a mapping of a {@link Models.Kind} to a template file.
  *
  * Used by {@link DefaultTheme} to map reflections to output files.
  *
- * @module Mapping
- *
  */
 export default interface Type {
 	/**

diff --git a/Source/Interface/Merge.ts b/Source/Interface/Merge.ts
@@ -4,6 +4,7 @@
  * Represents a generic interface for deep merging objects using merge functions defined in DeepMergeMergeFunctionsURIs.
  *
  * @template PMF - A type parameter representing Partial<DeepMergeMergeFunctionsURIs>.
+ *
  */
 export default interface Type<
 	PMF extends Partial<DeepMergeMergeFunctionsURIs>,

diff --git a/Source/Interface/Theme.ts b/Source/Interface/Theme.ts
@@ -5,11 +5,11 @@
  */
 export default interface Type {
 	/**
-	 * A function that builds URLs for a given DeclarationReflection and an array of URL mappings.
+	 * A function that builds URLs for a given DeclarationReflection and an array of URLs mappings.
 	 *
 	 * @param Reflection - The DeclarationReflection for which URLs are being built.
 	 *
-	 * @param URLs - An array of URL mappings with any data type.
+	 * @param URLs - An array of URLs mappings with any data type.
 	 *
 	 */
 	buildUrls: (

diff --git a/Source/Interface/Value.ts → Source/Type/Value.ts b/Source/Interface/Value.ts → Source/Type/Value.ts
@@ -1,3 +1,7 @@
+/**
+ * @module Value
+ *
+ */
 export type Type<T> = T[keyof T];
 
 export type { Type as default };
diff --git a/Target/Class/Theme.d.ts b/Target/Class/Theme.d.ts
@@ -10,5 +10,5 @@ export default class extends default_base implements Type {
 }
 import type Mapping from "../Interface/Mapping.js";
 import type Type from "../Interface/Theme.js";
-export declare const DeclarationReflection: typeof import("typedoc").DeclarationReflection, DefaultTheme: typeof import("typedoc").DefaultTheme, ReflectionKind: typeof import("typedoc").ReflectionKind, UrlMapping: typeof import("typedoc").UrlMapping;
+export declare const DeclarationReflection: typeof import("typedoc").DeclarationReflection, URL_PREFIX: RegExp, getUrl: typeof import("typedoc").DefaultTheme.getUrl, applyAnchorUrl: typeof import("typedoc").DefaultTheme.applyAnchorUrl, Interface: import("typedoc").ReflectionKind, Class: import("typedoc").ReflectionKind, Enum: import("typedoc").ReflectionKind, Namespace: import("typedoc").ReflectionKind, Module: import("typedoc").ReflectionKind, TypeAlias: import("typedoc").ReflectionKind, _Function: import("typedoc").ReflectionKind, Variable: import("typedoc").ReflectionKind, UrlMapping: typeof import("typedoc").UrlMapping;
 export {};
diff --git a/Target/Class/Theme.js b/Target/Class/Theme.js
diff --git a/Target/Class/TypeScriptESBuild.js b/Target/Class/TypeScriptESBuild.js
diff --git a/Target/Interface/Build.d.ts b/Target/Interface/Build.d.ts
@@ -16,8 +16,8 @@ export default interface Type {
      *
      */
     (File: Pattern[], Option?: {
-        ESBuild?: string | undefined;
-        TypeScript?: string | undefined;
+        ESBuild?: string;
+        TypeScript?: string;
     }): Promise<void>;
 }
 import type { Pattern } from "fast-glob";
diff --git a/Target/Interface/Exec.d.ts b/Target/Interface/Exec.d.ts
@@ -7,11 +7,11 @@ export default interface Type {
      * The 'Exec' function is an asynchronous function that executes a command and logs the
      * stdout of the child process.
      *
-     * @param {string} Command - The 'Command' parameter is a string that represents the
+     * @param Command - The 'Command' parameter is a string that represents the
      * command you want to execute. It can be any valid command that can be executed in a
      * terminal or command prompt.
      *
-     * @param {boolean|function} [Echo] - An optional parameter that controls whether the stdout
+     * @param Echo - An optional parameter that controls whether the stdout
      * of the child process should be logged. If set to 'false', no logging will occur. If set
      * to a function, the function will be called with the stdout data as a parameter for custom
      * logging. If not provided, stdout will be logged to the console by default.

diff --git a/Target/Interface/File.d.ts b/Target/Interface/File.d.ts
@@ -12,7 +12,7 @@ export default interface Type {
      *
      * Finally, it imports and returns the default export of the processed JavaScript module.
      *
-     * @param {string} Path - The 'Path' parameter is a string that represents the file path of the file
+     * @param Path - The 'Path' parameter is a string that represents the file path of the file
      * you want to process.
      *
      */

diff --git a/Target/Interface/Mapping.d.ts b/Target/Interface/Mapping.d.ts
@@ -1,10 +1,10 @@
 /**
+ * @module Mapping
+ *
  * Defines a mapping of a {@link Models.Kind} to a template file.
  *
  * Used by {@link DefaultTheme} to map reflections to output files.
  *
- * @module Mapping
- *
  */
 export default interface Type {
     /**

diff --git a/Target/Interface/Merge.d.ts b/Target/Interface/Merge.d.ts
@@ -4,6 +4,7 @@
  * Represents a generic interface for deep merging objects using merge functions defined in DeepMergeMergeFunctionsURIs.
  *
  * @template PMF - A type parameter representing Partial<DeepMergeMergeFunctionsURIs>.
+ *
  */
 export default interface Type<PMF extends Partial<DeepMergeMergeFunctionsURIs>> {
     /**

diff --git a/Target/Interface/Theme.d.ts b/Target/Interface/Theme.d.ts
@@ -5,11 +5,11 @@
  */
 export default interface Type {
     /**
-     * A function that builds URLs for a given DeclarationReflection and an array of URL mappings.
+     * A function that builds URLs for a given DeclarationReflection and an array of URLs mappings.
      *
      * @param Reflection - The DeclarationReflection for which URLs are being built.
      *
-     * @param URLs - An array of URL mappings with any data type.
+     * @param URLs - An array of URLs mappings with any data type.
      *
      */
     buildUrls: (Reflection: DeclarationReflection, URLs: UrlMapping<any>[]) => UrlMapping<any>[];

diff --git a/Target/Interface/Value.d.ts → Target/Type/Value.d.ts b/Target/Interface/Value.d.ts → Target/Type/Value.d.ts
@@ -1,2 +1,6 @@
+/**
+ * @module Value
+ *
+ */
 export type Type<T> = T[keyof T];
 export type { Type as default };
diff --git a/Target/Interface/Value.js → Target/Type/Value.js b/Target/Interface/Value.js → Target/Type/Value.js
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "typescript-esbuild",
-	"version": "0.2.17",
+	"version": "0.2.18",
 	"private": false,
 	"description": "🌀 Builds all your TypeScript files into JavaScript and generates documentation for it using TypeDoc.",
 	"keywords": [
@@ -36,7 +36,7 @@
 		"@types/node": "20.8.6",
 		"commander": "11.1.0",
 		"deepmerge-ts": "5.1.0",
-		"esbuild": "0.19.4",
+		"esbuild": "0.19.5",
 		"esbuild-plugin-copy": "2.1.1",
 		"fast-glob": "3.3.1",
 		"typedoc": "0.25.2",