🌅

Author: mrb

.codeclimate.yml

@@ -0,0 +1,5 @@
+engines:
+  fixme:
+    enabled: true
+exclude_paths:
+- "**/*.md"

.gitignore

@@ -0,0 +1 @@
+/node_modules

Dockerfile

@@ -0,0 +1,9 @@
+FROM mhart/alpine-node
+
+WORKDIR /usr/src/app
+
+RUN npm install glob
+
+COPY . /usr/src/app
+
+CMD ["/usr/src/app/bin/fixme"]

LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2015 Code Climate, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,25 @@
+# Code Climate FIXME Engine
+
+`codeclimate-fixme` is a Code Climate engine that finds comments in your code which match the following strings:
+
+* `TODO`
+* `FIXME`
+* `XXX`
+* `HACK`
+* `BUG`
+
+These strings are things you should fix now, not later.
+
+`codecilmate-fixme` is also very simple, and is intended to provide a `Hello World` like template for Code Climate Platform engine authors. It is implemented in JavaScript as an NPM package.
+
+### Installation & Usage
+
+1. If you haven't already, [install the Code Climate CLI](https://github.com/codeclimate/codeclimate).
+2. Run `codeclimate engines:enable fixme`. This command both installs the engine and enables it in your `.codeclimate.yml` file.
+3. You're ready to analyze! Browse into your project's folder and run `codeclimate analyze`.
+
+### Need help?
+
+For help with `codeclimate-fixme`, please open an issue on this repository.
+
+If you're running into a Code Climate issue, first look over this project's [GitHub Issues](https://github.com/codeclimate/codeclimate-watson/issues), as your question may have already been covered. If not, [go ahead and open a support ticket with us](https://codeclimate.com/help).

bin/fixme

@@ -0,0 +1,74 @@
+#!/usr/bin/env node
+
+// Dependencies
+var glob = require("glob");
+var exec = require('child_process').exec;
+
+// Strings to scan for in source
+var fixmeStrings = "'FIXME|TODO|HACK|BUG'";
+
+// Prints properly structured Issue data to STDOUT according to
+// Code Climate Engine specification.
+var printIssue = function(fileName, lineNum){
+  var issue = {
+    "type": "issue",
+    "check_name": "FIXME found",
+    "description": "Code comment found that needs your attention.",
+    "categories": ["Bug Risk"],
+    "location":{
+      "path": fileName,
+      "lines": {
+        "begin": lineNum,
+        "end": lineNum 
+      }
+    }
+  };
+
+  // Issues must be followed by a null byte
+  var issueString = JSON.stringify(issue)+"\0";
+  console.log(issueString);
+}
+
+var findFixmes = function(file){
+  var grepString = "grep -inH -E " + fixmeStrings + " " + file;
+
+  exec(grepString, function(error, stdout, stderr) {
+    var lines = stdout.split("\n");
+    lines.forEach(function(line, index, array){
+      if(index < (array.length-1)){
+        
+        var cols = line.split(":");
+        var fileName = cols[0].split("/code/")[1];
+        var lineNum = cols[1];
+        
+        printIssue(fileName, lineNum);
+      }
+    })
+  })
+}
+
+var fileWalk = function(excludePaths){
+  var analysisFiles = [];
+  var allFiles = glob.sync("/code/**/**", {});
+
+  allFiles.forEach(function(file, i, a){
+    if(excludePaths.indexOf(file.split("/code/")[1]) < 0) {
+      analysisFiles.push(file);
+    }
+  });
+    
+  return analysisFiles;
+}
+
+
+var runEngine = function(){
+  var config = JSON.parse(process.env.ENGINE_CONFIG);
+
+  var analysisFiles = fileWalk(config.exclude_paths);
+
+  analysisFiles.forEach(function(f, i, a){
+    findFixmes(f);
+  });
+}
+
+runEngine();

test/test.js

@@ -0,0 +1,6 @@
+// FIXME make this do something
+function(){
+  console.log("!");
+}
+
+// TODO make this do something too