feat(#26): rule no-index can ignore middle extensions

Author: dukeluo

docs/rules/no-index.md

@@ -19,3 +19,27 @@ Examples of **correct** filename for this rule:
 calculatePrice.js
 login.tsx
 ```
+
+### Options
+
+#### rule configuration object
+
+##### `ignoreMiddleExtensions`
+
+If `true`, the rule will ignore the middle extensions of the filename.
+
+In some cases, you may want to ignore the middle extensions of the filename. For example, you want to lint the base name of the config files, e.g. `index.config.js`, you can do so by setting the `ignoreMiddleExtensions` option to `true`, and the rule will only validate its base name, in this case the base name will be `index`.
+
+```js
+module.exports = {
+  plugins: ['check-file'],
+  rules: {
+    'check-file/no-index': [
+      'error',
+      {
+        ignoreMiddleExtensions: true,
+      },
+    ],
+  },
+};
+```

lib/rules/no-index.js

@@ -21,15 +21,23 @@ module.exports = {
       url: getDocUrl('no-index'),
     },
     fixable: null,
-    schema: [],
+    schema: [
+      {
+        type: 'object',
+        properties: {
+          ignoreMiddleExtensions: { type: 'boolean' },
+        },
+      },
+    ],
   },
 
   create(context) {
     return {
       Program: (node) => {
+        const { ignoreMiddleExtensions } = context.options[0] || {};
         const filenameWithPath = getFilePath(context);
         const filename = getFilename(filenameWithPath);
-        const basename = getBasename(filename);
+        const basename = getBasename(filename, ignoreMiddleExtensions);
 
         if (basename === 'index') {
           context.report({

tests/lib/rules/no-index.posix.js

@@ -23,6 +23,14 @@ ruleTester.run('no-index', rule, {
       code: "var foo = 'bar';",
       filename: 'src/utils/calculatePrice.js',
     },
+    {
+      code: "var foo = 'bar';",
+      filename: 'src/utils/index.config.js',
+    },
+    {
+      code: "var foo = 'bar';",
+      filename: 'index.config.ts',
+    },
   ],
 
   invalid: [
@@ -50,3 +58,73 @@ ruleTester.run('no-index', rule, {
     },
   ],
 });
+
+ruleTester.run(
+  'no-index with option: [{ ignoreMiddleExtensions: true }]',
+  rule,
+  {
+    valid: [
+      {
+        code: "var foo = 'bar';",
+        filename: 'src/components/login.jsx',
+        options: [{ ignoreMiddleExtensions: true }],
+      },
+      {
+        code: "var foo = 'bar';",
+        filename: 'calculatePrice.js',
+        options: [{ ignoreMiddleExtensions: true }],
+      },
+    ],
+
+    invalid: [
+      {
+        code: "var foo = 'bar';",
+        filename: 'src/utils/index.js',
+        options: [{ ignoreMiddleExtensions: true }],
+        errors: [
+          {
+            message: 'The filename "index" is not allowed',
+            column: 1,
+            line: 1,
+          },
+        ],
+      },
+      {
+        code: "var foo = 'bar';",
+        filename: 'index.ts',
+        options: [{ ignoreMiddleExtensions: true }],
+        errors: [
+          {
+            message: 'The filename "index" is not allowed',
+            column: 1,
+            line: 1,
+          },
+        ],
+      },
+      {
+        code: "var foo = 'bar';",
+        filename: 'src/utils/index.config.js',
+        options: [{ ignoreMiddleExtensions: true }],
+        errors: [
+          {
+            message: 'The filename "index" is not allowed',
+            column: 1,
+            line: 1,
+          },
+        ],
+      },
+      {
+        code: "var foo = 'bar';",
+        filename: 'index.config.ts',
+        options: [{ ignoreMiddleExtensions: true }],
+        errors: [
+          {
+            message: 'The filename "index" is not allowed',
+            column: 1,
+            line: 1,
+          },
+        ],
+      },
+    ],
+  }
+);

tests/lib/rules/no-index.windows.js

@@ -23,6 +23,14 @@ ruleTester.run('no-index on Windows', rule, {
       code: "var foo = 'bar';",
       filename: 'src\\main.ts',
     },
+    {
+      code: "var foo = 'bar';",
+      filename: 'src\\utils\\index.config.js',
+    },
+    {
+      code: "var foo = 'bar';",
+      filename: 'index.config.ts',
+    },
   ],
 
   invalid: [
@@ -50,3 +58,73 @@ ruleTester.run('no-index on Windows', rule, {
     },
   ],
 });
+
+ruleTester.run(
+  'no-index with option on Windows: [{ ignoreMiddleExtensions: true }]',
+  rule,
+  {
+    valid: [
+      {
+        code: "var foo = 'bar';",
+        filename: 'src\\components\\login.jsx',
+        options: [{ ignoreMiddleExtensions: true }],
+      },
+      {
+        code: "var foo = 'bar';",
+        filename: 'calculatePrice.js',
+        options: [{ ignoreMiddleExtensions: true }],
+      },
+    ],
+
+    invalid: [
+      {
+        code: "var foo = 'bar';",
+        filename: 'src\\utils\\index.js',
+        options: [{ ignoreMiddleExtensions: true }],
+        errors: [
+          {
+            message: 'The filename "index" is not allowed',
+            column: 1,
+            line: 1,
+          },
+        ],
+      },
+      {
+        code: "var foo = 'bar';",
+        filename: 'index.ts',
+        options: [{ ignoreMiddleExtensions: true }],
+        errors: [
+          {
+            message: 'The filename "index" is not allowed',
+            column: 1,
+            line: 1,
+          },
+        ],
+      },
+      {
+        code: "var foo = 'bar';",
+        filename: 'src\\utils\\index.config.js',
+        options: [{ ignoreMiddleExtensions: true }],
+        errors: [
+          {
+            message: 'The filename "index" is not allowed',
+            column: 1,
+            line: 1,
+          },
+        ],
+      },
+      {
+        code: "var foo = 'bar';",
+        filename: 'index.config.ts',
+        options: [{ ignoreMiddleExtensions: true }],
+        errors: [
+          {
+            message: 'The filename "index" is not allowed',
+            column: 1,
+            line: 1,
+          },
+        ],
+      },
+    ],
+  }
+);