feat: add rule no-index

Author: dukeluo

docs/rules/no-index.md

@@ -0,0 +1,35 @@
+# A file cannot be named 'index' (no-index)
+
+Please describe the origin of the rule here.
+
+## Rule Details
+
+This rule aims to...
+
+Examples of **incorrect** code for this rule:
+
+```js
+
+// fill me in
+
+```
+
+Examples of **correct** code for this rule:
+
+```js
+
+// fill me in
+
+```
+
+### 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.

lib/rules/no-index.js

@@ -0,0 +1,44 @@
+/**
+ * @fileoverview A file cannot be named "index"
+ * @author Duke Luo
+ */
+'use strict';
+
+const { getDocUrl } = require('../utils/doc');
+const { getFilename, getBasename } = require('../utils/filename');
+
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
+module.exports = {
+  meta: {
+    type: 'layout',
+    docs: {
+      description: 'A file cannot be named "index"',
+      category: 'Layout & Formatting',
+      recommended: false,
+      url: getDocUrl('no-index'),
+    },
+    fixable: null,
+    schema: [],
+  },
+
+  create(context) {
+    return {
+      Program: (node) => {
+        const filenameWithPath = context.getFilename();
+        const filename = getFilename(filenameWithPath);
+        const basename = getBasename(filename);
+
+        if (basename === 'index') {
+          context.report({
+            node,
+            message:
+              'The filename "index" is not allowed, please use another one',
+          });
+          return;
+        }
+      },
+    };
+  },
+};

tests/lib/rules/no-index.js

@@ -0,0 +1,50 @@
+/**
+ * @fileoverview A file cannot be named "index"
+ * @author Duke Luo
+ */
+'use strict';
+
+const rule = require('../../../lib/rules/no-index');
+const RuleTester = require('eslint').RuleTester;
+
+const ruleTester = new RuleTester();
+
+ruleTester.run('no-index', rule, {
+  valid: [
+    {
+      code: "var foo = 'bar';",
+      filename: 'src/components/login.jsx',
+    },
+    {
+      code: "var foo = 'bar';",
+      filename: 'src/utils/calculatePrice.js',
+    },
+  ],
+
+  invalid: [
+    {
+      code: "var foo = 'bar';",
+      filename: 'src/utils/index.js',
+      errors: [
+        {
+          message:
+            'The filename "index" is not allowed, please use another one',
+          column: 1,
+          line: 1,
+        },
+      ],
+    },
+    {
+      code: "var foo = 'bar';",
+      filename: 'src/utils/index.ts',
+      errors: [
+        {
+          message:
+            'The filename "index" is not allowed, please use another one',
+          column: 1,
+          line: 1,
+        },
+      ],
+    },
+  ],
+});