feat: --ignore flag (#206)

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

Author: flakey5

README.md

@@ -36,6 +36,7 @@ CLI tool to generate API documentation of a Node.js project.
 
 Options:
   -i, --input [patterns...]  Specify input file patterns using glob syntax
+  --ignore [patterns...]     Specify files to be ignored from the input using glob syntax
   -o, --output <path>        Specify the relative or absolute output directory
   -v, --version <semver>     Specify the target version of Node.js, semver compliant (default: "v22.6.0")
   -c, --changelog <url>      Specify the path (file: or https://) to the CHANGELOG.md file (default: "https://raw.githubusercontent.com/nodejs/node/HEAD/CHANGELOG.md")

bin/cli.mjs

@@ -29,6 +29,12 @@ program
       'Specify input file patterns using glob syntax'
     ).makeOptionMandatory()
   )
+  .addOption(
+    new Option(
+      '--ignore [patterns...]',
+      'Specify which input files to ignore using glob syntax'
+    )
+  )
   .addOption(
     new Option(
       '-o, --output <path>',
@@ -87,6 +93,7 @@ program
  */
 const {
   input,
+  ignore,
   output,
   target = [],
   version,
@@ -101,7 +108,7 @@ const linter = createLinter(lintDryRun, disableRule);
 const { loadFiles } = createMarkdownLoader();
 const { parseApiDocs } = createMarkdownParser();
 
-const apiDocFiles = loadFiles(input);
+const apiDocFiles = loadFiles(input, ignore);
 
 const parsedApiDocs = await parseApiDocs(apiDocFiles);
 

src/loaders/markdown.mjs

@@ -16,14 +16,20 @@ const createLoader = () => {
    * Loads API Doc files and transforms it into VFiles
    *
    * @param {string} searchPath A glob/path for API docs to be loaded
+   * @param {string | undefined} ignorePath A glob/path of files to ignore
    * The input string can be a simple path (relative or absolute)
    * The input string can also be any allowed glob string
    *
    * @see https://code.visualstudio.com/docs/editor/glob-patterns
    */
-  const loadFiles = searchPath => {
+  const loadFiles = (searchPath, ignorePath) => {
+    const ignoredFiles = ignorePath
+      ? globSync(ignorePath).filter(filePath => extname(filePath) === '.md')
+      : [];
+
     const resolvedFiles = globSync(searchPath).filter(
-      filePath => extname(filePath) === '.md'
+      filePath =>
+        extname(filePath) === '.md' && !ignoredFiles.includes(filePath)
     );
 
     return resolvedFiles.map(async filePath => {