Refactor input handling to include readmePath and improve type annotations

Author: andrey-helldar

README.md

@@ -49,12 +49,19 @@ jobs:
                     # Required: true
                     token: ${{ secrets.GITHUB_TOKEN }}
 
-                    # Path to the settings file 
+                    # Path to the settings file
                     #
                     # By default, .github/preview-updater.yml
                     #
                     # Required: false
                     config: ''
+
+                    # Specifies the path to the README file.
+                    #
+                    # By default, README.md
+                    #
+                    # Required: false
+                    readme: ''
 ```
 
 The action is setting the following outputs:
@@ -82,8 +89,6 @@ All fields are optional—omitted ones fall back to defaults.
 ```yaml
 # $schema: https://raw.githubusercontent.com/TheDragonCode/github-preview-updater/refs/heads/main/resources/schema.json
 
-path: README.md        # Target file to update
-
 package:
     # Declares the use of the package manager.
     # It is a regular string that will be substituted into the URL address.

action.yml

@@ -19,3 +19,8 @@ inputs:
         description: Path to the preview configuration YAML file.
         default: '.github/preview-updater.yml'
         required: false
+
+    readme:
+        description: Specifies the path to the README file.
+        default: 'README.md'
+        required: false

src/main.ts

@@ -12,16 +12,12 @@ import { readConfig } from "./utils/config";
 import type { LockFile } from "./types/lockFile";
 import type { Data } from "./types/data";
 import type { Repository as Credentials } from "./types/repository";
-import {
-    defaultConfig,
-    defaultPackage,
-    defaultPullRequest,
-} from "./libs/defaults";
+import { defaultPackage, defaultPullRequest } from "./libs/defaults";
 import type { GitHub } from "@actions/github/lib/utils";
 
 const previewUpdater = async () => {
     // Inputs
-    const { token, configPath } = parse();
+    const { token, configPath, readmePath } = parse();
 
     // Credentials
     const credentials: Credentials = {
@@ -53,7 +49,7 @@ const previewUpdater = async () => {
     // Read names
     const packageLock: LockFile = getPackageManager(config);
 
-    config.readme ||= defaultConfig.readme || "README.md";
+    config.readme = readmePath;
 
     config.package ||= defaultPackage;
     config.data ||= <Data>{};
@@ -71,8 +67,8 @@ const previewUpdater = async () => {
     await repo.authenticate();
 
     // Read file
-    const content = readFile(config, config.readme);
-    const preview = setPreview(content, config, packageLock);
+    const content: string = readFile(config, config.readme);
+    const preview: string = setPreview(content, config, packageLock);
 
     if (content === preview) {
         info(`File "${config.readme}" is up to date`);
@@ -81,7 +77,7 @@ const previewUpdater = async () => {
     }
 
     // Checkout branch
-    const branchExists = await repo.branchExists();
+    const branchExists: boolean = await repo.branchExists();
     info(
         `Checkout ${branchExists ? "existing" : "new"} branch named "${repo.branchName()}"`,
     );

src/utils/inputs.ts

@@ -2,21 +2,26 @@ import { getInput } from "@actions/core";
 
 export const TOKEN = {
     name: "token",
-    env: "INPUT_TOKEN",
 };
 
 export const CONFIG_PATH = {
     name: "config",
-    env: "INPUT_CONFIG_PATH",
     defaultValue: ".github/preview-updater.yml",
 };
 
+export const README_PATH = {
+    name: "readme",
+    defaultValue: "README.md",
+};
+
 export const parse = () => {
     const token = getInput(TOKEN.name, { required: true });
     const configPath = getInput(CONFIG_PATH.name) || CONFIG_PATH.defaultValue;
+    const readmePath = getInput(README_PATH.name) || README_PATH.defaultValue;
 
     return {
         token,
         configPath,
+        readmePath,
     };
 };