Refactoring config parsing module and index.ts

- clean up whitespace
- move TOML example to examples folder
- store command line arguments in object
- removed version & help switches in example toml
- refactored config parser module
- changed output directory in example toml
- added -c usage to documentation
- removed unnecessary package-lock file

README.md

@@ -2,6 +2,14 @@
 
 This tool converts [TIL](https://simonwillison.net/2022/Nov/6/what-to-blog-about/) posts written in [Markdown](https://www.markdownguide.org/) (.txt, .md) into static HTML pages.
 
+## Features
+
+- Parses a title from the input files. If the first line is followed by two blank lines, a `<h1>` tag will be generated in the HTML.
+- Can define a custom output directory with the `--output`/`-o` argument.
+- Program will exit with a non-zero exit code in an error occurred.
+- Added support for Markdown horizontal rules.
+- Can load arguments from a `.toml` configuration file.
+
 ## Setup
 
 ### Install Bun
@@ -36,7 +44,7 @@ bun install
 ### Run tool
 
 ```bash
-bun start [-h | --help] [-v | --version] [-o | --output directory] filename | directory
+bun start [-h | --help] [-v | --version] [-o | --output directory] [-c | --config filepath] filepath | directory
 ```
 
 ### Compile executable
@@ -48,7 +56,7 @@ bun run build
 ### Run tool as executable
 
 ```bash
-til-to-html [-h | --help] [-v | --version] [-o | --output directory] filename | directory
+til-to-html [-h | --help] [-v | --version] [-o | --output directory] [-c | --config filepath] filepath | directory
 ```
 
 ### Command Line Arguments
@@ -58,6 +66,7 @@ til-to-html [-h | --help] [-v | --version] [-o | --output directory] filename |
 | `-v`, `--version` | Display version information.                                                                      |
 | `-h`, `--help`    | Display usage message.                                                                            |
 | `-o`, `--output`  | Set custom output directory. If omitted, files will be output to a folder named `til`. (optional) |
+| `-c`, `--config`  | Use a `.toml` configuration file.                                                                 |
 
 ### Examples
 
@@ -76,24 +85,23 @@ bun start -h
 #### Parse 1 file
 
 ```bash
-bun start examples/til.txt
+bun start ./examples/til.txt
 ```
 
 #### Parse a folder of files
 
 ```bash
-bun start examples/dir
+bun start ./examples/dir
 ```
 
 #### Parse a folder of files and output to a new directory
 
 ```bash
-bun start examples/dir -o output
+bun start ./examples/dir -o output
 ```
 
-## Additional Features
+#### Load a `.toml` configuration file
 
-- Parses a title from the input files. If the first line is followed by two blank lines, a `<h1>` tag will be generated in the HTML.
-- Can define a custom output directory with the `--output`/`-o` argument.
-- Program will exit with a non-zero exit code in an error occurred.
-- Add support for Markdown horizontal rules.
+```bash
+bun start -c ./examples/config.toml
+```

examples/config.toml

@@ -0,0 +1,7 @@
+# TOML sample configuration file
+
+# Set input directory
+target = "./examples/dir"
+
+# Output directory where generated files will be saved
+output = "./til"

src/index.ts

@@ -1,18 +1,6 @@
 import parseArguments from "~/parseArguments";
-import configuration from "./options/configuration";
-import configurationParse from "./options/configurationParse";
 
-var args = Bun.argv.slice(2);
-try{
-    if(args[0] === "-c" || args[0] === "--config"){
-      const configurationPath = args[1];
-      const configurationArgs = configuration(configurationPath);
-      args = configurationParse(configurationArgs);  
-    }
-} catch (e: any) {
-  console.error(e.message);
-  process.exit(1);
-}
+const args = Bun.argv.slice(2);
 try {
   await parseArguments(args);
   process.exit(0);

src/options/help.ts

@@ -9,9 +9,10 @@ export default async function help() {
   message += `Description: ${tool} is a tool that converts TIL Markdown posts into static HTML pages.\n\n`;
 
   message += `Options:\n`;
-  message += `\t-h, --help\t\tDisplay usage.\n`;
-  message += `\t-v, --version\t\tDisplay version.\n`;
-  message += `\t-o, --output DIRECTORY\tIndicate a custom output directory.\n`;
+  message += `\t-h, --help\t\tdisplay usage\n`;
+  message += `\t-v, --version\t\tdisplay version\n`;
+  message += `\t-o, --output DIRECTORY\tindicate custom output directory\n`;
+  message += `\t-c, --config DIRECTORY\tindicate config TOML file to use\n`;
   message += `\n`;
 
   message += `Arguments:\n`;

src/options/parseConfig.ts

@@ -0,0 +1,16 @@
+import toml from "toml";
+
+export default async function parseConfig(configPath: string) {
+  const file = Bun.file(configPath);
+  const fileExists = await file.exists();
+  if (!fileExists) {
+    throw new Error(`Configuration file not found at '${configPath}'.`);
+  }
+
+  try {
+    const configString = await file.text();
+    return toml.parse(configString);
+  } catch (err) {
+    throw new Error(`Error reading or parsing TOML file.`);
+  }
+}

src/parseArguments.ts

@@ -1,21 +1,21 @@
 import version from "~/options/version";
 import help from "~/options/help";
 import parseTarget from "~/parseTarget.ts";
+import parseConfig from "~/options/parseConfig";
 
 const OUTPUT_DIR_DEFAULT = "til";
 
 export default async function parseArguments(args: string[]) {
-  let target: string | null = null;
-  let exit = false;
-  let outputDir = OUTPUT_DIR_DEFAULT;
+  let options: any = {};
+  let configProvided = false;
 
   if (args.length === 0) {
     throw new Error(`Add option -h for help.`);
   }
 
-  for (let i = 0; i < args.length && !exit; i++) {
-
+  for (let i = 0; i < args.length && !configProvided; i++) {
     const arg = args[i];
+    const isFinalArg = i === args.length - 1;
 
     switch (arg) {
       case "--version":
@@ -28,24 +28,44 @@ export default async function parseArguments(args: string[]) {
         return false;
       case "--output":
       case "-o":
+        if (isFinalArg) {
+          throw new Error(`Option ${arg} is missing an operand.`);
+        }
+        options.output = args[++i];
+        break;
+      case "--config":
+      case "-c":
+        if (isFinalArg) {
+          throw new Error(`Option ${arg} is missing an operand.`);
+        }
 
-        const finalArg = i === args.length - 1;
+        configProvided = true;
+        const configPath = args[++i];
+        const config = await parseConfig(configPath);
 
-        if (finalArg) {
-          throw new Error(`Option ${arg} is missing an operand.`);
-        } else {
-          outputDir = args[i + 1];
-          i++; // Skip over next argument
+        options = {};
+
+        if ("target" in config) {
+          options.target = config.target;
+        }
+
+        if ("output" in config) {
+          options.output = config.output;
         }
         break;
       default:
-        target = arg;
+        options.target = arg;
     }
   }
 
-  if (!!target) {
-    await parseTarget(target, outputDir);
-  } else {
+  if (!("target" in options)) {
     throw new Error("Missing target files.");
   }
+
+  // Default output directory if missing
+  if (!("output" in options)) {
+    options.output = OUTPUT_DIR_DEFAULT;
+  }
+
+  await parseTarget(options.target, options.output);
 }