feat: add 'excludes' flag

Author: Simon Renoult

src/cli.ts

@@ -9,7 +9,8 @@ const examples = [
   "$ code-complexity <dir> --details",
   "$ code-complexity <dir> --min 10 --max 50",
   "$ code-complexity <dir> --sort complexity",
-  "$ code-complexity <dir> --details --limit 10 --sort complexity"
+  "$ code-complexity <dir> --excludes lib,test",
+  "$ code-complexity <dir> --details --limit 10 --sort complexity --excludes test"
 ];
 
 export default commander
@@ -35,6 +36,11 @@ export default commander
   )
   .option("--min [min]", "Exclude results below <min>", parseInt)
   .option("--max [max]", "Exclude results above <max>", parseInt)
+  .option(
+    "--excludes <strings>",
+    "List of strings (comma separated) used in filenames to exclude",
+    commaSeparatedList
+  )
   .on("--help", () => {
     console.log();
     console.log("Examples:");
@@ -49,3 +55,7 @@ function getPackageJson(): { description: string } {
   const rawPkg = readFileSync(path, "utf8");
   return JSON.parse(rawPkg);
 }
+
+function commaSeparatedList(value: string): Array<string> {
+  return value.split(",");
+}

src/services/compute-complexity.ts

@@ -18,7 +18,11 @@ export default async function computeComplexity(): Promise<void> {
   }
 
   const [directory] = cli.args;
-  const options = { firstParent: cli.firstParent, since: cli.since };
+  const options = {
+    firstParent: cli.firstParent,
+    since: cli.since,
+    excludes: cli.excludes
+  };
 
   const commitCountPerFiles: CommitCountPerFile[] = await countCommitsPerFile(
     directory,

src/services/prepare-stdout.ts

@@ -7,6 +7,7 @@ export function prepareStdout(
 ): string[] {
   return filesComplexity
     .sort(sortResult(cli.sort))
+    .filter(exclude(cli.excludes))
     .filter(limitResult(cli.limit, cli.min, cli.max))
     .map(prepareLine(cli));
 }
@@ -35,6 +36,15 @@ function sortResult(sort) {
   };
 }
 
+function exclude(exclusions = []) {
+  return (fileComplexity): boolean => {
+    const atLeastOneExclusionMatches = exclusions.some(exclusion => {
+      return fileComplexity.relativePathToFile.includes(exclusion);
+    });
+    return atLeastOneExclusionMatches === false;
+  };
+}
+
 function limitResult(limit, min, max) {
   return (complexityPerFile: ComplexityPerFile, i: number): boolean => {
     if (limit && i >= limit) {

test/code-complexity.test.ts

@@ -7,34 +7,66 @@ const codeComplexity = resolve(__dirname, "../src/index.ts");
 const fixture = resolve(__dirname, "code-complexity-fixture");
 
 describe("code-complexity", () => {
-  let output;
+  context("With details, limit and sort", () => {
+    it("outputs the appropriate values", () => {
+      // Given
+      const command = [
+        `ts-node ${codeComplexity}`,
+        fixture,
+        `--details`,
+        `--limit 10`,
+        `--sort complexity`
+      ].join(" ");
 
-  before(() => {
-    const command = [
-      `ts-node ${codeComplexity}`,
-      fixture,
-      `--details`,
-      `--limit 10`,
-      `--sort complexity`
-    ].join(" ");
+      // When
+      const output = execSync(command, { encoding: "utf8" });
 
-    output = execSync(command, { encoding: "utf8" });
-  });
+      // Then
+      expect(output.trim()).to.deep.equal(
+        [
+          "lib/response.js 142416 (commits: 276, sloc: 516)",
+          "test/app.router.js 54714 (commits: 66, sloc: 829)",
+          "lib/router/index.js 40005 (commits: 105, sloc: 381)",
+          "lib/application.js 32818 (commits: 122, sloc: 269)",
+          "lib/request.js 21746 (commits: 131, sloc: 166)",
+          "test/res.send.js 17822 (commits: 38, sloc: 469)",
+          "test/res.sendFile.js 14674 (commits: 22, sloc: 667)",
+          "test/Router.js 11100 (commits: 25, sloc: 444)",
+          "lib/express.js 7875 (commits: 125, sloc: 63)",
+          "lib/utils.js 7095 (commits: 55, sloc: 129)"
+        ].join("\n")
+      );
+    });
+
+    context("With exclude", () => {
+      it("outputs the appropriate values", () => {
+        // Given
+        const command = [
+          `ts-node ${codeComplexity}`,
+          fixture,
+          `--details`,
+          `--limit 8`,
+          `--sort complexity`,
+          `--excludes response,request`
+        ].join(" ");
+
+        // When
+        const output = execSync(command, { encoding: "utf8" });
 
-  it("outputs the appropriate values", () => {
-    expect(output.trim()).to.deep.equal(
-      [
-        "lib/response.js 142416 (commits: 276, sloc: 516)",
-        "test/app.router.js 54714 (commits: 66, sloc: 829)",
-        "lib/router/index.js 40005 (commits: 105, sloc: 381)",
-        "lib/application.js 32818 (commits: 122, sloc: 269)",
-        "lib/request.js 21746 (commits: 131, sloc: 166)",
-        "test/res.send.js 17822 (commits: 38, sloc: 469)",
-        "test/res.sendFile.js 14674 (commits: 22, sloc: 667)",
-        "test/Router.js 11100 (commits: 25, sloc: 444)",
-        "lib/express.js 7875 (commits: 125, sloc: 63)",
-        "lib/utils.js 7095 (commits: 55, sloc: 129)"
-      ].join("\n")
-    );
+        // Then
+        expect(output.trim()).to.deep.equal(
+          [
+            "test/app.router.js 54714 (commits: 66, sloc: 829)",
+            "lib/router/index.js 40005 (commits: 105, sloc: 381)",
+            "lib/application.js 32818 (commits: 122, sloc: 269)",
+            "test/res.send.js 17822 (commits: 38, sloc: 469)",
+            "test/res.sendFile.js 14674 (commits: 22, sloc: 667)",
+            "test/Router.js 11100 (commits: 25, sloc: 444)",
+            "lib/express.js 7875 (commits: 125, sloc: 63)",
+            "lib/utils.js 7095 (commits: 55, sloc: 129)"
+          ].join("\n")
+        );
+      });
+    });
   });
 });