rule docs for filenames match regex

gracepark · gracepark · commit 813592d2d741 · 2024-11-25T13:15:49.000-08:00
diff --git a/docs/rules/filenames-match-regex.md b/docs/rules/filenames-match-regex.md
@@ -0,0 +1,35 @@
+# Ensure filenames match a regex naming convention (`github/filenames-match-regex`)
+
+💼 This rule is enabled in the ✅ `recommended` config.
+
+<!-- end auto-generated rule header -->
+
+## Rule Details
+
+TRule to ensure that filenames match a convention, with a default of camelCase.
+
+👎 Examples of **incorrect** filename for this default rule:
+
+`file-name.js`
+
+👍 Examples of **correct** code for this rule:
+
+`fileName.js`
+
+## Options
+
+regex - Regex to match the filename structure. Defaults to camelCase.
+
+
+```json
+{
+  "filenames-match-regex": [
+    "error",
+    "^[a-z0-9-]+(.[a-z0-9-]+)?$"
+  ]
+}
+```
+
+## Version
+
+4.3.2
