Don't ignore comments in .codeclimate.yml

Author: maxjacobson

lib/fix-me.js

@@ -1,5 +1,6 @@
 var readline = require('readline');
 var spawn = require('child_process').spawn;
+var fs = require('fs');
 
 var DEFAULT_PATHS = ['./'];
 var DEFAULT_STRINGS = ['BUG', 'FIXME', 'HACK', 'TODO', 'XXX'];
@@ -35,6 +36,15 @@ FixMe.prototype.run = function(engineConfig) {
  this.find(paths, strings);
 };
 
+var isItsOwnConfig = function(path, lineNumber) {
+ if (path.indexOf(".codeclimate.yml") === -1) { return false; }
+ var lines = fs.readFileSync(path, "utf8").split("\n");
+ var line = lines[lineNumber - 1];
+ if(!line) { return false; }
+ if (line.match(/^\s*#/)) { return false; }
+ return true;
+};
+
 FixMe.prototype.find = function(paths, strings, callback) {
  var pattern = `(${strings.join('|')})`;
  var grep = spawn('grep', [...GREP_OPTIONS, pattern, ...paths]);
@@ -50,7 +60,7 @@ FixMe.prototype.find = function(paths, strings, callback) {
  return;
  }
 
- if(path.indexOf('.codeclimate.yml') !== -1) { return; }
+ if(isItsOwnConfig(path, lineNumber)) { return; }
 
  var issue = {
  'categories': ['Bug Risk'],

test/fix-me.js

@@ -60,14 +60,17 @@ describe("fixMe", function(){
  engine.run(engineConfig);
  });
 
- it('ignores .codeclimate.yml', function(done) {
+ it('ignores .codeclimate.yml, except for comments', function(done) {
  var buf = new IssueBuffer();
  var engine = new FixMe(buf);
 
  engine.find(['test/fixtures/'], ['URGENT'], function() {
  var issues = buf.toIssues();
- expect(issues.length).to.eq(1);
- expect(issues[0].location.path).to.eq('test/fixtures/urgent.js');
+ expect(issues.length).to.eq(2);
+
+ expect(issues[0].location.path).to.eq('test/fixtures/.codeclimate.yml');
+ expect(issues[0].location.lines.begin).to.eq(2);
+ expect(issues[1].location.path).to.eq('test/fixtures/urgent.js');
  done();
  });
  });

test/fixtures/.codeclimate.yml

@@ -1,4 +1,5 @@
 engines:
+ # URGENT: enable duplication engine
  fixme:
  enabled: true
  config: