Merge pull request #4 from ioncakephper:feature/allow-multiple-filenames

* chore(CHANGELOG.md): update changelog for version 1.1.0

Author: ioncakephper

CHANGELOG.md

@@ -2,6 +2,14 @@
 
 *Changelog created using the [Simple Changelog](https://marketplace.visualstudio.com/items?itemName=tobiaswaelde.vscode-simple-changelog) extension for VS Code.*
 
+## [1.1.0] - 2024-12-17
+### Added
+- Extended action scope: use pattern(s) to indicate folders and filenames
+
+### Changed
+- Changed the argument to represent a filename pattern
+
+
 ## [1.0.3] - 2024-12-17
 ### Changed
 - Commented out test in processSourceCode.test.js

README.md

@@ -9,17 +9,17 @@ The `insert-file-tag` package is a Node.js utility that simplifies the process o
 The package works by parsing your document, looking for special HTML-style comment tags that indicate the path to the file you want to insert. For example:
 
 ```html
-<!-- Error processing file: path/to/code.js -->
-
-
+<!-- ::insert file="path/to/code.js" -->
+ Content of path/to/code.js file will be inserted here.
+<!-- ::/insert -->
 ```
 
 The content of path/to/code.js will be inserted between these tags when the utility is run. This keeps your main document clean and maintainable while allowing you to include dynamic content from other sources. insert-file-tag supports various file types and can be easily integrated into your build process.
 
 ## Table of Contents <!-- omit in toc -->
 
 - [Getting Started](#getting-started)
-  - [Installing](#installing)
+- [Installing](#installing)
 - [Usage](#usage)
 - [Author](#author)
 - [License](#license)
@@ -28,21 +28,52 @@ The content of path/to/code.js will be inserted between these tags when the util
 
 These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See [deployment](#deployment) for notes on how to deploy the project on a live system.
 
-### Installing
+## Installing
+
+```bash
+$ npm i insert-file-tag
+```
+
+Or,
+
+```bash
+$ npm i insert-file-tag -g
+```
+
+This will install the package globally, making it available from the command line. After installing, you can run the `instags` command.
+
+```bash
+$ instags -h
+```
+
+Or,
+
+You can skip installing it the package globally, and use the `npx instags` command.
 
 ```bash
-$ npm install insert-file-tag
+$ npx insert-file-tag -h
 ```
 
 ## Usage
 
 **Basic Usage:**
 
 ```bash
-npx insert-file-tag input.md output.md
+npx instags -h
+```
+
+This will display the help message, showing available options like `-V` (version) -o (output folder, and others. It explains how to use the command.
+
+```
+npx instags -V
+```
+This will display the version number of the installed insert-file-tag package.
+
+```bash
+$ npx instags README.md
 ```
 
-This will process `input.md`, insert the content specified by the tags, and write the result to `output.md`.
+This command will process the README.md file. It will search for any <!-- ::insert ... --> tags within README.md. If any are found, the specified file content will be inserted in place of the tag, and the updated content will be written back to README.md. If no insert tags are present, the file will remain unchanged.
 
 ## Author
 

cli.js

@@ -4,23 +4,36 @@ const { Command } = require('commander');
 const { processAndSaveFileWithTags } = require('./src/source-processor');
 const packageJson = require('./package.json');
 const path = require('path');
+const { globSync } = require('glob');
 
 const program = new Command();
 
 program
   .name(packageJson.name)
   .version(packageJson.version)
   .description(packageJson.description)
-  .argument('<filename>', 'file to process for insert tags')
-  .option('-o, --output <output>', 'output filename', '')
-  .action((filename, options) => {
-    const outputFilename = options.output || filename;
-    try {
-      processAndSaveFileWithTags(filename, outputFilename);
-    } catch (error) {
-      console.error(error);
-      process.exit(1);
-    }
+  .argument('[pattern...]', 'filename pattern(s) to process for insert tags', ['README.md'])
+  .option('-o, --output <path>', 'output directory for processed files', '')
+  .option('-v, --verbose', 'verbose output', false)
+  .action((pattern, options) => {
+    pattern = Array.isArray(pattern) ? pattern : [pattern];
+    const filenames = globSync(pattern);
+    filenames.forEach((filename) => {
+      const outputFilename = path.join(options.output, filename);
+      try {
+        processAndSaveFileWithTags(filename, outputFilename);
+      } catch (error) {
+        console.error(error);
+        process.exit(1);
+      }
+    })
+
+  })
+  .configureHelp({
+    sortOptions: true,
+    sortSubcommands: true,
+    subcommandTerm: '<command>',
+    helpWidth: 80
   });
 
 program.parse(process.argv);