1. module eslint-plugin-filenames
   1. object eslint-plugin-filenames.rules
2. module eslint-plugin-filenames.rules
   1. function eslint-plugin-filenames.rules.match-exported (context)
   2. function eslint-plugin-filenames.rules.match-regex (context)
   3. function eslint-plugin-filenames.rules.no-index (context)

module eslint-plugin-filenames

module eslint-plugin-filenames.rules

function eslint-plugin-filenames.rules.match-exported (context)

• description and source-code

  match-exported = function (context) {
      return {
          "Program": function (node) {
              var transforms = getTransformsFromOptions(context.options[0]),
                  replacePattern = context.options[1] ? new RegExp(context.options[1]) : null,
                  filename = context.getFilename(),
                  absoluteFilename = path.resolve(filename),
                  parsed = parseFilename(absoluteFilename),
                  shouldIgnore = isIgnoredFilename(filename),
                  exportedName = getExportedName(node),
                  isExporting = Boolean(exportedName),
                  expectedExport = getStringToCheckAgainstExport(parsed, replacePattern),
                  transformedNames = transform(exportedName, transforms),
                  everythingIsIndex = exportedName === 'index' && parsed.name === 'index',
                  matchesExported = anyMatch(expectedExport, transformedNames) || everythingIsIndex,
                  reportIf = function (condition, messageForNormalFile, messageForIndexFile) {
                      var message = (!messageForIndexFile || !isIndexFile(parsed)) ? messageForNormalFile : messageForIndexFile;
  
                      if (condition) {
                          context.report(node, message, {
                              name: parsed.base,
                              expectedExport: expectedExport,
                              exportName: transformedNames.join("', '"),
                              extension: parsed.ext,
                              whatToMatch: getWhatToMatchMessage(transforms)
                          });
                      }
                  };
  
              if (shouldIgnore) return;
  
              reportIf(
                  isExporting && !matchesExported,
                  "Filename '{{expectedExport}}' must match {{whatToMatch}} '{{exportName}}'.",
                  "The directory '{{expectedExport}}' must be named '{{exportName}}', after the exported value of its index file."
              );
          }
      }
  }

• example usage

  n/a

function eslint-plugin-filenames.rules.match-regex (context)

• description and source-code

  match-regex = function (context) {
      var defaultRegexp = /^([a-z0-9]+)([A-Z][a-z0-9]+)*$/g,
          conventionRegexp = context.options[0] ? new RegExp(context.options[0]) : defaultRegexp,
          ignoreExporting = context.options[1] ? context.options[1] : false;
  
      return {
          "Program": function(node) {
              var filename = context.getFilename(),
                  absoluteFilename = path.resolve(filename),
                  parsed = parseFilename(absoluteFilename),
                  shouldIgnore = isIgnoredFilename(filename),
                  isExporting = Boolean(getExportedName(node)),
                  matchesRegex = conventionRegexp.test(parsed.name);
  
              if (shouldIgnore) return;
              if (ignoreExporting && isExporting) return;
              if (!matchesRegex) {
                  context.report(node, "Filename 'function eslint-plugin-filenames.rules.match-regex' does not match the naming convention.", {
                      name: parsed.base
                  });
              }
          }
      };
  }

• example usage

  n/a

function eslint-plugin-filenames.rules.no-index (context)

• description and source-code

  no-index = function (context) {
      return {
          "Program": function(node) {
              var filename = context.getFilename(),
                  absoluteFilename = path.resolve(filename),
                  parsed = parseFilename(absoluteFilename),
                  shouldIgnore = isIgnoredFilename(filename),
                  isIndex = isIndexFile(parsed);
  
  
              if (shouldIgnore) return;
              if (isIndex) {
                  context.report(node, "'index.js' files are not allowed.");
              }
          }
      };
  
  }

• example usage

  n/a