added schema description of a rule’s options

README.md

@@ -14,7 +14,7 @@ Adds an ESLint rule to enforce filename conventions for linted files. Allows dif
 ```bash
 $ npm install -D eslint-plugin-filename-rules
 ```
-
+## Old style config
 Add it to your `.eslintrc.js`:
 
 ```js
@@ -28,6 +28,21 @@ module.exports = {
 };
 ```
 
+## Flat config
+
+```js
+import fileName from 'eslint-plugin-filename-rules'
+
+{
+  plugins: {
+    'filename-rules': fileName,
+  },
+  rules: {
+    'filename-rules/match': [2, 'camelcase']
+  }
+}
+```
+
 ## Plugin Options
 
 The following built-in values are supported: `pascalcase`/`PascalCase`, `camelcase`/`camelCase`, `snakecase`/`snake_case`, `kebabcase`/`kebab-case`. You can also provide your own regex:

lib/common/aliases.js

@@ -11,3 +11,13 @@ aliases.snake_case = aliases.snakecase;
 aliases['kebab-case'] = aliases.kebabcase;
 
 exports.aliases = aliases;
+exports.aliasesNames = [
+  'pascalcase',
+  'PascalCase',
+  'camelcase',
+  'camelCase',
+  'kebabcase',
+  'kebab-case',
+  'snakecase',
+  'snake_case',
+];

lib/match.js

@@ -1,15 +1,33 @@
 const path = require('path');
 const { getRegex } = require('./common/getRegex');
+const { aliasesNames } = require('./common/aliases');
 
 const meta = {
   type: 'layout',
+  name: 'match',
   docs: {
     description: 'checks that filenames match a chosen pattern',
   },
   fixable: false,
   messages: {
     noMatch: "Filename '{{name}}' does not match {{value}}.",
   },
+  schema: {
+    type: 'array',
+    minItems: 1,
+    maxItems: 2,
+    oneOf: [
+      {
+        items: [{ type: 'string', enum: aliasesNames }],
+      },
+      {
+        items: [{ type: 'string', pattern: '/.*./' }],
+      },
+      {
+        items: [{ type: 'object' }],
+      },
+    ],
+  },
 };
 
 module.exports = {

lib/notMatch.js

@@ -1,15 +1,33 @@
 const path = require('path');
 const { getRegex } = require('./common/getRegex');
+const { aliasesNames} = require('./common/aliases');
 
 const meta = {
   type: 'layout',
+  name: 'not-match',
   docs: {
     description: 'checks that filenames do not match a chosen pattern',
   },
   fixable: false,
   messages: {
     match: "Filename '{{name}}' must not match {{value}}.",
   },
+  schema: {
+    type: 'array',
+    minItems: 1,
+    maxItems: 2,
+    oneOf: [
+      {
+        items: [{ type: 'string', enum: aliasesNames }],
+      },
+      {
+        items: [{ type: 'string', pattern: '/.*./' }],
+      },
+      {
+        items: [{ type: 'object' }],
+      },
+    ],
+  },
 };
 
 module.exports = {