feat: adding includeExt option

Author: DaanV2

README.md

@@ -11,13 +11,14 @@ It creates a list of each markdown file in the folders and displays it under doc
 
 ## Inputs
 
-| Parameters     | Optional | Description                                                                                                                                    |
-| -------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
-| `folder`       | ✅        | The folder path to start at, default uses `${{github.workspace}}`                                                                              |
-| `filename`     | ✅        | The filename of the generated file. default to `index`                                                                                         |
-| `content-file` | ✅        | The filepath (relative to where the README.md or index.md) where content will be read from and input into index file, default to `.content.md` |
-| `include`      | ✅        | The files to additionaly include in the index file, follows glob pattern on the filenames, supports multiple patterns via multi-line string`   |
-| `exclude`      | ✅        | The files to exclude from the index file, follows glob pattern on the filenames, supports multiple patterns via multi-line string              |
+| Parameters     | Optional | Description                                                                                                                                     |
+| -------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
+| `folder`       | ✅       | The folder path to start at, default uses `${{github.workspace}}`                                                                              |
+| `filename`     | ✅       | The filename of the generated file. default to `index`                                                                                         |
+| `content-file` | ✅       | The filepath (relative to where the README.md or index.md) where content will be read from and input into index file, default to `.content.md` |
+| `include`      | ✅       | The files to additionaly include in the index file, follows glob pattern on the filenames, supports multiple patterns via multi-line string`   |
+| `exclude`      | ✅       | The files to exclude from the index file, follows glob pattern on the filenames, supports multiple patterns via multi-line string              |
+| `includeExt`   | ✅       | Whenever or not to include extensions in the documents text                                                                                    |
 
 ## Examples
 

action.yml

@@ -24,6 +24,10 @@ inputs:
     description: The files to exclude from the index file, follows glob pattern on the filenames, supports multiple patterns via multi-line string
     required: false
     default: ""
+  includeExt:
+    description: Whether to include the file extension in the index file links
+    required: false
+    default: "false"
 runs:
   using: "node20"
   main: "dist/index.js"

dist/index.js

@@ -2,6 +2,7 @@ import { Processor } from "./traverse";
 import {
   debug,
   error,
+  getBooleanInput,
   getInput,
   getMultilineInput,
   setFailed,
@@ -14,15 +15,14 @@ try {
   // This should be a token with access to your repository scoped in as a secret.
   // The YML workflow will need to set myToken with the GitHub Secret Token
   // token: ${{ secrets.GITHUB_TOKEN }}
-
-  const args: Arguments = {
+  const args = Arguments.sanitize({
     contentFilename: getInput("content"),
     excludes: getMultilineInput("exclude"),
     includes: getMultilineInput("include"),
     indexFilename: getInput("filename"),
     startFolder: getInput("folder"),
-  };
-  Arguments.sanitize(args);
+    includeExt: getBooleanInput("includeExt"),
+  });
 
   info("starting on: " + args.startFolder);
   debug(`arguments ${JSON.stringify(args, undefined, 2)}`);

src/action.ts

@@ -5,6 +5,8 @@ export class Arguments {
   startFolder: string;
   /** The filename of the index files */
   indexFilename: string;
+  /** Whether to include the file extension in the links */
+  includeExt: boolean;
   /** The content filename to add to indexes */
   contentFilename: string;
   /** The patterns to include, addeds *.md by default */
@@ -14,7 +16,7 @@ export class Arguments {
 }
 
 export namespace Arguments {
-  export function sanitize(args: Arguments): void {
+  export function sanitize(args: Arguments): Arguments {
     // Checks
     if (args.startFolder === "") {
       throw new Error("No folder specified");
@@ -38,8 +40,15 @@ export namespace Arguments {
     if (args.contentFilename !== "") {
       args.excludes.push(args.contentFilename);
     }
+    if (args.includeExt === undefined) {
+      args.includeExt = false;
+    }
+    if (typeof args.includeExt === "string") {
+      args.includeExt = args.includeExt === "true";
+    }
 
     args.includes.push("*.md");
     args.excludes.push(args.indexFilename, ".git", "node_modules");
+    return args;
   }
 }

src/arguments.ts

@@ -9,7 +9,7 @@ import {
 import path from "path";
 import { Arguments } from "./arguments";
 import { FileFilter } from "./filter";
-import { debug, info } from "@actions/core";
+import { info } from "@actions/core";
 
 const Template = `# {$HEADER$}
 {$CONTENT$}
@@ -73,7 +73,13 @@ export class Processor {
 
           //If the child is a .md page create a reference
         } else if (this.includeFile(child)) {
-          const linkName = child.substring(0, child.length - 3);
+          let linkName = child;
+          if (!this.options.includeExt) {
+            const lastIndex = child.lastIndexOf(".");
+            if (lastIndex > 0) {
+              linkName = child.substring(0, lastIndex);
+            }
+          }
           const fileUrl = encodeURI(child);
 
           documents.push(`- [${linkName}](${fileUrl})`);