eslint-plugin-filename-consistency/lib/rules/match/constants.js

Eslint rule for consistent file and folder names

"use strict";

/**
 * @type {Record<import('./types').MatchOptionsCase, RegExp>}
 */
const cases = {
  camel: /^([a-z][a-z0-9]*)(([A-Z]|[.][a-z])[a-z0-9]*)*$/,
  pascal: /^([A-Z][a-z0-9]*)(([A-Z]|[.][A-Z])[a-z0-9]*)*$/,
  snake: /^([a-z][a-z0-9]*)([_.][a-z0-9]+)*$/,
  kebab: /^([a-z][a-z0-9]*)([-.][a-z0-9]+)*$/,
};

/**
 * @type {Array<import('./types').MatchOptionsCase>}
 */
// @ts-expect-error
const casesNames = Object.keys(cases);

const defaultCase = cases.camel;
const defaultIgnoreSegments = [
  /readme/i,
  /license/i,
  /contributing/i,
  /CODE_OF_CONDUCT/i,
  /^index/,
  /^Dockerfile/,
];

/**
 * @type {import("./types").ParsedOptions}
 */
const defaultOptions = {
  match: [defaultCase],
  ignore: [],
  ignoreSegments: [...defaultIgnoreSegments],
  validateFolders: true,
  validateExtensions: true,
};

module.exports = {
  cases,
  casesNames,
  defaultCase,
  defaultIgnoreSegments,
  defaultOptions,
};