Update prettier configuration and changelog formatting

Refine GitHub Action for Prettier by removing markdown support and ensure consistency in changelog with bullet points for readability.

- Updated `format.yml` to exclude markdown files in Prettier options.
- Adjusted bullet points alignment in `CHANGELOG.md`, `README.md`, and other docs for consistency.
- Specified a Prettier configuration flag in package.json `format-check` script.

Release-Note: The Prettier GitHub Action now excludes markdown files and utilizes a consistent config. Documentation was restructured for clarity.

Signed-off-by: Ian Skelskey <ianskelskey@gmail.com>

.github/workflows/format.yml

@@ -22,5 +22,5 @@ jobs:
             - name: Prettify code
               uses: creyD/prettier_action@v4.3
               with:
-                  prettier_options: --write "**/*.{js,ts,md,json}" --config .prettierrc
+                  prettier_options: --write "**/*.{js,ts,json}" --config .prettierrc
                   only_changed: False

CHANGELOG.md

@@ -6,22 +6,22 @@ This file is written automatically by the [version bump script](version-bump.ts)
 
 ### Changelog Summary
 
-- Enhanced version bump and changelog handling.
-- Improved commit flow with Launchpad bug integration.
-- Enhanced commit message handling by improved sanitization logic, specifically replacing newline characters with escape sequences for better multi-line support.
-- Refactored code for improved readability and error handling.
-- Utilized temporary files for git commit message construction.
-- General code prettification and refactoring for better code organization and functionality.
+-   Enhanced version bump and changelog handling.
+-   Improved commit flow with Launchpad bug integration.
+-   Enhanced commit message handling by improved sanitization logic, specifically replacing newline characters with escape sequences for better multi-line support.
+-   Refactored code for improved readability and error handling.
+-   Utilized temporary files for git commit message construction.
+-   General code prettification and refactoring for better code organization and functionality.
 
 ## [0.1.1] - 2024-11-16
 
 ![Increment](https://img.shields.io/badge/patch-purple)
 
 ### Changelog Summary
 
-- Enhanced commit workflow:
-    - Added a feedback loop for improved user interaction.
-    - Introduced an option to unstage changes.
+-   Enhanced commit workflow:
+    -   Added a feedback loop for improved user interaction.
+    -   Introduced an option to unstage changes.
 
 ## [0.1.2] - 2024-11-17
 
@@ -31,64 +31,64 @@ This file is written automatically by the [version bump script](version-bump.ts)
 
 #### New Features
 
-- Added test job to GitHub Actions workflow.
-- Enhanced CLI options and updated version handling in evergit.
+-   Added test job to GitHub Actions workflow.
+-   Enhanced CLI options and updated version handling in evergit.
 
 #### Improvements
 
-- Added code coverage reports and refactored tests
-- Implemented error handling for model settings with a list of available models
-- Updated README with npm install and usage instructions.
-- Added changelog generation details to the `CHANGELOG.md`.
-- Introduced option for staging all files during commit.
-- Added `ts-prune` to check for unused exports.
+-   Added code coverage reports and refactored tests
+-   Implemented error handling for model settings with a list of available models
+-   Updated README with npm install and usage instructions.
+-   Added changelog generation details to the `CHANGELOG.md`.
+-   Introduced option for staging all files during commit.
+-   Added `ts-prune` to check for unused exports.
 
 #### Refactoring
 
-- Refactored diff retrieval to exclude specific files.
+-   Refactored diff retrieval to exclude specific files.
 
 #### Code Quality
 
-- Prettified code in multiple instances.
+-   Prettified code in multiple instances.
 
 #### Maintenance
 
-- Added `.VSCodeCounter/` to `.gitignore` for a cleaner repository.
-- Removed generated coverage files from the repository and updated `.gitignore` accordingly.
-- Cleaned up coverage files and ignored them in future commits.
+-   Added `.VSCodeCounter/` to `.gitignore` for a cleaner repository.
+-   Removed generated coverage files from the repository and updated `.gitignore` accordingly.
+-   Cleaned up coverage files and ignored them in future commits.
 
 #### Fixes
 
-- Added a success message after the commit operation is performed.
+-   Added a success message after the commit operation is performed.
 
 ## [0.1.3] - 2024-11-19
 
 ![Increment](https://img.shields.io/badge/patch-purple)
 
 ### Changelog Summary
 
-- **Enhancements:**
+-   **Enhancements:**
 
-    - Improved buffer handling in the `getDiffForStagedFiles` function.
-    - Enhanced the CLI main function and added corresponding tests.
+    -   Improved buffer handling in the `getDiffForStagedFiles` function.
+    -   Enhanced the CLI main function and added corresponding tests.
 
-- **Testing:**
+-   **Testing:**
 
-    - Added integration tests for Git utilities.
+    -   Added integration tests for Git utilities.
 
-- **Code Quality:**
+-   **Code Quality:**
 
-    - Prettified codebase for improved readability.
+    -   Prettified codebase for improved readability.
 
-- **Merges:**
-    - Merged branch 'dev' from the repository.
+-   **Merges:**
+    -   Merged branch 'dev' from the repository.
 
 ## [0.1.4] - 2024-12-16
 
 ![Increment](https://img.shields.io/badge/patch-purple)
 
 # Changelog Summary
 
-- Refactored AI utility to use Axios instead of OpenAI client.
-- Improved code readability by applying code formatting (Prettified Code).
-- Merged changes from the 'main' branch into 'dev'.
+-   Refactored AI utility to use Axios instead of OpenAI client.
+-   Improved code readability by applying code formatting (Prettified Code).
+-   Merged changes from the 'main' branch into 'dev'.

README.md

@@ -12,17 +12,17 @@ An AI-powered Git helper for the Evergreen ILS project. Evergit uses OpenAI’s
 
 ## Features
 
-- Generate commit messages using OpenAI's LLM models.
-- Automatically reference Launchpad bugs in commit messages.
-- Automatically sign off commits with the user's name and email.
-- Select files to stage for commit.
-- Use different models by specifying the model name as an argument.
+-   Generate commit messages using OpenAI's LLM models.
+-   Automatically reference Launchpad bugs in commit messages.
+-   Automatically sign off commits with the user's name and email.
+-   Select files to stage for commit.
+-   Use different models by specifying the model name as an argument.
 
 ## Requirements
 
-- `Node.js`, `npm`, and `Git` must be installed on your system.
-- OpenAI API key (stored in the `OPENAI_API_KEY` environment variable)
-- A launchpad account is required to reference bugs in commit messages.
+-   `Node.js`, `npm`, and `Git` must be installed on your system.
+-   OpenAI API key (stored in the `OPENAI_API_KEY` environment variable)
+-   A launchpad account is required to reference bugs in commit messages.
 
 ## Installation
 
@@ -50,20 +50,20 @@ Generates a commit message using a LLM model from OpenAI that follows the Evergr
 evergit commit  # Uses the default model and prompts the user to select files to stage
 ```
 
-- Prompts the user to select files to stage.
-- Prompts the user for a Launchpad bug number.
-    - References the bug name, description and conversation when generating the commit message using the Launchpad API.
-- Automatically signs off the commit with the user's name and email from the git configuration.
+-   Prompts the user to select files to stage.
+-   Prompts the user for a Launchpad bug number.
+    -   References the bug name, description and conversation when generating the commit message using the Launchpad API.
+-   Automatically signs off the commit with the user's name and email from the git configuration.
 
 ##### Options
 
-- `-m, --model <model-name>`: Use a specific model to generate the commit message.
+-   `-m, --model <model-name>`: Use a specific model to generate the commit message.
 
     ```bash
     evergit commit --model <model-name> # Uses a specific model
     ```
 
-- `-a, --all`: Stage all modified files for commit.
+-   `-a, --all`: Stage all modified files for commit.
 
     ```bash
     evergit commit --all    # Stages all modified files

package.json

@@ -10,7 +10,7 @@
         "start": "node dist/main.js",
         "build": "tsc",
         "format": "prettier --write . --config .prettierrc",
-        "format-check": "prettier --check .",
+        "format-check": "prettier --check . --config .prettierrc",
         "check-unused": "ts-prune -p tsconfig.json",
         "prepare": "npm run build",
         "test": "jest",