Version 4.0.1 (#92)

# Version 4.0.1

Upgraded Bootstrap framework integration with Bootstrap Icons.

## Enhancements and Updates

- Upgraded Bootstrap framework integration with Bootstrap Icons.

## General Code Improvements

- Applied `fs.strict` check to HTML files (via Vite upgrade).
- Refactored conditional rendering logic across components for improved
readability and maintainability.
- Improved error handling and type annotations.

## Licence and Documentation

- Added JSDoc comments for better documentation.

## General Technical Changes

- Improved builder scripts (`GeneratePrDescription.ts`,
`GenerateReleaseNotes.ts`).
- Improved code readability and maintainability.
- Enhanced type safety in utility functions.
- Resolved project errors and warnings.

## Dependencies

- Fixed security vulnerabilities in dependencies.
- **Vite** upgraded from 6.3.5 → 6.3.6 → 6.4.1 (security fixes and
improvements).
- Added `bootstrap-icons` for icon library support.
- Added `react-google-recaptcha-v3` for reCAPTCHA integration.
- Added `@types/react-google-recaptcha-v3` for type definitions.

## Changes by

@tahoni

@dependabot

Author: tahoni

.idea/scopes/src.xml

@@ -15,12 +15,14 @@
 
 ## Description
 
-This repository contains the source code for the Hartbeespoortdam Practical Shooting Club (HPSC) website.
+This repository contains the source code for the Hartbeespoortdam Practical
+Shooting Club (HPSC) website.
 
 ## Summary
 
 The [HPSC website](https://hpsc.co.za) uses modern web technologies
-to provide an informative and user-friendly platform for members and visitors.<br/>
+to provide an informative and user-friendly platform for members and
+visitors.<br/>
 The primary technologies used in this project include TypeScript, SCSS, and MDX.
 
 ## Repository
@@ -29,14 +31,16 @@ The repository for this project is located at
 [GitHub](https://github.com/tahoni/hpsc-web-vite).
 
 Feature requests, suggestions for improvements and bugs can be
-logged using the project's [Issues](https://github.com/tahoni/hpsc-web-vite/issues) page.
+logged using the
+project's [Issues](https://github.com/tahoni/hpsc-web-vite/issues) page.
 
 An overview of the project can be found at
 [https://tahoni.info/projects/hpsc-web-vite](https://www.tahoni.info/projects/hpsc-web-vite).
 
 ## Technology
 
-This is a React project bootstrapped using Vite with the TypeScript React template.
+This is a React project bootstrapped using Vite with the TypeScript React
+template.
 
 It is written in TypeScript and uses both JSX and MDX components.
 
@@ -53,36 +57,42 @@ Clone the project from [GitHub](https://github.com/tahoni/hpsc-web-vite).
 
 Install the project using `npm install`.<br/>
 
-Run it locally with `npm run dev`.<br/> 
-It will load at http://localhost:5173/.<br/> 
+Run it locally with `npm run dev`.<br/>
+It will load at http://localhost:5173/.<br/>
 This page will reload if you make edits.
 
-Build it for production with `npm run build` to the `dist` directory.<br/> 
+Build it for production with `npm run build` to the `dist` directory.<br/>
 The production build can be verified by running `npm run preview`.
 
 ### Generate a Pull Request Description
 
-To generate a Markdown PR description comparing the current branch to main:
+To generate a Markdown PR description comparing the current branch to the main
+branch:
 
 - Run: `npm run pr:desc`
-- To compare to a different base (e.g., develop): `npm run pr:desc -- --base=develop`
+- To compare to a different base (e.g. develop):
+  `npm run pr:desc -- --base=develop`
 
-The script prints Markdown to stdout; you can copy it into your PR description or redirect it to a file:
+The script prints Markdown to stdout; you can copy it into your PR description
+or redirect it to a file:
 
 - `npm run pr:desc > target/pr-description.md`
 
 ### Generate Release Notes (this branch → main)
 
-To generate structured release notes comparing the current branch to the main branch:
+To generate structured release notes comparing the current branch to the main
+branch:
 
 - Run: `npm run release:notes`
-- To compare to a different base (e.g., develop): `npm run release:notes -- --base=develop`
+- To compare to a different base (e.g. develop):
+  `npm run release:notes -- --base=develop`
 
-The script prints Markdown to stdout and also writes a file under `target/` named like:
+The script prints Markdown to stdout and also writes a file under `target/`
+named like:
 
 - `target/release-notes-<branch>-to-<base>.md`
 
-You can paste the output into PRs or include in RELEASE_NOTES.md as needed.
+You can paste the output into PRs or include it in RELEASE_NOTES.md as needed.
 
 ## Architecture
 

README.md

@@ -1,79 +1,140 @@
 import { execSync } from "child_process";
 
+/**
+ * Executes a shell command and returns the output as a trimmed string.
+ * Returns an empty string if the command fails.
+ */
 function run(cmd: string): string {
   try {
-    return execSync(cmd, { stdio: ["ignore", "pipe", "pipe"] }).toString().trim();
+    const output = execSync(cmd, { stdio: ["ignore", "pipe", "pipe"] });
+    return output.toString().trim();
   } catch {
     return "";
   }
 }
 
+/**
+ * Detects the base branch for the PR, with fallback logic.
+ */
 function detectBaseBranch(argBase?: string): string {
-  const base = argBase || process.env.PR_BASE || "main";
+  const base = argBase ?? process.env.PR_BASE ?? "main";
+
   // Prefer remote if available
   const hasOriginMain = run(`git rev-parse --verify --quiet origin/${base}`);
   if (hasOriginMain) return `origin/${base}`;
+
   const hasLocalBase = run(`git rev-parse --verify --quiet ${base}`);
   if (hasLocalBase) return base;
-  // Fallback to default branch from remote
+
+  // Fallback to the default branch from remote
   const upstream = run("git remote show origin");
   const match = upstream.match(/HEAD branch: (.+)/);
-  if (match) {
+  if (match?.[1]) {
     const head = match[1];
     const hasOriginHead = run(`git rev-parse --verify --quiet origin/${head}`);
     if (hasOriginHead) return `origin/${head}`;
   }
+
   return base; // last resort
 }
 
+/**
+ * Gets the current Git branch name.
+ */
 function getCurrentBranch(): string {
   const branch = run("git rev-parse --abbrev-ref HEAD");
   return branch || "(detached)";
 }
 
-function getMergeBase(base: string, head: string): string | null {
+/**
+ * Gets the merge base between two Git references.
+ */
+function getMergeBase(base: string, head: string): string {
   const mb = run(`git merge-base ${base} ${head}`);
-  return mb || null;
+  return mb || base;
 }
 
+/**
+ * Formats a Date object as a local datetime string with timezone.
+ */
 function formatDateTime(d: Date): string {
-  // Use the user's local time; include offset
-  const pad = (n: number) => n.toString().padStart(2, "0");
+  const pad = (n: number): string => n.toString().padStart(2, "0");
+
   const yyyy = d.getFullYear();
   const mm = pad(d.getMonth() + 1);
   const dd = pad(d.getDate());
   const hh = pad(d.getHours());
   const mi = pad(d.getMinutes());
   const ss = pad(d.getSeconds());
+
   const tz = -d.getTimezoneOffset();
   const sign = tz >= 0 ? "+" : "-";
   const tzh = pad(Math.floor(Math.abs(tz) / 60));
   const tzm = pad(Math.abs(tz) % 60);
+
   return `${yyyy}-${mm}-${dd} ${hh}:${mi}:${ss} ${sign}${tzh}:${tzm}`;
 }
 
+/**
+ * Creates a Markdown section with a title and body.
+ */
+function section(title: string, body: string): string {
+  return `## ${title}\n${body}\n`;
+}
+
+/**
+ * Parses a file change line from git diff output.
+ */
+function parseFileChangeLine(line: string): string {
+  const parts = line.split(/\t/);
+  const status = parts[0];
+
+  if (!status) {
+    return "";
+  }
+
+  if (status.startsWith("R")) {
+    // Rename: "R100\told\tnew"
+    const from = parts[1];
+    const to = parts[2];
+    if (from && to) {
+      return `- ${status}: ${from} → ${to}`;
+    }
+  }
+
+  // Add, Modify, Delete: "M\tpath"
+  const file = parts[1];
+  if (file) {
+    return `- ${status}: ${file}`;
+  }
+
+  return "";
+}
+
+/**
+ * Generates a PR description based on Git history.
+ */
 function generate(): string {
   const args = process.argv.slice(2);
   const baseArg = args.find((a) => a.startsWith("--base="))?.split("=")[1];
-  const section = (title: string, body: string) => `## ${title}\n${body}\n`;
 
   const headBranch = getCurrentBranch();
   const baseRef = detectBaseBranch(baseArg);
 
   // Ensure we have up-to-date remote info (best-effort; ignore errors)
   run("git fetch --all --prune");
 
-  const mergeBase = getMergeBase(baseRef, "HEAD") || baseRef;
+  const mergeBase = getMergeBase(baseRef, "HEAD");
 
   const shortstat = run(`git diff --shortstat ${mergeBase}..HEAD`);
   const filesChangedList = run(`git diff --name-status ${mergeBase}..HEAD`);
   const commits = run(
-    `git log --no-merges --pretty=format:"- %h %s (%an, %ad)" --date=short ${mergeBase}..HEAD`
+    `git log --no-merges --pretty=format:"- %h %s (%an, %ad)" --date=short ${mergeBase}..HEAD`,
   );
 
   // Try to propose a title from the most recent commit subject
   const latestSubject = run(`git log -1 --pretty=%s`);
-  const defaultTitle = latestSubject ? latestSubject : `Update: ${headBranch}`;
+  const defaultTitle = latestSubject || `Update: ${headBranch}`;
 
   const now = new Date();
   const nowStr = formatDateTime(now);
@@ -92,19 +153,8 @@ function generate(): string {
     ? filesChangedList
         .split(/\r?\n/)
         .filter(Boolean)
-        .map((line) => {
-          // Example formats: "M\tpath", "A\tpath", "R100\told\tnew"
-          const parts = line.split(/\t/);
-          if (parts[0].startsWith("R")) {
-            const status = parts[0];
-            const from = parts[1];
-            const to = parts[2];
-            return `- ${status}: ${from} → ${to}`;
-          }
-          const status = parts[0];
-          const file = parts[1];
-          return `- ${status}: ${file}`;
-        })
+        .map(parseFileChangeLine)
+        .filter(Boolean)
         .join("\n")
     : "(No files changed)";
 
@@ -116,9 +166,10 @@ function generate(): string {
     "- [ ] No sensitive secrets or keys committed",
   ].join("\n");
 
-  const metadata = [`Generated: ${nowStr}`, `Generator: builders/GeneratePrDescription.ts`].join(
-    "\n"
-  );
+  const metadata = [
+    `Generated: ${nowStr}`,
+    `Generator: builders/GeneratePrDescription.ts`,
+  ].join("\n");
 
   const header = `# ${defaultTitle}`;
 
@@ -134,9 +185,13 @@ function generate(): string {
   return `${header}\n\n${body}`;
 }
 
-if (import.meta.url === `file://${process.argv[1]}` || process.argv[1].endsWith("GeneratePrDescription.ts")) {
+// Execute when run directly
+if (
+  import.meta.url === `file://${process.argv[1]}` ||
+  process.argv[1]?.endsWith("GeneratePrDescription.ts")
+) {
   const output = generate();
   console.log(output);
 }
 
-export {};
+export {};