0.1.2

README.md

@@ -1,4 +1,6 @@
-# Build scripts and configuration
+# [TypeScript Build] 🧑🏻‍💻
+
+This utility deletes all deployments older than 7 days in your Cloudflare Pages account.
 
 ## Installation
 
@@ -51,5 +53,5 @@ npm install -D -E typescriptbuild
 The script will now automatically compile your build files with [esbuild] and
 add TypeScript types.
 
-[typescriptbuild]: https://npmjs.org/typescriptbuild
+[TypeScript Build]: https://npmjs.org/typescriptbuild
 [esbuild]: https://npmjs.org/esbuild

Source/Command/Build.ts

@@ -9,6 +9,12 @@ import File from "../Library/File.js";
 
 export type Pipe = string[];
 
+/**
+ * The `Build` function compiles and builds TypeScript files using esbuild and TypeScript compiler.
+ * @param {Pattern[]} Files - An array of file patterns to be processed. Each pattern can include
+ * wildcards (*) to match multiple files.
+ * @param [Options] - The `Options` parameter is an optional object that can contain two properties:
+ */
 export default async (
 	Files: Pattern[],
 	Options?: { esbuild?: string; TypeScript?: string }

Source/Library/File.ts

@@ -3,6 +3,13 @@ import TypeScript from "typescript";
 import { pathToFileURL as URL } from "url";
 import _JSON from "./JSON.js";
 
+/**
+ * The function takes a file path as input, checks if it is a TypeScript file, converts the TypeScript
+ * code to JavaScript, and then imports and returns the default export of the JavaScript file.
+ * @param {string} Path - The `Path` parameter is a string that represents the file path of the file
+ * you want to process.
+ * @returns the default export of the module that is imported using the provided `Path`.
+ */
 export default async (Path: string) => {
 	if (Path.split(".").pop() === "ts") {
 		const { options } = TypeScript.convertCompilerOptionsFromJson(

Source/Library/JSON.ts

@@ -2,6 +2,14 @@ import { readFile as _File } from "fs/promises";
 import { dirname as Dir } from "path";
 import { fileURLToPath as Path } from "url";
 
+/**
+ * The function `JSON` is a TypeScript function that reads a JSON file and returns its parsed content.
+ * @param {string} File - The `File` parameter is a string that represents the name or path of the JSON
+ * file that you want to parse.
+ * @param {string} From - The `From` parameter is a string that represents the source URL or file path
+ * from which the JSON file will be loaded. It is set to `import.meta.url` by default, which refers to
+ * the URL of the current module. However, if a different source URL or file path is provided,
+ */
 export default async (File: string, From: string = import.meta.url) =>
 	JSON.parse(
 		(

Target/Command/Build.d.ts

@@ -1,5 +1,11 @@
 import type { Pattern } from "fast-glob";
 export type Pipe = string[];
+/**
+ * The `Build` function compiles and builds TypeScript files using esbuild and TypeScript compiler.
+ * @param {Pattern[]} Files - An array of file patterns to be processed. Each pattern can include
+ * wildcards (*) to match multiple files.
+ * @param [Options] - The `Options` parameter is an optional object that can contain two properties:
+ */
 declare const _default: (Files: Pattern[], Options?: {
     esbuild?: string;
     TypeScript?: string;

Target/Library/File.d.ts

@@ -1,2 +1,9 @@
+/**
+ * The function takes a file path as input, checks if it is a TypeScript file, converts the TypeScript
+ * code to JavaScript, and then imports and returns the default export of the JavaScript file.
+ * @param {string} Path - The `Path` parameter is a string that represents the file path of the file
+ * you want to process.
+ * @returns the default export of the module that is imported using the provided `Path`.
+ */
 declare const _default: (Path: string) => Promise<any>;
 export default _default;

Target/Library/JSON.d.ts

@@ -1,2 +1,10 @@
+/**
+ * The function `JSON` is a TypeScript function that reads a JSON file and returns its parsed content.
+ * @param {string} File - The `File` parameter is a string that represents the name or path of the JSON
+ * file that you want to parse.
+ * @param {string} From - The `From` parameter is a string that represents the source URL or file path
+ * from which the JSON file will be loaded. It is set to `import.meta.url` by default, which refers to
+ * the URL of the current module. However, if a different source URL or file path is provided,
+ */
 declare const _default: (File: string, From?: string) => Promise<any>;
 export default _default;

package.json

@@ -1,6 +1,8 @@
 {
 	"name": "typescriptbuild",
 	"version": "0.1.2",
+	"private": false,
+	"description": "🧑🏻‍💻 Builds all TypeScript files within a given directory with esbuild.",
 	"homepage": "https://github.com/NikolaRHristov/TypeScriptBuild#readme",
 	"bugs": {
 		"url": "https://github.com/NikolaRHristov/TypeScriptBuild/issues"
@@ -30,5 +32,8 @@
 	"devDependencies": {
 		"@types/node": "20.4.10",
 		"ts-node": "10.9.1"
+	},
+	"publishConfig": {
+		"access": "public"
 	}
 }