various edits and fixes to allow inlcude flag and enhance globbing

Author: ahmadassaf

README.md

@@ -7,6 +7,7 @@ code-notes is based on two npm modules, mainly forked from [fixme](https://githu
  - Flexibility in defining the source scanning directory
  - The ability to pass exclude patterns that are compatible with [multimatch](https://github.com/sindresorhus/multimatch)
  - The ability to read exclusion list from a `.gitignore` file
+ - The ability to include **only** certain path patterns to be scanned
 
 It ends up giving you an output like this:
 
@@ -38,6 +39,7 @@ notes --help
     -s, --source [dir]       root directory to be included only for checks (default: current working directory)
     -x, --patterns [dir]     Path patterns to exclude (default: include all files and directories)
     -e, --encoding [type]    file encoding to be scanned (default: utf8)
+    -i, --include [dir]      Path patterns to include only (default: include all files and directories). Note that include patterns will overwrite any exclude patterns
     -l, --line-length <n>    number of max characters a line (default: 1000)
     -h, --ignore-hidden <n>  ignore hidden files (default: false)
     -g, --git-ignore <n>     ignore patterns from your .gitignore file. This paramter accepts the path for the .gitIgnore file (default: false | no .gitignore is read
@@ -47,6 +49,7 @@ notes --help
 
   * **source:** The path to scan through for notes, defaults to process.cwd()
   * **patterns:** Glob patterns for files directories to ignore. Passes these straight to [multimatch](https://github.com/sindresorhus/multimatch) so check there for more information on proper syntax.
+  * **include** Glob patterns for files or directories to be inlucded **ONLY** in the scan process. Note that any include files will overwrite any exclude patterns
   * **ignoreHidden:** Define if you want to ignore hidden files and directories. Defaults to true as all paths will be scanned.
   * **encoding:** The encoding the files scanned will be opened as.
   * **lineLength:** 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!*
@@ -112,8 +115,12 @@ Those comments would be annotated as:
 notes -g .gitignore -h true
 # Exclude any file under the src directory and node_modules and any file with .md extension
 notes -x src/ -x -x node_modules/ -x *.md
+# Only scan .md files
+notes -i "*.md"
 ```
 
+> **Important**: For some reason that i still cant figure out, some extensions like `.md` `.html` have to be wrapped with `"`. So if your pattern does not seem to work at first, try to wrap it with quotes
+
 ### Extending code-notes
 
 code-notes 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. However, if you wish to define more annotations to be extracted, this can be easily done by extending the definitions in `lib/messageChecks.js`. An example for an annotation:
@@ -128,10 +135,11 @@ todo: {
 
 #### Ignoring files
 
-Certain file extensions are skipped from being scanned. They are defined in `lib/notes.js`
+Certain file extensions and directories are skipped from being scanned. They are defined in `lib/notes.js`
 
 ```javascript
-const BAD_EXTENSIONS = ["!*.jpg", "!*.jpeg", "!*.mov", "!*.mp3", "!*.gif", "!*.png", "!*.log", "!*.bin", "!*.psd", "!*.swf", "!*.fla", "!*.ico"];
+const BAD_EXTENSIONS = ["!*.jpg", "!*.jpeg", "!*.mov", "!*.mp3", "!*.gif", "!*.png", "!*.log", "!*.bin", "!*.psd", "!*.swf", "!*.fla", "!*.ico", "!*.jar", "!*.war", "!*.ear", "!*.zip", "!*.tar.gz", "!*.rar"];
+const BAD_DIRECTORIES= ["!.git/**", "!.sass-cache/**", "!coverage/**"]
 ```
 
 The object should contain the following fields:

bin/notes

@@ -12,6 +12,8 @@ program
 	.option('-s, --source [dir]', 'root directory to be included only for checks (default: current working directory)')
 	.option('-x, --patterns [dir]', 'Path patterns to exclude (default: include all files and directories)',
 		function collect(val, collector) { collector.push("" + val); return collector; }, [])
+	.option('-i, --include [dir]', 'Path patterns to include only (default: include all files and directories). Note that include patterns will overwrite any exclude patterns',
+		function collect(val, collector) { collector.push("" + val); return collector; }, [])
 	.option('-e, --encoding [type]', 'file encoding to be scanned (default: utf8)')
 	.option('-l, --line-length <n>', 'number of max characters a line (default: 1000)', parseInt)
 	.option('-h, --ignore-hidden <n>', 'ignore hidden files (default: false)')

lib/filter.js

@@ -1,15 +1,16 @@
 'use strict';
 
 const multimatch  = require('multimatch');
+const _           = require('lodash');
 
-
-let ignoreHidden, patterns;
+let ignoreHidden, patterns, includePatterns;
 
 class Filter {
 
-	constructor(_ignoreHidden, _patterns) {
-		ignoreHidden = _ignoreHidden;
-		patterns     = _patterns;
+	constructor(_ignoreHidden, _patterns, _includePatterns) {
+		ignoreHidden    = _ignoreHidden;
+		patterns        = _patterns;
+		includePatterns = _includePatterns;
 	}
 
 	/**
@@ -26,9 +27,22 @@ class Filter {
 	 * @return  {Boolean}
 	 */
 	fileFilterer(fileInformation) {
+
 		let matchOptions = {};
+
+		// Check if we have any include patterns and those will overwrite any exclude patters
+		if (!!includePatterns.length) patterns = includePatterns;
+
+		// We want to extract directory filters and based on those check the directory first
+		let directoriesPatterns = _.compact(patterns.map(function(pattern){ if (pattern.indexOf('/') > -1) return pattern  }));
+		let filePatterns        = _.difference(patterns, directoriesPatterns);
+
 		if (!ignoreHidden) matchOptions["dot"] = true;
-		return multimatch(fileInformation.path, patterns, matchOptions).length;
+
+		if (!!directoriesPatterns.length){
+			if (!multimatch(fileInformation.path, patterns, matchOptions).length) return false;
+		}
+		return multimatch(fileInformation.name, filePatterns, matchOptions).length;
 	}
 }
 module.exports = Filter;

lib/notes.js

@@ -11,9 +11,10 @@ const Filter         = require('./filter');
 const formatter      = require('./formatter');
 const messageChecks  = require('./messageChecks');
 
-const BAD_EXTENSIONS = ["!*.jpg", "!*.jpeg", "!*.mov", "!*.mp3", "!*.gif", "!*.png", "!*.log", "!*.bin", "!*.psd", "!*.swf", "!*.fla", "!*.ico"];
+const BAD_EXTENSIONS = ["!*.jpg", "!*.jpeg", "!*.mov", "!*.mp3", "!*.gif", "!*.png", "!*.log", "!*.bin", "!*.psd", "!*.swf", "!*.fla", "!*.ico", "!*.jar", "!*.war", "!*.ear", "!*.zip", "!*.tar.gz", "!*.rar"];
+const BAD_DIRECTORIES= ["!.git/**", "!.sass-cache/**", "!coverage/**"]
 
-let scanPath, fileEncoding, lineLengthLimit, gitIgnore, patterns, ignoreHidden, annotationsFound;
+let scanPath, includePatterns, fileEncoding, lineLengthLimit, gitIgnore, patterns, ignoreHidden, annotationsFound;
 
 /**
  * Takes a line of a file and the line number, and returns an array of all of
@@ -91,7 +92,7 @@ function logMessages(messagesInfo) {
  */
 function scanAndProcessMessages() {
 
-	let filter = new Filter(ignoreHidden, patterns);
+	let filter = new Filter(ignoreHidden, patterns, includePatterns);
 
 	let options = {
 		root      : scanPath,
@@ -164,6 +165,7 @@ function parseUserOptionsAndScan(options) {
 
 	scanPath           = options.source ? options.source : process.cwd();
 	patterns           = options.patterns.length ? _.concat(['**'], options.patterns) : ['**'];
+	includePatterns    = options.include.length ? _.concat(['!**'], options.include) : [];
 	ignoreHidden       = options.ignoreHidden || false;
 	gitIgnore          = options.gitIgnore || false;
 	lineLengthLimit    = options.lineLength || 1000;
@@ -176,9 +178,10 @@ function parseUserOptionsAndScan(options) {
 	});
 
 	patterns = _.concat(patterns, BAD_EXTENSIONS);
+	patterns = _.concat(patterns, BAD_DIRECTORIES);
 
 	if (gitIgnore) {
-
+		console.log(patterns)
 		try {
 
 			let data = fs.readFileSync(gitIgnore, 'utf8');

package.json

@@ -2,7 +2,7 @@
   "author": "Ahmad Assaf",
   "name": "code-notes",
   "description": "Tool to summarise all code annotation like TODO or FIXME",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "repository": {
     "type": "git",
     "url": "git://github.com/ahmadassaf/code-notes.git"