feat: add 'includes' flag (mutually exclusive with 'excludes')

Author: Simon Renoult

src/cli.ts

@@ -10,6 +10,7 @@ const examples = [
   "$ code-complexity <dir> --min 10 --max 50",
   "$ code-complexity <dir> --sort complexity",
   "$ code-complexity <dir> --excludes lib,test",
+  "$ code-complexity <dir> --includes users",
   "$ code-complexity <dir> --details --limit 10 --sort complexity --excludes test"
 ];
 
@@ -38,8 +39,17 @@ export default commander
   .option("--max [max]", "Exclude results above <max>", parseInt)
   .option(
     "--excludes <strings>",
-    "List of strings (comma separated) used in filenames to exclude",
-    commaSeparatedList
+    "List of strings (comma separated) used in filenames to exclude " +
+      "(mutually exclusive with '--includes')",
+    commaSeparatedList,
+    []
+  )
+  .option(
+    "--includes <strings>",
+    "List of strings (comma separated) used in filenames to include " +
+      "(mutually exclusive with '--excludes')",
+    commaSeparatedList,
+    []
   )
   .on("--help", () => {
     console.log();

src/services/compute-complexity.ts

@@ -17,13 +17,12 @@ export default async function computeComplexity(): Promise<void> {
     process.exit(0);
   }
 
-  const [directory] = cli.args;
-  const options = {
-    firstParent: cli.firstParent,
-    since: cli.since,
-    excludes: cli.excludes
-  };
+  if (cli.includes.length !== 0 && cli.excludes.length !== 0) {
+    throw new Error("Options 'includes' and 'excludes' are mutually exclusive");
+  }
 
+  const [directory] = cli.args;
+  const options = { firstParent: cli.firstParent, since: cli.since };
   const commitCountPerFiles: CommitCountPerFile[] = await countCommitsPerFile(
     directory,
     options

src/services/prepare-stdout.ts

@@ -7,7 +7,7 @@ export function prepareStdout(
 ): string[] {
   return filesComplexity
     .sort(sortResult(cli.sort))
-    .filter(exclude(cli.excludes))
+    .filter(selectFiles(cli.includes, cli.excludes))
     .filter(limitResult(cli.limit, cli.min, cli.max))
     .map(prepareLine(cli));
 }
@@ -36,13 +36,25 @@ function sortResult(sort) {
   };
 }
 
-function exclude(exclusions = []) {
-  return (fileComplexity): boolean => {
-    const atLeastOneExclusionMatches = exclusions.some(exclusion => {
-      return fileComplexity.relativePathToFile.includes(exclusion);
-    });
-    return atLeastOneExclusionMatches === false;
+function selectFiles(
+  inclusions = [],
+  exclusions = []
+): (ComplexityPerFile) => boolean {
+  return (fileComplexity: ComplexityPerFile): boolean => {
+    if (inclusions.length) {
+      return inclusions.some(pathContains(fileComplexity));
+    }
+
+    if (exclusions.length) {
+      return !exclusions.some(pathContains(fileComplexity));
+    }
+
+    return true;
   };
+
+  function pathContains(fileComplexity: ComplexityPerFile) {
+    return (s): boolean => fileComplexity.relativePathToFile.includes(s);
+  }
 }
 
 function limitResult(limit, min, max) {

test/code-complexity.test.ts

@@ -45,7 +45,7 @@ describe("code-complexity", () => {
           `ts-node ${codeComplexity}`,
           fixture,
           `--details`,
-          `--limit 8`,
+          `--limit 10`,
           `--sort complexity`,
           `--excludes response,request`
         ].join(" ");
@@ -63,7 +63,40 @@ describe("code-complexity", () => {
             "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)"
+            "lib/utils.js 7095 (commits: 55, sloc: 129)",
+            "lib/view.js 6384 (commits: 84, sloc: 76)",
+            "test/app.use.js 5936 (commits: 14, sloc: 424)"
+          ].join("\n")
+        );
+      });
+    });
+
+    context("With includes", () => {
+      it("outputs the appropriate values", () => {
+        // Given
+        const command = [
+          `ts-node ${codeComplexity}`,
+          fixture,
+          `--details`,
+          `--limit 10`,
+          `--sort complexity`,
+          `--includes router`
+        ].join(" ");
+
+        // When
+        const output = execSync(command, { encoding: "utf8" });
+
+        // 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/router/route.js 2856 (commits: 28, sloc: 102)",
+            "lib/router/layer.js 1602 (commits: 18, sloc: 89)",
+            "test/acceptance/multi-router.js 78 (commits: 2, sloc: 39)",
+            "examples/multi-router/index.js 22 (commits: 2, sloc: 11)",
+            "examples/multi-router/controllers/api_v1.js 9 (commits: 1, sloc: 9)",
+            "examples/multi-router/controllers/api_v2.js 9 (commits: 1, sloc: 9)"
           ].join("\n")
         );
       });