|
| 1 | +/** |
| 2 | + * Copy from https://github.com/eslint/eslint/blob/master/lib/linter/source-code-fixer.js |
| 3 | + * @see https://github.com/eslint/eslint/issues/14936 |
| 4 | + */ |
| 5 | +/** |
| 6 | + * @fileoverview An object that caches and applies source code fixes. |
| 7 | + * @author Nicholas C. Zakas |
| 8 | + */ |
| 9 | + |
| 10 | +import type { Linter } from 'eslint' |
| 11 | + |
| 12 | +// ------------------------------------------------------------------------------ |
| 13 | +// Requirements |
| 14 | +// ------------------------------------------------------------------------------ |
| 15 | + |
| 16 | +// const debug = require("debug")("eslint:source-code-fixer"); |
| 17 | +type Message = { |
| 18 | + fix?: Linter.LintMessage['fix'] |
| 19 | +} |
| 20 | + |
| 21 | +type HasFixMessage = Message & { |
| 22 | + fix: NonNullable<Message['fix']> |
| 23 | +} |
| 24 | + |
| 25 | +function hasFixMessage(m: Message): m is HasFixMessage { |
| 26 | + return !!m.fix |
| 27 | +} |
| 28 | +// ------------------------------------------------------------------------------ |
| 29 | +// Helpers |
| 30 | +// ------------------------------------------------------------------------------ |
| 31 | + |
| 32 | +const BOM = '\uFEFF' |
| 33 | + |
| 34 | +/** |
| 35 | + * Compares items in a messages array by range. |
| 36 | + * @param {Message} a The first message. |
| 37 | + * @param {Message} b The second message. |
| 38 | + * @returns {int} -1 if a comes before b, 1 if a comes after b, 0 if equal. |
| 39 | + * @private |
| 40 | + */ |
| 41 | +function compareMessagesByFixRange(a: HasFixMessage, b: HasFixMessage) { |
| 42 | + return a.fix.range[0] - b.fix.range[0] || a.fix.range[1] - b.fix.range[1] |
| 43 | +} |
| 44 | + |
| 45 | +/** |
| 46 | + * Compares items in a messages array by line and column. |
| 47 | + * @param {Message} a The first message. |
| 48 | + * @param {Message} b The second message. |
| 49 | + * @returns {int} -1 if a comes before b, 1 if a comes after b, 0 if equal. |
| 50 | + * @private |
| 51 | + */ |
| 52 | +// eslint-disable-next-line @typescript-eslint/no-explicit-any -- ignore |
| 53 | +function compareMessagesByLocation(a: any, b: any) { |
| 54 | + return a.line - b.line || a.column - b.column |
| 55 | +} |
| 56 | + |
| 57 | +// ------------------------------------------------------------------------------ |
| 58 | +// Public Interface |
| 59 | +// ------------------------------------------------------------------------------ |
| 60 | + |
| 61 | +/** |
| 62 | + * Utility for apply fixes to source code. |
| 63 | + * @constructor |
| 64 | + */ |
| 65 | +export class SourceCodeFixer { |
| 66 | + /** |
| 67 | + * Applies the fixes specified by the messages to the given text. Tries to be |
| 68 | + * smart about the fixes and won't apply fixes over the same area in the text. |
| 69 | + * @param {string} sourceText The text to apply the changes to. |
| 70 | + * @param {Message[]} messages The array of messages reported by ESLint. |
| 71 | + * @param {boolean|Function} [shouldFix=true] Determines whether each message should be fixed |
| 72 | + * @returns {Object} An object containing the fixed text and any unfixed messages. |
| 73 | + */ |
| 74 | + static applyFixes<M extends Message>( |
| 75 | + sourceText: string, |
| 76 | + messages: M[], |
| 77 | + shouldFix: boolean | ((m: M) => boolean) = true |
| 78 | + ): { |
| 79 | + fixed: boolean |
| 80 | + messages: M[] |
| 81 | + output: string |
| 82 | + } { |
| 83 | + // debug("Applying fixes"); |
| 84 | + |
| 85 | + if (shouldFix === false) { |
| 86 | + // debug("shouldFix parameter was false, not attempting fixes"); |
| 87 | + return { |
| 88 | + fixed: false, |
| 89 | + messages, |
| 90 | + output: sourceText |
| 91 | + } |
| 92 | + } |
| 93 | + |
| 94 | + // clone the array |
| 95 | + const remainingMessages = [] |
| 96 | + const fixes: (HasFixMessage & M)[] = [] |
| 97 | + const bom = sourceText.startsWith(BOM) ? BOM : '' |
| 98 | + const text = bom ? sourceText.slice(1) : sourceText |
| 99 | + let lastPos = Number.NEGATIVE_INFINITY |
| 100 | + let output = bom |
| 101 | + |
| 102 | + /** |
| 103 | + * Try to use the 'fix' from a problem. |
| 104 | + * @param {Message} problem The message object to apply fixes from |
| 105 | + * @returns {boolean} Whether fix was successfully applied |
| 106 | + */ |
| 107 | + function attemptFix(problem: HasFixMessage) { |
| 108 | + const fix = problem.fix |
| 109 | + const start = fix.range[0] |
| 110 | + const end = fix.range[1] |
| 111 | + |
| 112 | + // Remain it as a problem if it's overlapped or it's a negative range |
| 113 | + if (lastPos >= start || start > end) { |
| 114 | + remainingMessages.push(problem) |
| 115 | + return false |
| 116 | + } |
| 117 | + |
| 118 | + // Remove BOM. |
| 119 | + if ( |
| 120 | + (start < 0 && end >= 0) || |
| 121 | + (start === 0 && fix.text.startsWith(BOM)) |
| 122 | + ) { |
| 123 | + output = '' |
| 124 | + } |
| 125 | + |
| 126 | + // Make output to this fix. |
| 127 | + output += text.slice(Math.max(0, lastPos), Math.max(0, start)) |
| 128 | + output += fix.text |
| 129 | + lastPos = end |
| 130 | + return true |
| 131 | + } |
| 132 | + |
| 133 | + messages.forEach(problem => { |
| 134 | + if (hasFixMessage(problem)) { |
| 135 | + fixes.push(problem) |
| 136 | + } else { |
| 137 | + remainingMessages.push(problem) |
| 138 | + } |
| 139 | + }) |
| 140 | + |
| 141 | + if (fixes.length) { |
| 142 | + // debug("Found fixes to apply"); |
| 143 | + let fixesWereApplied = false |
| 144 | + |
| 145 | + for (const problem of fixes.sort(compareMessagesByFixRange)) { |
| 146 | + if (typeof shouldFix !== 'function' || shouldFix(problem)) { |
| 147 | + attemptFix(problem) |
| 148 | + |
| 149 | + /* |
| 150 | + * The only time attemptFix will fail is if a previous fix was |
| 151 | + * applied which conflicts with it. So we can mark this as true. |
| 152 | + */ |
| 153 | + fixesWereApplied = true |
| 154 | + } else { |
| 155 | + remainingMessages.push(problem) |
| 156 | + } |
| 157 | + } |
| 158 | + output += text.slice(Math.max(0, lastPos)) |
| 159 | + |
| 160 | + return { |
| 161 | + fixed: fixesWereApplied, |
| 162 | + messages: remainingMessages.sort(compareMessagesByLocation), |
| 163 | + output |
| 164 | + } |
| 165 | + } |
| 166 | + |
| 167 | + // debug("No fixes to apply"); |
| 168 | + return { |
| 169 | + fixed: false, |
| 170 | + messages, |
| 171 | + output: bom + text |
| 172 | + } |
| 173 | + } |
| 174 | +} |
0 commit comments