Skip to content

⬅️ Back to Table of Contents

📄 severity

📊 Analysis Summary

Metric Count
🔧 Functions 2
📦 Imports 1

📚 Table of Contents

🛠️ File Location:

📂 packages/rule-tester/src/utils/severity.ts

📦 Imports

Name Source
SharedConfig @typescript-eslint/utils/ts-eslint

Functions

normalizeSeverityToString(severity: SharedConfig.RuleLevel): SharedConfig.SeverityString

Convert severity value of different types to a string.

Parameters:

  • severity any: severity value

Throws:

  • undefined: error if severity is invalid
Raw JSDoc
/**
 * Convert severity value of different types to a string.
 * @param  severity severity value
 * @throws error if severity is invalid
 */

Calls:

  • [2, '2', 'error'].includes
  • [1, '1', 'warn'].includes
  • [0, '0', 'off'].includes
Code
export function normalizeSeverityToString(
  severity: SharedConfig.RuleLevel,
): SharedConfig.SeverityString {
  if ([2, '2', 'error'].includes(severity)) {
    return 'error';
  }
  if ([1, '1', 'warn'].includes(severity)) {
    return 'warn';
  }
  if ([0, '0', 'off'].includes(severity)) {
    return 'off';
  }
  throw new Error(`Invalid severity value: ${severity}`);
}

normalizeSeverityToNumber(severity: SharedConfig.RuleLevel): SharedConfig.Severity

Convert severity value of different types to a number.

Parameters:

  • severity any: severity value

Throws:

  • undefined: error if severity is invalid
Raw JSDoc
/**
 * Convert severity value of different types to a number.
 * @param  severity severity value
 * @throws error if severity is invalid
 */

Calls:

  • [2, '2', 'error'].includes
  • [1, '1', 'warn'].includes
  • [0, '0', 'off'].includes
Code
export function normalizeSeverityToNumber(
  severity: SharedConfig.RuleLevel,
): SharedConfig.Severity {
  if ([2, '2', 'error'].includes(severity)) {
    return 2;
  }
  if ([1, '1', 'warn'].includes(severity)) {
    return 1;
  }
  if ([0, '0', 'off'].includes(severity)) {
    return 0;
  }
  throw new Error(`Invalid severity value: ${severity}`);
}

Generated by Syntax Scribe