codeclimate · Aug 16, 2023 · Aug 18, 2023 · Aug 21, 2023 · Aug 21, 2023 · Aug 21, 2023
Showing with 664 additions and 285 deletions.

+4 −31 README.md

+3 −2 bin/fixme

+0 −88 lib/fix-me.js

+137 −0 lib/fixme.js

+438 −0 package-lock.json

+5 −2 package.json

+0 −162 test/fix-me.js

+77 −0 test/fixme.js
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
-# Code Climate FIXME Engine
+# Code Climate FIXME CLI 
 
-`codeclimate-fixme` is a Code Climate engine that performs a case-sensitive search for the following strings in your project:
+`codeclimate-fixme` is a CLI that performs a case-sensitive search for the following strings in your project:
 
 * `TODO`
 * `FIXME`
@@ -10,34 +10,7 @@
 
 These strings are things you should fix now, not later.
 
-`codeclimate-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`.
-
-### Configuration
-
-You can specify what strings to match by adding a `strings` key in your
-`.codeclimate.yml`:
-
-```yaml
-engines:
-  fixme:
-    enabled: true
-    config:
-      strings:
-      - FIXME
-      - CUSTOM
-```
-
-**NOTE**: values specified here *override* the defaults, they are not
-*additional* strings to match.
-
-### 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-fixme/issues), as your question may have already been covered. If not, [go ahead and open a support ticket with us](https://codeclimate.com/help).
+1. `npm i codeclimate-fixme`
+2. `fixme [table|json|sarif] [path]`
diff --git a/bin/fixme b/bin/fixme
@@ -1,13 +1,14 @@
 #!/usr/bin/env node
 
 var fs = require('fs');
-var FixMe = require('../lib/fix-me');
+var FixMe = require('../lib/fixme');
 var config;
 
 fs.readFile('/config.json', function(err, data) {
   if (!err) {
     config = JSON.parse(data);
   }
 
-  new FixMe().run(config)
+  var fixer = new FixMe();
+  fixer.run(config);
 });
diff --git a/lib/fix-me.js b/lib/fix-me.js
diff --git a/lib/fixme.js b/lib/fixme.js
@@ -0,0 +1,137 @@
+const readline = require('readline');
+const { spawn } = require('child_process');
+const fs = require('fs');
+
+const DEFAULT_PATHS = ['./'];
+const DEFAULT_STRINGS = ['BUG', 'FIXME', 'HACK', 'TODO', 'XXX'];
+const GREP_OPTIONS = [
+  '--binary-files=without-match',
+  '--extended-regexp',
+  '--line-number',
+  '--only-matching',
+  '--recursive',
+  '--with-filename',
+  '--word-regexp',
+];
+
+class FixMe {
+  constructor(writable) {
+    this.output = writable || process.stdout;
+    this.maxPathLength = 4;  // initial length of "Path"
+    this.maxLineLength = 4;  // initial length of "Line"
+    this.maxTypeLength = 4;  // initial length of "Type"
+    this.issues = [];
+  }
+
+  run(engineConfig) {
+    const outputPathType = process.argv.includes('--json')
+      ? 'json'
+      : process.argv.includes('--table')
+      ? 'table'
+      : process.argv.includes('--sarif')
+      ? 'sarif'
+      : 'default';
+
+    if (outputPathType === 'default' || process.argv.includes('--help')) {
+      console.log('Usage: fixme [OPTIONS] [PATH]\n\nOptions:\n --json\tOutput results in JSON format.\n --table\tOutput results in table format.\n --sarif\tOutput results in SARIF format.\n --help\tShow help.');
+      return;
+    }
+
+    let paths = DEFAULT_PATHS;
+    if (engineConfig && engineConfig.include_paths) {
+      paths = engineConfig.include_paths;
+    } else if (process.argv.length > 3) {
+      paths = process.argv.slice(3);
+    }
+
+    const strings = (engineConfig && engineConfig.config && engineConfig.config.strings) || DEFAULT_STRINGS;
+
+    this.find(paths, strings, outputPathType);
+  }
+
+  find(paths, strings, outputPathType, callback) {
+    const pattern = `(${strings.join('|')})`;
+    const grep = spawn('grep', [...GREP_OPTIONS, pattern, ...paths]);
+
+    readline.createInterface({ input: grep.stdout }).on('line', (line) => {
+      const [fullPath, lineStr, matchedString] = line.split(':');
+      const path = fullPath.replace(/^\/code\//, '');
+      const lineNumber = parseInt(lineStr, 10);
+
+      if (!path || !lineNumber || !matchedString) {
+        process.stderr.write(`Ignoring malformed output: ${line}\n`);
+        return;
+      }
+
+      // Update the maximum widths for each column for better formatting
+      this.maxPathLength = Math.max(this.maxPathLength, path.length);
+      this.maxLineLength = Math.max(this.maxLineLength, `${lineNumber}`.length);
+      this.maxTypeLength = Math.max(this.maxTypeLength, matchedString.length);
+
+      const issue = {
+        'categories': ['Bug Risk'],
+        'check_name': matchedString,
+        'description': `${matchedString} found`,
+        'file_path': path,
+        'start_line': lineNumber,
+        'type': 'issue',
+      };
+
+      this.issues.push(issue);
+    });
+
+    grep.stdout.on('close', () => {
+      if (outputPathType === 'json') {
+        this.output.write(JSON.stringify(this.issues));
+      } else if (outputPathType === 'table') {
+        // Print table format here...
+      } else if (outputPathType === 'sarif') {
+        this.outputSARIF();
+      }
+      if (callback) callback();
+    });
+  }
+
+  outputSARIF() {
+    const sarifResults = this.issues.map(issue => ({
+      ruleId: issue.check_name,
+      message: {
+        text: issue.description,
+      },
+      locations: [{
+        physicalLocation: {
+          artifactLocation: {
+            uri: issue.file_path,
+          },
+          region: {
+            startLine: issue.start_line,
+          },
+        },
+      }],
+    }));
+
+    const sarifOutput = {
+      $schema: "https://schemastore.azurewebsites.net/schemas/json/sarif-2.1.0-rtm.5.json",
+      version: "2.1.0",
+      runs: [{
+        tool: {
+          driver: {
+            name: "fixMe",
+            rules: this.issues.map(issue => ({
+              id: issue.check_name,
+              name: issue.check_name,
+              shortDescription: {
+                text: issue.description,
+              },
+            })),
+          },
+        },
+        results: sarifResults,
+      }],
+    };
+
+    this.output.write(JSON.stringify(sarifOutput));
+  }
+}
+
+module.exports = FixMe;