Use Glob Patterns For Exclusions Instead Of Regular Expressions (#51)

This adds a new `phpCodeSniffer.exclude` option that replaces the `phpCodeSniffer.ignorePatterns` option. The new option uses glob patterns instead of regular expressions, making it consistent with other extensions.

CHANGELOG.md

@@ -5,10 +5,16 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- Use glob patterns to exclude files and folders from linting using the `phpCodeSniffer.exclude` option.
+
 ### Fixed
 - Document formatting with no changes clears diagnostics.
 - Document selection formatting only works on the first character of the diagnostic.
 
+### Deprecated
+- `phpCodeSniffer.ignorePatterns` has been deprecated in favor of using glob patterns over regular expressions.
+
 ## [1.6.0] - 2022-05-06
 ### Fixed
 - `phpCodeSniffer.executable` options with spaces throwing errors.

README.md

@@ -8,7 +8,7 @@ VS Code's available features.
 
 ## Configuration
 
-Out of the box this extension will do nothing and must be configured prior to use.
+_**Until you configure it, this extension will not lint any files.**_
 
 ### Standard (`phpCodeSniffer.standard`)
 
@@ -25,3 +25,7 @@ the `phpCodeSniffer.autoExecutable` option if you'd like for the extension to au
 executable. This works by looking for a `{vendor-dir}/bin/phpcs` file in the document's directory and then
 traversing up to the workspace folder if it does not find one. When it fails to find one automatically it
 will fall back to the explicit option.
+
+### File and Folder Exclusions (`phpCodeSniffer.exclude`)
+
+This array of glob patterns allows you to exclude files and folders from linting. While the extension **does** respect any file rules in your coding standard, this option allows you to define additional rules.

package.json

@@ -48,6 +48,7 @@
         "phpCodeSniffer.ignorePatterns": {
           "type": "array",
           "description": "An array of regular expressions for paths that should be ignored by the extension.",
+          "markdownDeprecationMessage": "File and folder exclusions should use glob patterns in `#phpCodeSniffer.exclude#` instead.",
           "default": [
             ".*/vendor/.*"
           ],
@@ -56,6 +57,17 @@
           },
           "scope": "window"
         },
+        "phpCodeSniffer.exclude": {
+          "type": "array",
+          "description": "Glob patterns for files and folders that should be ignored by the extension.",
+          "default": [
+            "**/vendor/**"
+          ],
+          "items": {
+            "type": "string"
+          },
+          "scope": "window"
+        },
         "phpCodeSniffer.lintAction": {
           "type": "string",
           "description": "The editor action that will cause the linter to run.",
@@ -111,10 +123,14 @@
       }
     ]
   },
+  "dependencies": {
+    "minimatch": "^3.0.4"
+  },
   "devDependencies": {
     "@types/jest": "^26.0.23",
     "@types/node": "^12.20.37",
     "@types/vscode": "~1.53.0",
+    "@types/minimatch": "^3.0.4",
     "@typescript-eslint/eslint-plugin": "^4.33.0",
     "@typescript-eslint/parser": "^4.33.0",
     "eslint": "^7.27.0",