fix: repoConfig now creates useful defaults when no .sidekickrc file is found. Non language specific analysers are added by default. Language specific analysers are added if the repo contains the lanaguage in question. Analysers that require a config file, e.g. .eslintrc, are only added if the config file is found in the repo. Only lint analysers are specified to fail a ci build. Fixes sidekickcode/tracker#216.

Author: rishson

repoConfig.js

@@ -13,6 +13,8 @@ var eslintConfigLoader = require('sidekick-eslint/configLoader');
 
 var jsonSchema = require('./repoConfig/SidekickSchema.json');
 var files = require('./files');
+//build up analysers in config - start with non language specific analysers
+const DEFAULT_CONFIG = require('./repoConfig/default_sidekickrc.json');
 
 var CONFIG_FILENAME = '.sidekickrc';
 
@@ -93,20 +95,18 @@ function RepoConfig(conf /*: RawConfig */) {
 // if we're missing a .sidekickrc, we do the 'right thing' as far as possible
 function getDefault(repoPath) /*: RawConfig */ {
 
-  //build up analysers in config - start with non language specific analysers
-  var defaultConfig = require('./repoConfig/default_sidekickrc.json');
-
+  var defaultConfig = _.cloneDeep(DEFAULT_CONFIG);
   if(repoHasFilesOfType(repoPath, '.js')){
     doJs();
   }
 
-/*  if(repoHasFilesOfType(repoPath, '.ts')){
+  if(repoHasFilesOfType(repoPath, '.ts')){
     doTs();
-  }*/
+  }
 
-/*  if(repoHasFilesOfType(repoPath, '.cs')){
+  if(repoHasFilesOfType(repoPath, '.cs')){
     doCs();
-  }*/
+  }
 
   return RepoConfig(defaultConfig);
 
@@ -121,6 +121,7 @@ function getDefault(repoPath) /*: RawConfig */ {
     defaultConfig.languages.js = {};
 
     doTodos();
+    doJscs();
     doEsLint();
     doJsHint();
 
@@ -129,6 +130,11 @@ function getDefault(repoPath) /*: RawConfig */ {
       defaultConfig.languages.js['sidekick-js-todos'] = {failCiOnError: false};
     }
 
+    //add jscs
+    function doJscs(){
+      defaultConfig.languages.js['sidekick-jscs'] = {failCiOnError: false};
+    }
+
     //add eslint if we find any eslint config
     function doEsLint(){
       if(eslintConfigLoader.hasConfigFile(repoPath)){
@@ -137,9 +143,38 @@ function getDefault(repoPath) /*: RawConfig */ {
     }
 
     function doJsHint(){
-      if(fs.statSync(path.join(repoPath, '/.jshintrc'))){
+      try {
+        fs.statSync(path.join(repoPath, '/.jshintrc'));
         defaultConfig.languages.js['sidekick-jshint'] = {failCiOnError: true};
-      }
+      }catch(e){}
+    }
+  }
+
+  function doTs(){
+    defaultConfig.languages.ts = {};
+
+    doTsLint();
+    
+    //add tslint if we find any tslint config
+    function doTsLint(){
+      try {
+        fs.statSync(path.join(repoPath, '/tsconfig.json'));
+        defaultConfig.languages.ts['sidekick-tslint'] = {failCiOnError: true};
+      }catch(e){}
+    }
+  }
+
+  function doCs(){
+    defaultConfig.languages.cs = {};
+
+    doCsLint();
+
+    //add cslint if we find any cslint config
+    function doCsLint(){
+      try {
+        fs.statSync(path.join(repoPath, '/coffeelint.json'));
+        defaultConfig.languages.cs['sidekick-coffeelint'] = {failCiOnError: true};
+      }catch(e){}
     }
   }
 
@@ -180,7 +215,6 @@ function parse(string) {
   if(analyserNotObj){
     throw Error('Analysers must be objects');
   }
-
   return reformat(raw);
 }
 

test/fixtures/repoWithoutConfig/coffeelint.json

@@ -0,0 +1 @@
+{}

test/fixtures/repoWithoutConfig/tsconfig.json

@@ -0,0 +1 @@
+{}

test/repoConfigTest.js

@@ -103,16 +103,18 @@ describe('RepoConfig', function() {
       assert.sameMembers(_.keys(config.analysers("json")), ["sidekick-david"]);
       assert.sameMembers(_.keys(config.analysers("all")), ["sidekick-security"]);
       assert.lengthOf(config.analysers("js"), 0);
+      assert.lengthOf(config.analysers("ts"), 0);
+      assert.lengthOf(config.analysers("cs"), 0);
     })
   });
 
   describe('loads defaults - for javascript', function() {
     var config;
     var repoPath = path.join(__dirname, '/fixtures/repoWithoutConfig');
+
     before(function() {
-      var testJS = fs.readFileSync(path.join(__dirname, '/repoConfigTest.js'));
-      fs.writeFile(path.join(repoPath, '/test.js'), testJS);
-      return repoConfig.load(path.join(__dirname, '/fixtures/repoWithoutConfig'))
+      fs.writeFile(path.join(repoPath, '/test.js'), 'function(){}');
+      return repoConfig.load(repoPath)
           .then(function(_config){
             config = _config;
           })
@@ -121,11 +123,62 @@ describe('RepoConfig', function() {
     it('config has javascript specific defaults', function() {
       assert.sameMembers(_.keys(config.analysers("json")), ["sidekick-david"]);
       assert.sameMembers(_.keys(config.analysers("all")), ["sidekick-security"]);
-      assert.sameMembers(_.keys(config.analysers("js")), ["sidekick-eslint", "sidekick-js-todos", "sidekick-jshint"]);
+      assert.sameMembers(_.keys(config.analysers("js")), ["sidekick-eslint", "sidekick-js-todos", "sidekick-jshint", "sidekick-jscs"]);
+      assert.lengthOf(config.analysers("ts"), 0);
+      assert.lengthOf(config.analysers("cs"), 0);
     });
 
-    after(function(){
+  });
+
+  describe('loads defaults - for typescript', function() {
+    var config;
+    var repoPath = path.join(__dirname, '/fixtures/repoWithoutConfig');
+
+    before(function() {
       fs.removeSync(path.join(repoPath, '/test.js'));
+      fs.writeFile(path.join(repoPath, '/test.ts'), 'function(){}');
+      return repoConfig.load(repoPath)
+        .then(function(_config){
+          config = _config;
+        })
+    });
+
+    it('config has typescript specific defaults', function() {
+      assert.sameMembers(_.keys(config.analysers("json")), ["sidekick-david"]);
+      assert.sameMembers(_.keys(config.analysers("all")), ["sidekick-security"]);
+      assert.sameMembers(_.keys(config.analysers("ts")), ["sidekick-tslint"]);
+      assert.lengthOf(config.analysers("js"), 0);
+      assert.lengthOf(config.analysers("cs"), 0);
+    });
+
+    after(function(){
+      fs.removeSync(path.join(repoPath, '/test.ts'));
+    })
+  })
+
+  describe('loads defaults - for coffeescript', function() {
+    var config;
+    var repoPath = path.join(__dirname, '/fixtures/repoWithoutConfig');
+
+    before(function() {
+      fs.removeSync(path.join(repoPath, '/test.ts'));
+      fs.writeFile(path.join(repoPath, '/test.cs'), 'function(){}');
+      return repoConfig.load(repoPath)
+          .then(function(_config){
+            config = _config;
+          })
+    });
+
+    it('config has coffeescript specific defaults', function() {
+      assert.sameMembers(_.keys(config.analysers("json")), ["sidekick-david"]);
+      assert.sameMembers(_.keys(config.analysers("all")), ["sidekick-security"]);
+      assert.sameMembers(_.keys(config.analysers("cs")), ["sidekick-coffeelint"]);
+      assert.lengthOf(config.analysers("js"), 0);
+      assert.lengthOf(config.analysers("ts"), 0);
+    });
+
+    after(function(){
+      fs.removeSync(path.join(repoPath, '/test.cs'));
     })
   })