feat: allow 'includes' and 'excludes' to be used together

Author: Simon Renoult

src/cli.ts

@@ -40,14 +40,14 @@ export default commander
   .option(
     "--excludes <strings>",
     "List of strings (comma separated) used in filenames to exclude " +
-      "(mutually exclusive with '--includes')",
+      "(executed after '--includes')",
     commaSeparatedList,
     []
   )
   .option(
     "--includes <strings>",
     "List of strings (comma separated) used in filenames to include " +
-      "(mutually exclusive with '--excludes')",
+      "(executed before '--excludes')",
     commaSeparatedList,
     []
   )

src/services/compute-complexity.ts

@@ -17,10 +17,6 @@ export default async function computeComplexity(): Promise<void> {
     process.exit(0);
   }
 
-  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(

src/services/prepare-stdout.ts

@@ -6,13 +6,14 @@ export function prepareStdout(
   cli
 ): string[] {
   return filesComplexity
-    .sort(sortResult(cli.sort))
-    .filter(selectFiles(cli.includes, cli.excludes))
-    .filter(limitResult(cli.limit, cli.min, cli.max))
+    .sort(sort(cli.sort))
+    .filter(include(cli.includes))
+    .filter(exclude(cli.excludes))
+    .filter(limit(cli.limit, cli.min, cli.max))
     .map(prepareLine(cli));
 }
 
-function sortResult(sort) {
+function sort(sort) {
   return (fileA: ComplexityPerFile, fileB: ComplexityPerFile): number => {
     if (sort === "complexity") {
       return fileB.complexity - fileA.complexity;
@@ -36,28 +37,31 @@ function sortResult(sort) {
   };
 }
 
-function selectFiles(
-  inclusions = [],
-  exclusions = []
-): (ComplexityPerFile) => boolean {
+function include(inclusions): (ComplexityPerFile) => boolean {
   return (fileComplexity: ComplexityPerFile): boolean => {
     if (inclusions.length) {
       return inclusions.some(pathContains(fileComplexity));
     }
 
+    return true;
+  };
+}
+
+function exclude(exclusions): (ComplexityPerFile) => boolean {
+  return (fileComplexity: ComplexityPerFile): boolean => {
     if (exclusions.length) {
       return !exclusions.some(pathContains(fileComplexity));
     }
 
     return true;
   };
+}
 
-  function pathContains(fileComplexity: ComplexityPerFile) {
-    return (s): boolean => fileComplexity.relativePathToFile.includes(s);
-  }
+function pathContains(fileComplexity: ComplexityPerFile) {
+  return (s): boolean => fileComplexity.relativePathToFile.includes(s);
 }
 
-function limitResult(limit, min, max) {
+function limit(limit, min, max) {
   return (complexityPerFile: ComplexityPerFile, i: number): boolean => {
     if (limit && i >= limit) {
       return false;

test/code-complexity.test.ts

@@ -38,7 +38,7 @@ describe("code-complexity", () => {
       );
     });
 
-    context("With exclude", () => {
+    context("With excludes", () => {
       it("outputs the appropriate values", () => {
         // Given
         const command = [
@@ -101,5 +101,32 @@ describe("code-complexity", () => {
         );
       });
     });
+
+    context("With includes and excludes", () => {
+      it("outputs the appropriate values", () => {
+        // Given
+        const command = [
+          `ts-node ${codeComplexity}`,
+          fixture,
+          `--details`,
+          `--limit 10`,
+          `--sort complexity`,
+          `--includes router`,
+          `--excludes test,examples`
+        ].join(" ");
+
+        // When
+        const output = execSync(command, { encoding: "utf8" });
+
+        // Then
+        expect(output.trim()).to.deep.equal(
+          [
+            "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)"
+          ].join("\n")
+        );
+      });
+    });
   });
 });