Skip to content

⬅️ Back to Table of Contents

📄 getFixOrSuggest.ts

📊 Analysis Summary

Metric Count
🔧 Functions 1
📦 Imports 1

📚 Table of Contents

🛠️ File Location:

📂 packages/eslint-plugin/src/util/getFixOrSuggest.ts

📦 Imports

Name Source
TSESLint @typescript-eslint/utils

Functions

`getFixOrSuggest({

fixOrSuggest, suggestion, }: { fixOrSuggest: 'fix' | 'none' | 'suggest'; suggestion: TSESLint.SuggestionReportDescriptor; }): | { fix: TSESLint.ReportFixFunction } | { suggest: TSESLint.SuggestionReportDescriptor[] } | undefined`

Code
export function getFixOrSuggest<MessageId extends string>({
  fixOrSuggest,
  suggestion,
}: {
  fixOrSuggest: 'fix' | 'none' | 'suggest';
  suggestion: TSESLint.SuggestionReportDescriptor<MessageId>;
}):
  | { fix: TSESLint.ReportFixFunction }
  | { suggest: TSESLint.SuggestionReportDescriptor<MessageId>[] }
  | undefined {
  switch (fixOrSuggest) {
    case 'fix':
      return { fix: suggestion.fix };
    case 'none':
      return undefined;
    case 'suggest':
      return { suggest: [suggestion] };
  }
}
  • Parameters:
  • { fixOrSuggest, suggestion, }: { fixOrSuggest: 'fix' | 'none' | 'suggest'; suggestion: TSESLint.SuggestionReportDescriptor<MessageId>; }
  • Return Type: | { fix: TSESLint.ReportFixFunction } | { suggest: TSESLint.SuggestionReportDescriptor<MessageId>[] } | undefined