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

Eslint rule for consistent file and folder names

const { casesNames } = require("./constants");

const casesMatchOption = {
  type: "string",
  enum: [...casesNames],
};

const regexMatchOption = {
  type: "string",
  format: "regex",
  description: "Regex value",
};

/**
 * @type {import('json-schema').JSONSchema4}
 */
const schema = [
  {
    oneOf: [
      casesMatchOption,
      {
        type: "array",
        minItems: 1,
        uniqueItems: true,
        items: casesMatchOption,
      },
      {
        type: "object",
        properties: {
          match: {
            type: "array",
            minItems: 1,
            uniqueItems: true,
            items: casesMatchOption,
          },
          ignore: {
            type: "array",
            uniqueItems: true,
            items: regexMatchOption,
          },
          ignoreSegments: {
            type: "array",
            uniqueItems: true,
            items: regexMatchOption,
          },
          defaultIgnore: {
            type: "boolean",
          },
          validateFolders: {
            type: "boolean",
          },
          validateExtensions: {
            type: "boolean",
          },
        },
        additionalProperties: false,
      },
    ],
  },
];

/**
 * @type {import('eslint').Rule.RuleModule['meta']}
 */
const meta = {
  type: "suggestion",
  docs: {
    description: "Eslint rule for consistent file and folder names",
  },
  schema,
};

module.exports = {
  meta,
};