@kavsingh/eslint-plugin-filenames

Forked from eslint-plugin-filenames.

Adds eslint rules to ensure consistent filenames for your javascript files.

Please note: This plugin will only lint the names of files you are linting with eslint. It will ignore other files that are not linted with eslint.

Enabling the plugin

This plugin requires a version of eslint>=9.0.0 to be installed as a peer dependency.

For eslint<9.0.0 please use the original eslint-plugin-filenames.

Modify your eslint.config.js file to load the plugin and enable the rules you want to use.

import filenames from "@kavsingh/eslint-plugin-filenames";

{
  plugins: { filenames },
  rules: {
    "filenames/match-regex": "error",
    "filenames/match-exported": "error",
    "filenames/no-index": "error"
  }
}

Rules

match-regex

A rule to enforce a certain file naming convention using a regular expression.

The convention can be configured using a regular expression (the default is camelCase). Additionally, files with a named default export can be ignored with an options parameter.

"filenames/match-regex": [
  "error",
  "^[a-z_]+$",
  { ignoreDefaultExport: true }
]

With these configuration options, camelCase.js will be reported as an error while snake_case.js will pass.

Additionally the files that have a named default export (according to the logic in the match-exported rule) will be ignored. They can be linted with the match-exported rule. Please note that exported function calls are not respected in this case.

match-exported

Match the file name against the default exported value in the module. Files that dont have a default export will be ignored. The exports of index.js are matched against their parent directory.

// Considered a problem only if the file isn't named foo.js or foo/index.js
export default function foo() {}

// Considered a problem only if the file isn't named Foo.js or Foo/index.js
module.exports = class Foo() {}

// Considered a problem only if the file isn't named someVariable.js or someVariable/index.js
module.exports = someVariable;

// Never considered a problem
export default { foo: "bar" };

If your filename policy doesn't quite match with your variable naming policy, you can add one or multiple transforms:

"filenames/match-exported": ["error", { transforms: ["kebab"] }]

Now, in your code:

// Considered problem only if file isn't named variable-name.js or variable-name/index.js
export default function variableName;

Available transforms: 'snake', 'kebab', 'camel', and 'pascal' (camel-cased with first letter in upper case).

For multiple transforms simply specify an array like this:

"filenames/match-exported": ["error", { transforms: ["kebab", "snake"] }]

If you prefer to use suffixes for your files (e.g. Foo.react.js for a React component file), you can use the remove option to remove parts of a filename matching a regex pattern before transforming and matching against the export.

"filenames/match-exported": ["error", { remove: "\\.react$" }]

Now, in your code:

// Considered problem only if file isn't named variableName.react.js, variableName.js or variableName/index.js
export default function variableName;

If you also want to match exported function calls you can use the matchExportedFunctionCall option.

"filenames/match-exported": ["error", { matchExportedFunctionCall: true }]

Now, in your code:

// Considered problem only if file isn't named functionName.js or functionName/index.js
export default functionName();

no-index

Having a bunch of index.js files can have negative influence on developer experience, e.g. when opening files by name. When enabling this rule. index.js files will always be considered a problem.

Configs

The plugin exports the follwowing configurations for quick setup of file naming conventions.

camel

Requires camelCase / PascalCase filenames with matching default exports.

import filenames from "@kavsingh/eslint-plugin-filenames";

{
  extends: [filenames.configs.camel],
}

Sets the following rules:

{
  "filenames/match-regex": [
    "error",
    "^[a-z0-9.]+$",
    { ignoreExported: true },
  ],
  "filenames/match-exported": [
    "error",
    { transforms: ["camel", "pascal"] },
  ],
}

kebab

Requires kebab-case filenames with matching default exports.

import filenames from "@kavsingh/eslint-plugin-filenames";

{
  extends: [filenames.configs.kebab],
}

Sets the following rules:

{
  "filenames/match-regex": [
    "error",
    "^[a-z0-9-.]+$",
    { ignoreExported: true },
  ],
  "filenames/match-exported": ["error", { transforms: ["kebab"] }],
}

snake

Requires snake_case filenames with matching default exports.

import filenames from "@kavsingh/eslint-plugin-filenames";

{
  extends: [filenames.configs.snake],
}

Sets the following rules:

{
  "filenames/match-regex": [
    "error",
    "^[a-z0-9_.]+$",
    { ignoreExported: true },
  ],
  "filenames/match-exported": ["error", { transforms: ["snake"] }],
}

Changelog

2.0.0-rc.0

• Provide configs for camel, kebab, and snake case
• Support eslint 9 FlatConfig only, drop support for node < 18

1.3.2

• Fix issue with match-regex and getExportedName

1.3.1

• Put breaking change from 1.3.0 behind a flag

1.3.0

• Support call expressions as named exports

1.2.0

• Introduce strip option for match-exported
• Introduce support for multiple transform options
• Introduce pascal transform

1.1.0

• Introduce transform option for match-exported

1.0.0

• Split rule into match-regex, match-exported and no-index

0.2.0

• Add match-exported flags

0.1.2

• Fix example in README

0.1.1

• Fix: Text via stdin always passes
• Tests: Travis builds also run on node 0.12 and iojs now

0.1.0

• Initial Release