chore: use picomatch for glob matching

Author: abose

package-lock.json

@@ -89,7 +89,7 @@
         "@floating-ui/dom": "^0.5.4",
         "@fortawesome/fontawesome-free": "^6.1.2",
         "@highlightjs/cdn-assets": "^11.5.1",
-        "@phcode/fs": "^2.1.0",
+        "@phcode/fs": "^3.0.0",
         "@pixelbrackets/gfm-stylesheet": "^1.1.0",
         "@prettier/plugin-php": "0.18.9",
         "@uiw/file-icons": "^1.3.2",
@@ -113,4 +113,4 @@
         "tinycolor2": "^1.4.2",
         "underscore": "^1.13.4"
     }
-}
+}

package.json

@@ -19,7 +19,7 @@
     },
     "IMPORTANT!!": "Adding things here will bloat up the package size",
     "dependencies": {
-        "@phcode/fs": "^2.1.0",
+        "@phcode/fs": "^3.0.0",
         "npm": "10.1.0",
         "ws": "^8.13.0",
         "lmdb": "^2.9.2",

src-node/package-lock.json

@@ -249,8 +249,8 @@ define({
     "INCLUDE_FILE_FILTER_DROPDOWN": "Include",
     "EDIT_FILE_FILTER": "Edit\u2026",
     "FILE_FILTER_DIALOG": "Edit Exclusion Filter",
-    "FILE_FILTER_INSTRUCTIONS": "Exclude files and folders matching any of the following <a href='{0}' title='{0}'>ignore wildcards</a>. Enter each string on a new line.",
-    "FILE_FILTER_INSTRUCTIONS_INCLUDE": "Include only files and folders matching any of the following <a href='{0}' title='{0}'>ignore wildcards</a>. Enter each string on a new line.",
+    "FILE_FILTER_INSTRUCTIONS": "Exclude files and folders matching any of the following <a href='{0}' title='{0}'>ignore wildcards</a>. Enter each string on a new line. E.g. <ul><li><code>*.js</code> will match <code>a/b/x.js</code>, <code>xyx.js</code>, etc..</li> <li><code>./*.css</code> will only match <code>x.css</code> in project root, but not <code>y/x.css</code> in sub folder.</li></ul>",
+    "FILE_FILTER_INSTRUCTIONS_INCLUDE": "Include only files and folders matching any of the following <a href='{0}' title='{0}'>ignore wildcards</a>. Enter each string on a new line. E.g. <ul><li><code>*.js</code> will match <code>a/b/x.js</code>, <code>xyx.js</code>, etc..</li> <li><code>./*.css</code> will only match <code>x.css</code> in project root, but not <code>y/x.css</code> in sub folder.</li></ul>",
     "FILTER_NAME_PLACEHOLDER": "Name this exclusion set (optional)",
     "FILTER_NAME_REMAINING": "{0} characters remaining",
     "FILE_FILTER_CLIPPED_SUFFIX": "and {0} more",

src-node/package.json

@@ -210,13 +210,48 @@ define(function (require, exports, module) {
      * that can be used with filterPath()/filterFileList().
      * @param {!Array.<string>} userFilter
      * @param {string} filterType - one of FILTER_TYPE_EXCLUDE or FILTER_TYPE_INCLUDE
-     * @return {{add: function, filter: function}} a gitIgnoreFilter filter that can be passed to filterPath()/filterFileList().
+     * @return {{filterType: string, ignores: function}} a globeFilter filter that can be passed to filterPath()/filterFileList().
      */
     function compile(userFilter, filterType) {
-        const gitIgnoreFilter = window.fs.utils.ignore();
-        gitIgnoreFilter.add(userFilter);
-        gitIgnoreFilter.filterType = filterType || FILTER_TYPE_EXCLUDE;
-        return gitIgnoreFilter;
+        // Automatically apply transforms make writing simple filters more intuitive
+        const subStringFilter = [];
+        const wrappedGlobs = [];
+        for(let glob of userFilter){
+            // *.js -> **/*.js; *.config.js -> **/*.config.js; ?.js -> **/?.js;
+            if (glob.startsWith("*.") || glob.startsWith("?.")) {
+                wrappedGlobs.push(`**/${glob}`); // **/*.txt
+                continue;
+            }
+            // ./ will only match in present project root, this is as an escape for the above transform we apply
+            if(glob.startsWith("./")) {
+                wrappedGlobs.push(glob.slice(2)); // ./*.txt to *.txt
+                continue;
+            }
+            // if not a glob string, we should do a string.includes search to match any substring.
+            if(!(glob.includes("?") || glob.includes("*") ||
+                glob.includes("[") || glob.includes("]") ||
+                glob.includes("\\") || glob.includes("!"))) {
+                subStringFilter.push(glob);
+                continue;
+            }
+            wrappedGlobs.push(glob);
+        }
+
+        const isMatch = window.fs.utils.picomatch(wrappedGlobs, {
+            dot: true
+        });
+        function ignores(relativeOrFullPath) {
+            for(let subStr of subStringFilter){
+                if(relativeOrFullPath.includes(subStr)){
+                    return true;
+                }
+            }
+            return isMatch(relativeOrFullPath);
+        }
+        return {
+            ignores: ignores,
+            filterType: filterType || FILTER_TYPE_EXCLUDE
+        };
     }
 
 
@@ -307,7 +342,7 @@ define(function (require, exports, module) {
         function _getInstructionText() {
             return StringUtils.format(
                 isExclusionFilter ? Strings.FILE_FILTER_INSTRUCTIONS : Strings.FILE_FILTER_INSTRUCTIONS_INCLUDE,
-                "https://git-scm.com/docs/gitignore#_pattern_format");
+                "https://docs.phcode.dev/docs/find-in-files/#creating-an-exclusioninclusion-filter");
         }
 
         let templateVars = {