docs: add docs for rule no-index

Author: dukeluo

README.md

@@ -41,7 +41,15 @@ Then configure the rules you want to use under the rules section.
             "*.test.{js,jsx,ts,tsx}":"**/__tests__/",
             "*.styled.{jsx,tsx}":"**/pages/"
          }
-      ]
+      ],
+      "check-file/filename-naming-convention":[
+         "error",
+         {
+            "*.{js,jsx,ts,tsx}":"CAMEL_CASE",
+            "*.json":"KEBAB_CASE"
+         }
+      ],
+      "check-file/no-index":"error"
    }
 }
 ```
@@ -50,3 +58,4 @@ Then configure the rules you want to use under the rules section.
 
 - [check-file/folder-match-with-fex](docs/rules/folder-match-with-fex.md): Enforce a consistent naming pattern for the folder of the specified file extension
 - [check-file/filename-naming-convention](docs/rules/filename-naming-convention.md): Enforce a consistent naming pattern for the filename of the specified file extension
+- [check-file/no-index](docs/rules/no-index.md): A file cannot be named "index"

docs/rules/no-index.md

@@ -1,35 +1,21 @@
-# A file cannot be named 'index' (no-index)
+# A file cannot be named "index" (no-index)
 
-Please describe the origin of the rule here.
+Prevents files from being named "index".
 
 ## Rule Details
 
-This rule aims to...
+This rule aims to prevent files from being named "index", which will lead to files having meaningful names.
 
-Examples of **incorrect** code for this rule:
-
-```js
-
-// fill me in
+Examples of **incorrect** filename for this rule:
 
+```sh
+index.js
+index.ts
 ```
 
-Examples of **correct** code for this rule:
-
-```js
-
-// fill me in
+Examples of **correct** filename for this rule:
 
+```sh
+calculatePrice.js
+login.tsx
 ```
-
-### Options
-
-If there are any options, describe them here. Otherwise, delete this section.
-
-## When Not To Use It
-
-Give a short description of when it would be appropriate to turn off this rule.
-
-## Further Reading
-
-If there are other links that describe the issue this rule addresses, please include them here in a bulleted list.