eslint-plugin-perfectionist/dist/utils/validate-custom-sort-configuration.js

ESLint plugin for sorting various data such as objects, imports, types, enums, JSX props, etc.

import { isGroupWithOverridesOption } from './is-group-with-overrides-option.js'
/**
 * Validates configuration when using custom sort type.
 *
 * Ensures that when a user selects 'custom' sorting type, they provide a valid
 * alphabet string. This prevents runtime errors and ensures the custom sorting
 * has a defined order to follow.
 *
 * The function is called at the beginning of every sorting rule's execution to
 * catch configuration errors early and provide clear error messages.
 *
 * @param options - Configuration options to validate.
 * @throws {Error} If type is 'custom' but alphabet is empty.
 */
function validateCustomSortConfiguration(options) {
  if (!usesCustomSort(options)) {
    return
  }
  if (options.alphabet.length === 0) {
    throw new Error('`alphabet` option must not be empty')
  }
}
function usesCustomSortInGroups(groups) {
  if (!groups) {
    return false
  }
  return groups
    .filter(isGroupWithOverridesOption)
    .some(groupWithSettings => groupWithSettings.type === 'custom')
}
function usesCustomSort(options) {
  if (options.type === 'custom') {
    return true
  }
  return usesCustomSortInGroups(options.groups)
}
export { validateCustomSortConfiguration }