docs: add basic example

Author: dukeluo

examples/basic/README.md

@@ -0,0 +1,3 @@
+# Basic Example
+
+This example demonstrates how to use `eslint-plugin-check-file` to enforce consistent file and folder naming conventions.

examples/basic/eslint.config.js

@@ -0,0 +1,41 @@
+import checkFile from '../../lib/index.js';
+
+export default [
+  {
+    files: ['src/**/*'],
+    plugins: {
+      'check-file': checkFile,
+    },
+    rules: {
+      'check-file/no-index': 'error',
+      'check-file/filename-blocklist': [
+        'error',
+        {
+          '**/*.model.ts': '*.models.ts',
+          '**/*.util.ts': '*.utils.ts',
+        },
+      ],
+      'check-file/folder-match-with-fex': [
+        'error',
+        {
+          '*.test.{js,jsx,ts,tsx}': '**/__tests__/',
+          '*.styled.{jsx,tsx}': '**/components/',
+        },
+      ],
+      'check-file/filename-naming-convention': [
+        'error',
+        {
+          '**/*.{jsx,tsx}': 'PASCAL_CASE',
+          '**/*.{js,ts}': 'CAMEL_CASE',
+        },
+      ],
+      'check-file/folder-naming-convention': [
+        'error',
+        {
+          'src/**/': 'CAMEL_CASE',
+          'src/components/*/': 'PASCAL_CASE',
+        },
+      ],
+    },
+  },
+];