/* cSpell:disable */
import { type Linter } from 'eslint';

/**
 * @description Bans enums.
 * @link https://github.com/danielnixon/eslint-plugin-total-functions
 *
 *  ```md
 *  | key        | value   |
 *  | :--------- | :------ |
 *  | type       | problem |
 *  | deprecated | false   |
 *  ```
 */
namespace NoEnums {
  export type RuleEntry = Linter.StringSeverity;
}

/**
 * @description Bans hidden type assertions.
 * @link https://github.com/danielnixon/eslint-plugin-total-functions
 *
 *  ```md
 *  | key        | value   |
 *  | :--------- | :------ |
 *  | type       | problem |
 *  | deprecated | false   |
 *  ```
 */
namespace NoHiddenTypeAssertions {
  export type RuleEntry = Linter.StringSeverity;
}

/**
 * @description Bans problematic nested fp-ts effects.
 * @link https://github.com/danielnixon/eslint-plugin-total-functions
 *
 *  ```md
 *  | key        | value   |
 *  | :--------- | :------ |
 *  | type       | problem |
 *  | deprecated | false   |
 *  ```
 */
namespace NoNestedFpTsEffects {
  export type RuleEntry = Linter.StringSeverity;
}

/**
 * @description Bans partial Array.prototype.reduce()
 * @link https://github.com/danielnixon/eslint-plugin-total-functions
 *
 *  ```md
 *  | key        | value   |
 *  | :--------- | :------ |
 *  | type       | problem |
 *  | deprecated | false   |
 *  ```
 */
namespace NoPartialArrayReduce {
  export type RuleEntry = Linter.StringSeverity;
}

/**
 * @description Bans partial division.
 * @link https://github.com/danielnixon/eslint-plugin-total-functions
 *
 *  ```md
 *  | key        | value   |
 *  | :--------- | :------ |
 *  | type       | problem |
 *  | deprecated | false   |
 *  ```
 */
namespace NoPartialDivision {
  export type RuleEntry = Linter.StringSeverity;
}

/**
 * @description Bans partial String.prototype.normalize()
 * @link https://github.com/danielnixon/eslint-plugin-total-functions
 *
 *  ```md
 *  | key        | value   |
 *  | :--------- | :------ |
 *  | type       | problem |
 *  | deprecated | false   |
 *  ```
 */
namespace NoPartialStringNormalize {
  export type RuleEntry = Linter.StringSeverity;
}

/**
 * @description Bans the partial URL construction.
 * @link https://github.com/danielnixon/eslint-plugin-total-functions
 *
 *  ```md
 *  | key        | value   |
 *  | :--------- | :------ |
 *  | type       | problem |
 *  | deprecated | false   |
 *  ```
 */
namespace NoPartialUrlConstructor {
  export type RuleEntry = Linter.StringSeverity;
}

/**
 * @description Bans interpretation (execution) of fp-ts effects.
 * @link https://github.com/danielnixon/eslint-plugin-total-functions
 *
 *  ```md
 *  | key        | value   |
 *  | :--------- | :------ |
 *  | type       | problem |
 *  | deprecated | false   |
 *  ```
 */
namespace NoPrematureFpTsEffects {
  export type RuleEntry = Linter.StringSeverity;
}

/**
 * @description Bans unsafe enum assignment.
 * @link https://github.com/danielnixon/eslint-plugin-total-functions
 *
 *  ```md
 *  | key        | value   |
 *  | :--------- | :------ |
 *  | type       | problem |
 *  | deprecated | true    |
 *  ```
 */
namespace NoUnsafeEnumAssignment {
  export type RuleEntry = 0;
}

/**
 * @description Bans unsafe assignment from mutable to readonly types.
 * @link https://github.com/danielnixon/eslint-plugin-total-functions
 *
 *  ```md
 *  | key        | value   |
 *  | :--------- | :------ |
 *  | type       | problem |
 *  | deprecated | false   |
 *  ```
 */
namespace NoUnsafeMutableReadonlyAssignment {
  export type RuleEntry = Linter.StringSeverity;
}

/**
 * @description Bans unsafe assignment to optional properties.
 * @link https://github.com/danielnixon/eslint-plugin-total-functions
 *
 *  ```md
 *  | key        | value   |
 *  | :--------- | :------ |
 *  | type       | problem |
 *  | deprecated | true    |
 *  ```
 */
namespace NoUnsafeOptionalPropertyAssignment {
  export type RuleEntry = 0;
}

/**
 * @description Bans unsafe assignment from readonly to mutable types.
 * @link https://github.com/danielnixon/eslint-plugin-total-functions
 *
 *  ```md
 *  | key        | value   |
 *  | :--------- | :------ |
 *  | type       | problem |
 *  | deprecated | false   |
 *  ```
 */
namespace NoUnsafeReadonlyMutableAssignment {
  export type RuleEntry = Linter.StringSeverity;
}

/**
 * @description Bans unsafe type assertions.
 * @link https://github.com/danielnixon/eslint-plugin-total-functions
 *
 *  ```md
 *  | key        | value   |
 *  | :--------- | :------ |
 *  | type       | problem |
 *  | deprecated | false   |
 *  ```
 */
namespace NoUnsafeTypeAssertion {
  export type RuleEntry = Linter.StringSeverity;
}

/**
 * @description Enforces the use of TypeScript's strict mode.
 * @link https://github.com/danielnixon/eslint-plugin-total-functions
 *
 *  ```md
 *  | key        | value   |
 *  | :--------- | :------ |
 *  | type       | problem |
 *  | deprecated | false   |
 *  ```
 */
namespace RequireStrictMode {
  export type RuleEntry = Linter.StringSeverity;
}

export type EslintTotalFunctionsRules = Readonly<{
  'total-functions/no-enums': NoEnums.RuleEntry;
  'total-functions/no-hidden-type-assertions': NoHiddenTypeAssertions.RuleEntry;
  'total-functions/no-nested-fp-ts-effects': NoNestedFpTsEffects.RuleEntry;
  'total-functions/no-partial-array-reduce': NoPartialArrayReduce.RuleEntry;
  'total-functions/no-partial-division': NoPartialDivision.RuleEntry;
  'total-functions/no-partial-string-normalize': NoPartialStringNormalize.RuleEntry;
  'total-functions/no-partial-url-constructor': NoPartialUrlConstructor.RuleEntry;
  'total-functions/no-premature-fp-ts-effects': NoPrematureFpTsEffects.RuleEntry;
  'total-functions/no-unsafe-mutable-readonly-assignment': NoUnsafeMutableReadonlyAssignment.RuleEntry;
  'total-functions/no-unsafe-readonly-mutable-assignment': NoUnsafeReadonlyMutableAssignment.RuleEntry;
  'total-functions/no-unsafe-type-assertion': NoUnsafeTypeAssertion.RuleEntry;
  'total-functions/require-strict-mode': RequireStrictMode.RuleEntry;

  // deprecated
  'total-functions/no-unsafe-enum-assignment': NoUnsafeEnumAssignment.RuleEntry;
  'total-functions/no-unsafe-optional-property-assignment': NoUnsafeOptionalPropertyAssignment.RuleEntry;
}>;