Update codeit-autocomplete.js

Author: benhatsor

lib/plugins/codeit-autocomplete.js

@@ -167,14 +167,14 @@ acp.autocomplete = async (lang) => {
  * 1. Init function
  * ----------------
  *
- * Every acp language has an init function
- * that's called on the first load of a file
- * with the language:
+ * An init function that's called
+ * on the first load of a file
+ * containing the defined language:
  *
- * acp.lang.<lang>.init = () => {
- *   ...
- *   acp.lang.<lang>.props = <props>;
- * }
+   acp.lang.<lang>.init = () => {
+     ...
+     acp.lang.<lang>.props = <props>;
+   }
  *
  * Terms:
  * <lang> - language name
@@ -184,22 +184,46 @@ acp.autocomplete = async (lang) => {
  * 2. Autocomplete function
  * ------------------------
  *
- * Called on every type. Here you can process
- * the query and return results:
+ * Called on every type. Here you can return
+ * autocomplete results:
  *
- * acp.lang.<lang>.autocomplete = (query) => {
- *   ...
- *   return <results>;
- * }
+   acp.lang.<lang>.autocomplete = (<query>) => {
+     ...
+     return <results>;
+   }
  *
  * Terms:
- * query - text of the current line before the cursor.
- *         newlines, spaces and tabs won't be included.
- * <results> - array of strings to show in the autocomplete menu
+ * <lang> - language name
+ * <query> - text of the current line before the cursor.
+ *           newlines, spaces and tabs won't be included.
+ * <results> - array of strings to show in the autocomplete menu.
+ *             these get automatically sorted by relevance.
+ * 
+ * To disable automatic <results> sorting, return:
+     return [<results>, { sort: false }];
+ *
+ *
+ * [Optional] 3. Query processing function
+ * ---------------------------------------
+ *
+ * You can define an optional function
+ * to process the query.
+ * In this case, an additional parameter, <rawQuery>,
+ * will be passed to the autocomplete function.
  * 
- * Results are automatically sorted.
- * To disable automatic sorting, return:
- *   return [<results>, { sort: false }];
+   acp.lang.<lang>.processQuery = (<query>) => {
+     ... 
+     return <procQuery>;
+   }
+ *
+ * Terms:
+ * <lang> - language name
+ * <query> - text of the current line before the cursor.
+ *           newlines, spaces and tabs won't be included.
+ * <procQuery> - proccessed query. this'll be set to the current query
+ *
+ * In autocomplete function:
+ * <rawQuery> - Unproccessed query.
  */