import { EsLintBestPracticesRules as R, Severity } from '../../../enums';
import { Rule } from '../../../types';

export interface AccessorPairsOptions {
	/**
	 * Set to `true` will warn for setters without getters
	 * @default true
	 */
	readonly setWithoutGet?: boolean;

	/**
	 * Set to `true` will warn for getters without setters
	 * @default false
	 */
	readonly getWithoutSet?: boolean;

	/**
	 * Set to `true` additionally applies this rule to class getters/setters.
	 * Set to `false` if you want this rule to ignore class declarations and
	 * class expressions.
	 * @default true
	 */
	readonly enforceForClassMembers?: boolean;
}

const { AccessorPairs: $AccessorPairs } = R;

/**
 * This rule enforces a style where it requires to have a getter for every
 * property which has a setter defined.
 *
 * @see: https://eslint.org/docs/rules/accessor-pairs
 */
export const AccessorPairs: Rule<AccessorPairsOptions> = {
	[$AccessorPairs]: [Severity.off],
} as const;

export type AccessorPairs = typeof AccessorPairs;