ESLint Plugin: File Export Name

This ESLint plugin ensures that the default export name matches the file name according to specified case styles and patterns.

Installation

1npm install eslint-plugin-file-export-name --save-dev
2
3yarn add -D eslint-plugin-file-export-name
4
5pnpm add -D eslint-plugin-file-export-name

Usage

Add the plugin to your .eslintrc configuration file:

1{
2  "plugins": ["file-export-name"],
3  "rules": {
4    "file-export-name/match-file-export-name": "error"
5  }
6}

Rule: match-file-export-name

This rule verifies that the default export name matches the file name according to the specified configuration.

Options

The rule accepts an object or an array of objects with the following properties:

• cases: An array of allowed case styles ("pascal", "camel", "kebab", "snake").
• pattern: A string representing a regular expression to match the export name.
• ignore: An array of file patterns to ignore.
• extensions: An array of file extensions to apply the rule to.

Default Configuration

1{
2  "cases": ["pascal", "camel"],
3  "extensions": [".jsx", ".tsx", ".js", ".ts"],
4  "ignore": ["<text>", "<input>"],
5  "pattern": null
6}

Examples

Basic configuration

1{
2  "rules": {
3    "file-export-name/match-file-export-name": ["error", {
4      "cases": ["pascal", "camel"],
5      "pattern": "^My.*$",
6      "ignore": ["utils/*.js"],
7      "extensions": [".jsx", ".tsx"]
8    }]
9  }
10}
11
12// or you can use just in one line
13{
14  "rules": {
15    "file-export-name/match-file-export-name": "error"
16  }
17}

Multiple configurations

1{
2  "rules": {
3    "file-export-name/match-file-export-name": ["error", [
4      {
5        "cases": ["pascal"],
6        "extensions": [".jsx", ".tsx"]
7      },
8      {
9        "cases": ["camel"],
10        "extensions": [".js", ".ts"]
11      }
12    ]]
13  }
14}

Features

• Supports multiple case styles: PascalCase, camelCase, kebab-case, and snake_case
• Custom regex pattern matching for export names
• Ability to ignore specific files or patterns
• Configure different rules for different file extensions
• Automatically ignores index files