fixme - npm Package Compare versions

Comparing version 0.4.2 to 0.4.3

bin/cli.js

@@ -21,2 +21,3 @@ 'use strict';
   -l, --line_length_limit    number of max characters a line (default: 1000)\n\
+  -s, --skip                 list of checks to skip (default: none)\n\
 \n\
@@ -77,2 +78,10 @@ Examples:\n\
 
+var skip = argv.skip || argv.s;
+if (typeof skip === 'string') {
+  skip = [skip];
+}
+if (skip) {
+  options.skip = skip;
+}
+
 fixme(options);

bin/fixme.js

@@ -16,2 +16,3 @@ 'use strict';
     lineLengthLimit     = 1000,
+    skipChecks          = [],
     messageChecks       = {
@@ -263,2 +264,7 @@ note: {
 
+  // Remove skipped checks for our mapping
+  skipChecks.forEach(function (checkName) {
+    delete messageChecks[checkName];
+  });
+
   // TODO: Actually do something meaningful/useful with these handlers.
@@ -289,3 +295,3 @@ stream
             });
-          } else {
+          } else if (skipChecks.indexOf('line') === -1){
             lengthError = 'Fixme is skipping this line because its length is ' +
@@ -327,2 +333,3 @@ 'greater than the maximum line-length of ' +
  * @property  {Number}  options.line_length_limit   The number of characters a line can be before it is ignored. Defaults to 1000.
+ * @property  {Array}   options.skip                An array of names of checks to skip.
  */
@@ -355,2 +362,8 @@ // TODO(johnp): Allow custom messageChecks to be added via options.
     }
+
+    if (options.skip &&
+        Array.isArray(options.skip) &&
+        options.skip.length) {
+      skipChecks = options.skip;
+    }
   }
@@ -357,0 +370,0 @@

package.json

 {
   "name": "fixme",
   "description": "Scan for NOTE, OPTIMIZE, TODO, HACK, XXX, FIXME, and BUG comments within your source, and print them to stdout so you can deal with them.",
-  "version": "0.4.2",
+  "version": "0.4.3",
   "author": "John Postlethwait <[e-mail]>",
@@ -18,2 +18,6 @@ "website": "http://johnpostlethwait.github.io/fixme",
 
+  "scripts": {
+    "test" : "node test/annotation_test.js"
+  },
+
   "bin": {
@@ -20,0 +24,0 @@ "fixme": "bin/cli"

README.md

@@ -40,3 +40,4 @@ # Fixme #
   file_encoding:        'utf8',
-  line_length_limit:    1000
+  line_length_limit:    1000,
+  skip:                 []
 });
@@ -65,2 +66,3 @@ ```
   * **line_length_limit:** The number of max characters a line can be before Fixme gives up and doen not scan it for matches. If a line is too long, the regular expression will take an extremely long time to finish. *You have been warned!*
+  * **skip:** List of check names to skip. Valid options: `note`, `optimize`, `todo`, `hack`, `xxx`, `fixme`, `bug`, `line`. `line` will disable the line length warning.
 
@@ -67,0 +69,0 @@ ### CLI Usage ###

test/annotation_test.js

@@ -7,2 +7,10 @@ // NOTE: This is the sample output for a note!
 // FIXME (John Postlethwait): This is the sample output for a fixme! Seriously fix this...
-// BUG: This is the sample output for a bug! Who checked in a bug?!
+// BUG: This is the sample output for a bug! Who checked in a bug?!
+
+require('../bin/fixme')({
+  path:                 process.cwd(),
+  ignored_directories:  ['node_modules/**', '.git/**'],
+  file_patterns:        ['**/annotation_test.js'],
+  file_encoding:        'utf8',
+  line_length_limit:    1000
+});

No alert changes

Improved metrics

Total package byte prevSize

22372

increased by5.25%

Lines of code

400

increased by6.95%

Number of lines in readme file

123

increased by1.65%

No dependency changes