Documentation

Author: Sascha Goldhofer

FuzzyFilePath.md

@@ -3,21 +3,27 @@
 @version 0.2.7
 @author Sascha Goldhofer <[email protected]>
 
-
 ## tasks
 
+- possibly create file caches of all project directories simultaneously
+- Cleanup @TODO flags
+- suddenly Testrunner causes plugin host to expire
+
+### release
+
     - Test changes
     - Test windows paths
+    - Add documentation for multiple folder support
 
-    - cache states where appropriate
-    - possibly create file caches of all project directories simultaneously
-    - Cleanup @TODO flags
+### features
 
     - growing list of triggers is getting unmaintainable
         - Probably group by main-scope in object for faster retrieval and namespacing
         - create an object with ids for a specific trigger and use a list of ids for triggers to use (selecting object)
+        - further support trigger objects in the scope-list
     - add custom triggers without overriding the default scopes
 
+### ideas
+
     - maybe support different triggers based on inserted filepath? (i.e. absolute if matches node_mod...)
-    - suddenly Testrunner causes plugin host to expire
     - possibly send ffp states to serve for better debugging

common/verbose.py

@@ -1,6 +1,6 @@
 import FuzzyFilePath.common.settings as settings
 
-IGNORE = ["CurrentFile", "QueryCompletionListener", "search", "Expression"]
+IGNORE = ["CurrentFile", "QueryCompletionListener", "search", "Expression", "cache"]
 
 def log(*args):
 	if settings.get("log"):

current_state.py

@@ -19,6 +19,7 @@
 file_caches = {} # caches any file indices of each project folder
 state = {} # saves current views state like filename, project_folder, cache and settings
 
+
 def update():
 	""" call me anytime a new view has gained focus. This includes activation of a new window, which should have an
 		active view
@@ -64,7 +65,6 @@ def update():
 	valid = True
 
 	# @TODO cache
-	# @TODO read settings retrieved from folder settings
 	state["file"] = file
 	state["folders"] = folders
 	state["project_folder"] = project_folder
@@ -94,10 +94,12 @@ def get_view():
 	""" legacy: return the current view """
 	return state.get("view")
 
+
 def enable():
 	global is_enabled
 	is_enabled = True
 
+
 def get_file_cache(folder):
 	if not folder in file_caches:
 		valid_file_extensions = get_valid_extensions(settings.get("trigger"))
@@ -132,7 +134,7 @@ def find_file(file_name):
 
 
 def get_valid_extensions(triggers):
-	""" Returns a list of all extensions found in scope triggers """
+	""" Returns a list of all file extensions found in scope triggers """
 	extensionsToSuggest = []
 	for scope in triggers:
 	    ext = scope.get("extensions", [])