example flag for a cli command

Author: anton-107

README.md

@@ -1,7 +1,9 @@
 # codebase-stats-cli
-CLI wrapper around https://github.com/anton-107/codebase-stats-collector 
+
+CLI wrapper around https://github.com/anton-107/codebase-stats-collector
 
 ## Usage
+
+```
+npm run cli -- knowledge-gaps <PATH TO GIT REPO> --ignoreFiles /path/to/ignored/folder
 ```
-npm run cli -- knowledge-gaps
-```

jest.config.js

@@ -4,4 +4,3 @@ module.exports = {
   testEnvironment: "node",
   testPathIgnorePatterns: ["<rootDir>/node_modules/", "<rootDir>/dist/"],
 };
-

src/cli.ts

@@ -1,20 +1,36 @@
 import { cli, command } from "cleye";
 
 export class CommandLineInterface {
-    constructor() {}
-    public run() {
-        cli({
-            commands: [
-                command(
-                    {
-                        name: "knowledge-gaps",
-                        parameters: ["[prompt]"],
-                    },
-                    async () => {
-                        console.log("Calculating files with least number of contributors");
-                    },
-                ),
-            ],
-        });
-    }
-}
+  constructor() {}
+  public run() {
+    cli({
+      commands: [
+        command(
+          {
+            name: "knowledge-gaps",
+            parameters: ["<path to repository>"],
+            flags: {
+              ignoreFiles: {
+                type: String,
+                description: "Which files to ignore in the output",
+              },
+            },
+          },
+          async (argv) => {
+            const repo = argv._.pathToRepository;
+            console.log(
+              "Calculating files with least number of contributors",
+              repo,
+            );
+            if (argv.flags.ignoreFiles) {
+              console.log(
+                "will ignore the following files in the output: ",
+                argv.flags.ignoreFiles,
+              );
+            }
+          },
+        ),
+      ],
+    });
+  }
+}

src/main.ts

@@ -1,3 +1,3 @@
-import {CommandLineInterface} from "./cli";
+import { CommandLineInterface } from "./cli";
 
-new CommandLineInterface().run();
+new CommandLineInterface().run();