Created CVS export option

Author: scottamplitude

README.md

@@ -1,6 +1,6 @@
 # code-complexity
 
-> Measure the churn/complexity score. Higher values mean hotspots where 
+> Measure the churn/complexity score. Higher values mean hotspots where
 > refactorings should happen.
 
 [![Build Status][travis-image]][travis-url]
@@ -10,13 +10,13 @@
 
 Quoting Michael Feathers (source [here][michael-feathers-source]):
 
-*Often when we refactor, we look at local areas of code. If we take a wider 
-view, using information from our version control systems, we can get a better 
+*Often when we refactor, we look at local areas of code. If we take a wider
+view, using information from our version control systems, we can get a better
 sense of the effects of our refactoring efforts.*
 
 
-Note: `code-complexity` currently measures complexity using lines of code count. 
-While imperfect, this measure gives a good enough idea of what's going on. 
+Note: `code-complexity` currently measures complexity using lines of code count.
+While imperfect, this measure gives a good enough idea of what's going on.
 
 ## Usage
 
@@ -28,21 +28,21 @@ $ npx code-complexity <path-to-git-directory or URL>
 
 ```text
     Usage: code-complexity <target> [options]
-    
+
     Measure the churn/complexity score. Higher values mean hotspots where refactorings should happen.
-    
+
     Options:
       -V, --version          output the version number
       --filter <strings>     list of globs (comma separated) to filter
-      -f, --format [format]  format results using table or json
+      -f, --format [format]  format results using table, json or csv
       -l, --limit [limit]    limit the number of files to output
       -i, --since [since]    limit the age of the commit analyzed
       -s, --sort [sort]      sort results (allowed valued: score,
                              churn, complexity or file)
       -h, --help             display help for command
-    
+
     Examples:
-    
+
     $ code-complexity .
     $ code-complexity https://github.com/simonrenoult/code-complexity
     $ code-complexity foo --limit 3

src/io/cli.ts

@@ -46,7 +46,7 @@ function getRawCli(
     .option(
       "-f, --format [format]",
       "format results using table or json",
-      /^(table|json)$/i
+      /^(table|json|csv)$/i
     )
     .option(
       "-l, --limit [limit]",

src/io/output.ts

@@ -24,6 +24,9 @@ function render(
     case "json":
       stdout = toJson(values);
       break;
+    case "csv":
+      stdout = toCSV(values);
+      break;
     default:
       stdout = toTable(values);
   }
@@ -50,3 +53,13 @@ function toTable(statistics: Statistics[]): string {
 
   return table.toString();
 }
+
+function toCSV(statistics: Statistics[]): string {
+  let csv = "file,complexity,churn,score\n";
+  statistics.forEach((stat) => {
+    csv +=
+      [stat.path, stat.complexity, stat.churn, stat.score].join(",") + "\n";
+  });
+
+  return csv;
+}

src/lib/types.d.ts

@@ -2,7 +2,7 @@ import { URL } from "url";
 
 export type Path = string;
 export type Sort = "score" | "churn" | "complexity" | "file" | "ratio";
-export type Format = "table" | "json";
+export type Format = "table" | "json" | "csv";
 export type Options = {
   target: string | URL;
   directory: string;