docs: improve docs

Author: dukeluo

docs/rules/filename-blocklist.md

@@ -11,28 +11,30 @@ Allows you to blocklist certain file name patterns.
 This rule aims to maintain a consistent naming scheme. This rule uses the glob match syntax to declare blocklisted and preferred filename patterns.
 
 If the rule had been set as follows:
+
 ```js
 ...
 'check-file/filename-blocklist': ['error', { '**/*.model.ts': '*.models.ts' }],
 ...
 ```
 
 Examples of **incorrect** filename with path for this rule:
+
 ```sh
 src/foo.model.ts
 src/bar.model.ts
 ```
 
 Examples of **correct** filename with path for this rule:
+
 ```sh
 src/foo.models.ts
 src/bar.models.ts
 ```
 
 :warning: :warning: :warning:
 
-**Versions <= v2.0.0 can only select target files by their filenames, not by their paths. This support has been deprecated and will be removed in the future. Please select your target files by their file path. For example, using `**/*.js` instead of `*.js` to select all `js` files.**
-
+**Versions <= v2.0.0 can only select target files by their filenames, not by their paths. This support has been deprecated and will be removed in the future. Please select your target files by their file path. For example, using `**/_.js`instead of`_.js`to select all`js` files.\*\*
 
 ### Options
 
@@ -42,43 +44,48 @@ The key is used to declare the blocklisted filename pattern, while the value is
 
 ```js
 module.exports = {
-  plugins: [
-    'check-file',
-  ],
+  plugins: ['check-file'],
   rules: {
-    'check-file/filename-blocklist': ['error', {
-      '**/*.model.ts': '*.models.ts',
-      '**/*.util.ts': '*.utils.ts',
-    }],
+    'check-file/filename-blocklist': [
+      'error',
+      {
+        '**/*.model.ts': '*.models.ts',
+        '**/*.util.ts': '*.utils.ts',
+      },
+    ],
   },
 };
 ```
 
-An optional "nonGlobSuggestion" argument can be passed that allows the blocklist reason to be any string, instead of a strict glob pattern
+#### rule configuration object
+
+##### `nonGlobSuggestion`
+
+If `true`, it allows the blocklist reason to be any string, instead of a strict glob pattern.
 
 ```js
 module.exports = {
-  plugins: [
-    'check-file',
-  ],
+  plugins: ['check-file'],
   rules: {
-    'check-file/filename-blocklist': ['error', {
-      '**/*.model.ts': 'see the repo rules at http://some/example.com',
-      '**/*.util.ts': 'for a non glob related reason',
-    },
-      { nonGlobSuggestion: true, }
+    'check-file/filename-blocklist': [
+      'error',
+      {
+        '**/*.model.ts': 'see the repo rules at http://some/example.com',
+        '**/*.util.ts': 'for a non glob related reason',
+      },
+      { nonGlobSuggestion: true },
     ],
   },
 };
 ```
 
 These rules would produce errors that look like:
-1. 'The filename "model.ts" matches the blocklisted "**/*.model.ts" pattern,  this is not allowed see the repo rules at http://some/example.com'
-2. 'The filename "util.ts" matches the blocklisted "**/*.util.ts" pattern,  this is not allowed for a non glob related reason'
 
+- `The filename "model.ts" matches the blocklisted "**/*.model.ts" pattern,  this is not allowed see the repo rules at http://some/example.com`
+- `The filename "util.ts" matches the blocklisted "**/*.util.ts" pattern,  this is not allowed for a non glob related reason`
 
 ## Further Reading
 
 - [micromatch](https://github.com/micromatch/micromatch)
-- [glob](https://en.wikipedia.org/wiki/Glob_(programming))
+- [glob](<https://en.wikipedia.org/wiki/Glob_(programming)>)
 - [testing glob expression online](https://globster.xyz)

docs/rules/filename-naming-convention.md

@@ -8,23 +8,25 @@ This rule aims to format the filename of the specified file. This rule uses the
 
 There are six naming conventions built into this rule, including `CAMEL_CASE`, `PASCAL_CASE`, `SNAKE_CASE`, `KEBAB_CASE`, `SCREAMING_SNAKE_CASE` and `FLAT_CASE`.
 
-| Formatting | Name |
-|---|---|
-| helloWorld | `CAMEL_CASE` |
-| HelloWorld | `PASCAL_CASE` |
-| hello_world | `SNAKE_CASE` |
-| hello-world | `KEBAB_CASE` |
+| Formatting  | Name                   |
+| ----------- | ---------------------- |
+| helloWorld  | `CAMEL_CASE`           |
+| HelloWorld  | `PASCAL_CASE`          |
+| hello_world | `SNAKE_CASE`           |
+| hello-world | `KEBAB_CASE`           |
 | HELLO_WORLD | `SCREAMING_SNAKE_CASE` |
-| helloworld | `FLAT_CASE` |
+| helloworld  | `FLAT_CASE`            |
 
 If the rule had been set as follows:
+
 ```js
 ...
 'check-file/filename-naming-convention': ['error', { 'src/services/*.js': 'PASCAL_CASE' }],
 ...
 ```
 
 Examples of **incorrect** filename with path for this rule:
+
 ```sh
 src/services/downloadService.js
 src/services/downloadservice.js
@@ -33,12 +35,14 @@ src/services/download_service.js
 ```
 
 Examples of **correct** filename with path for this rule:
+
 ```sh
 src/services/DownloadService.js
 src/download-service.js // this file is not be specified by the target pattern, so it is skipped
 ```
 
 In addition to the built-in naming conventions, you can also set custom naming patterns using glob match syntax. The following code shows an example of how to ensure that all your `js` files are named begin with `__`:
+
 ```js
 ...
 'check-file/filename-naming-convention': ['error', {'**/*.js': '__+([a-z])'}],
@@ -56,19 +60,22 @@ Prefined match syntax allow you to capture specific part of the target file patt
 To use prefined match in your rule set, you can use the `<index>` syntax. The index refers to the position where the glob matcher occurs in the target file pattern expression, starting with `0`. Read more about glob capture groups in the [micromatch documentation](https://github.com/micromatch/micromatch#capture).
 
 If the rule had been set as follows:
+
 ```js
 ...
 'check-file/filename-naming-convention': ['error', { '**/*/!(index).*': '<1>' }, { 'ignoreMiddleExtensions': true }],
 ...
 ```
 
 Examples of **incorrect** filename with path for this rule:
+
 ```sh
 src/Portal/type.ts
 src/Portal/base.tsx
 ```
 
 Examples of **correct** filename with path for this rule:
+
 ```sh
 src/Portal/index.ts
 src/Portal/Portal.test.tsx
@@ -126,5 +133,5 @@ module.exports = {
 ## Further Reading
 
 - [micromatch](https://github.com/micromatch/micromatch)
-- [glob](https://en.wikipedia.org/wiki/Glob_(programming))
+- [glob](<https://en.wikipedia.org/wiki/Glob_(programming)>)
 - [testing glob expression online](https://globster.xyz)

docs/rules/folder-match-with-fex.md

@@ -7,18 +7,21 @@ Allows you to enforce a consistent naming pattern for the specified files' folde
 This rule aims to format the folder of the specified files. It will be useful when you want to group the specified files into a folder. This rule uses the glob match syntax to match target files and declare the naming pattern for their folder names.
 
 If the rule had been set as follows:
+
 ```js
 ...
 'check-file/folder-match-with-fex': ['error', {'*.test.js': '**/__tests__/'}],
 ...
 ```
 
 For the file `foo.test.js`, examples of **incorrect** folder for this rule:
+
 ```sh
 bar/_tests_/foo.test.js
 ```
 
 For the file `foo.test.js`, examples of **correct** folder for this rule:
+
 ```sh
 bar/__tests__/foo.test.js
 ```
@@ -28,22 +31,24 @@ bar/__tests__/foo.test.js
 #### naming pattern object
 
 The key is used to select target files, while the value is used to declare the naming pattern for their folder names. You can specify a different folder naming pattern for different target files. The plugin will only check files you explicitly provided:
+
 ```js
 module.exports = {
-  plugins: [
-    'check-file',
-  ],
+  plugins: ['check-file'],
   rules: {
-    'check-file/folder-match-with-fex': ['error', {
-      '*.test.{js,jsx,ts,tsx}': '**/__tests__/',
-      '*.styled.{jsx,tsx}': '**/pages/',
-    }],
+    'check-file/folder-match-with-fex': [
+      'error',
+      {
+        '*.test.{js,jsx,ts,tsx}': '**/__tests__/',
+        '*.styled.{jsx,tsx}': '**/pages/',
+      },
+    ],
   },
 };
 ```
 
 ## Further Reading
 
 - [micromatch](https://github.com/micromatch/micromatch)
-- [glob](https://en.wikipedia.org/wiki/Glob_(programming))
+- [glob](<https://en.wikipedia.org/wiki/Glob_(programming)>)
 - [testing glob expression online](https://globster.xyz)