|
| 1 | +import util from '../util.js'; |
| 2 | + |
| 3 | +const MESSAGE_ID = 'no-ava-in-dependencies'; |
| 4 | + |
| 5 | +function findMember(objectNode, key) { |
| 6 | + return objectNode.members.find(member => member.name.value === key); |
| 7 | +} |
| 8 | + |
| 9 | +function detectIndent(source, members) { |
| 10 | + if (members.length === 0) { |
| 11 | + return '\t'; |
| 12 | + } |
| 13 | + |
| 14 | + const firstMember = members[0]; |
| 15 | + const lineStart = source.lastIndexOf('\n', firstMember.loc.start.offset) + 1; |
| 16 | + return source.slice(lineStart, firstMember.loc.start.offset); |
| 17 | +} |
| 18 | + |
| 19 | +function removeMember(fixer, source, objectNode, memberIndex) { |
| 20 | + const {members} = objectNode; |
| 21 | + const member = members[memberIndex]; |
| 22 | + |
| 23 | + if (members.length === 1) { |
| 24 | + // Only member - empty the object but keep braces |
| 25 | + return fixer.replaceTextRange( |
| 26 | + [objectNode.loc.start.offset, objectNode.loc.end.offset], |
| 27 | + '{}', |
| 28 | + ); |
| 29 | + } |
| 30 | + |
| 31 | + if (memberIndex === members.length - 1) { |
| 32 | + // Last member - remove from end of previous member to end of this member |
| 33 | + const previousMember = members[memberIndex - 1]; |
| 34 | + return fixer.removeRange([previousMember.loc.end.offset, member.loc.end.offset]); |
| 35 | + } |
| 36 | + |
| 37 | + // First or middle member - remove from start of line to start of next member's line |
| 38 | + const nextMember = members[memberIndex + 1]; |
| 39 | + const removeStart = source.lastIndexOf('\n', member.loc.start.offset - 1); |
| 40 | + const removeEnd = source.lastIndexOf('\n', nextMember.loc.start.offset); |
| 41 | + return fixer.removeRange([ |
| 42 | + removeStart === -1 ? member.loc.start.offset : removeStart, |
| 43 | + removeEnd === -1 ? nextMember.loc.start.offset : removeEnd, |
| 44 | + ]); |
| 45 | +} |
| 46 | + |
| 47 | +const create = context => ({ |
| 48 | + Document(node) { |
| 49 | + const root = node.body; |
| 50 | + if (!root || root.type !== 'Object') { |
| 51 | + return; |
| 52 | + } |
| 53 | + |
| 54 | + const depsMember = findMember(root, 'dependencies'); |
| 55 | + if (!depsMember || depsMember.value.type !== 'Object') { |
| 56 | + return; |
| 57 | + } |
| 58 | + |
| 59 | + const avaMember = findMember(depsMember.value, 'ava'); |
| 60 | + if (!avaMember) { |
| 61 | + return; |
| 62 | + } |
| 63 | + |
| 64 | + const devDepsMember = findMember(root, 'devDependencies'); |
| 65 | + const alreadyInDevDeps = devDepsMember |
| 66 | + && devDepsMember.value.type === 'Object' |
| 67 | + && findMember(devDepsMember.value, 'ava'); |
| 68 | + |
| 69 | + context.report({ |
| 70 | + loc: avaMember.name.loc, |
| 71 | + messageId: MESSAGE_ID, |
| 72 | + fix(fixer) { |
| 73 | + const source = context.sourceCode.getText(); |
| 74 | + const fixes = []; |
| 75 | + const isOnlyDependency = depsMember.value.members.length === 1; |
| 76 | + |
| 77 | + if (isOnlyDependency && !alreadyInDevDeps && !devDepsMember) { |
| 78 | + // Replace "dependencies" key with "devDependencies" - simplest case |
| 79 | + fixes.push(fixer.replaceTextRange( |
| 80 | + [depsMember.name.loc.start.offset, depsMember.name.loc.end.offset], |
| 81 | + '"devDependencies"', |
| 82 | + )); |
| 83 | + return fixes; |
| 84 | + } |
| 85 | + |
| 86 | + if (isOnlyDependency) { |
| 87 | + // Remove entire dependencies member from root |
| 88 | + const depsIndex = root.members.indexOf(depsMember); |
| 89 | + fixes.push(removeMember(fixer, source, root, depsIndex)); |
| 90 | + } else { |
| 91 | + // Remove just the ava entry from dependencies |
| 92 | + const avaIndex = depsMember.value.members.indexOf(avaMember); |
| 93 | + fixes.push(removeMember(fixer, source, depsMember.value, avaIndex)); |
| 94 | + } |
| 95 | + |
| 96 | + if (!alreadyInDevDeps) { |
| 97 | + const avaEntry = `"ava": ${source.slice(avaMember.value.loc.start.offset, avaMember.value.loc.end.offset)}`; |
| 98 | + |
| 99 | + if (devDepsMember && devDepsMember.value.type === 'Object') { |
| 100 | + // Add to existing devDependencies |
| 101 | + const devMembers = devDepsMember.value.members; |
| 102 | + const innerIndent = devMembers.length > 0 |
| 103 | + ? detectIndent(source, devMembers) |
| 104 | + : detectIndent(source, depsMember.value.members); |
| 105 | + |
| 106 | + if (devMembers.length === 0) { |
| 107 | + // Empty devDependencies - insert between braces |
| 108 | + const closingIndent = detectIndent(source, root.members); |
| 109 | + fixes.push(fixer.replaceTextRange( |
| 110 | + [devDepsMember.value.loc.start.offset, devDepsMember.value.loc.end.offset], |
| 111 | + `{\n${innerIndent}${avaEntry}\n${closingIndent}}`, |
| 112 | + )); |
| 113 | + } else { |
| 114 | + // Append after last member |
| 115 | + const lastMember = devMembers.at(-1); |
| 116 | + fixes.push(fixer.insertTextAfterRange( |
| 117 | + [lastMember.loc.end.offset - 1, lastMember.loc.end.offset], |
| 118 | + `,\n${innerIndent}${avaEntry}`, |
| 119 | + )); |
| 120 | + } |
| 121 | + } else if (devDepsMember) { |
| 122 | + // Existing devDependencies is invalid (non-object), replace its value. |
| 123 | + const indent = detectIndent(source, root.members); |
| 124 | + const innerIndent = detectIndent(source, depsMember.value.members); |
| 125 | + fixes.push(fixer.replaceTextRange( |
| 126 | + [devDepsMember.value.loc.start.offset, devDepsMember.value.loc.end.offset], |
| 127 | + `{\n${innerIndent}${avaEntry}\n${indent}}`, |
| 128 | + )); |
| 129 | + } else { |
| 130 | + // Create devDependencies section after dependencies |
| 131 | + const indent = detectIndent(source, root.members); |
| 132 | + const innerIndent = detectIndent(source, depsMember.value.members); |
| 133 | + const devDepsBlock = `"devDependencies": {\n${innerIndent}${avaEntry}\n${indent}}`; |
| 134 | + |
| 135 | + fixes.push(fixer.insertTextAfterRange( |
| 136 | + [depsMember.loc.end.offset - 1, depsMember.loc.end.offset], |
| 137 | + `,\n${indent}${devDepsBlock}`, |
| 138 | + )); |
| 139 | + } |
| 140 | + } |
| 141 | + |
| 142 | + return fixes; |
| 143 | + }, |
| 144 | + }); |
| 145 | + }, |
| 146 | +}); |
| 147 | + |
| 148 | +export default { |
| 149 | + create, |
| 150 | + meta: { |
| 151 | + type: 'problem', |
| 152 | + docs: { |
| 153 | + description: 'Disallow AVA in `dependencies`.', |
| 154 | + recommended: true, |
| 155 | + url: util.getDocsUrl(import.meta.filename), |
| 156 | + }, |
| 157 | + fixable: 'code', |
| 158 | + schema: [], |
| 159 | + messages: { |
| 160 | + [MESSAGE_ID]: '`ava` should be in `devDependencies` instead of `dependencies`.', |
| 161 | + }, |
| 162 | + }, |
| 163 | +}; |
0 commit comments