-
-
Notifications
You must be signed in to change notification settings - Fork 694
Add autofix to vue/prefer-use-template-ref
#2632
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
+341
−5
Open
Changes from 9 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
ac5aa92
feat(prefer-use-template-ref): add support for fix option
Thomasan1999 fe49694
Merge branch 'vuejs:master' into master
Thomasan1999 d7331ac
make it compatible with Node.js v14
Thomasan1999 00c9c0e
make it compatible with ESLint <v8
Thomasan1999 7db1382
remove util for retrieving the last element of array
Thomasan1999 c8bb2e0
Merge remote-tracking branch 'upstream/master'
Thomasan1999 f6aefde
incorporating PR feedback
Thomasan1999 e1ea60f
incorporating PR feedback #2
Thomasan1999 ff2ba97
Add changeset
FloEdelmann d201c21
Merge branch 'vuejs:master' into master
Thomasan1999 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
5 changes: 5 additions & 0 deletions
.changeset/cool-cycles-lick.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| "eslint-plugin-vue": minor | ||
| --- | ||
|
|
||
| Added autofix to [vue/prefer-use-template-ref](https://eslint.vuejs.org/rules/prefer-use-template-ref.html). |
FloEdelmann marked this conversation as resolved.
Show resolved
Hide resolved
FloEdelmann marked this conversation as resolved.
Show resolved
Hide resolved
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,7 +8,7 @@ const utils = require('../utils') | |
|
|
||
| /** | ||
| * @typedef ScriptRef | ||
| * @type {{node: Expression, ref: string}} | ||
| * @type {{node: Expression, ref: string, typeArguments?: string[]}} | ||
| */ | ||
|
|
||
| /** | ||
|
|
@@ -20,7 +20,15 @@ function convertDeclaratorToScriptRef(declarator) { | |
| // @ts-ignore | ||
| node: declarator.init, | ||
| // @ts-ignore | ||
| ref: declarator.id.name | ||
| ref: declarator.id.name, | ||
| // @ts-ignore | ||
| ...(declarator.init?.typeArguments && { | ||
| // @ts-ignore | ||
| typeArguments: declarator.init.typeArguments.params.map( | ||
| // @ts-ignore | ||
| (param) => param.typeName.name | ||
| ) | ||
| }) | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -44,6 +52,58 @@ function getScriptRefsFromSetupFunction(body) { | |
| return refDeclarators.map(convertDeclaratorToScriptRef) | ||
| } | ||
|
|
||
| /** @param node {Statement | ModuleDeclaration} */ | ||
| function createIndent(node) { | ||
| const indentSize = node.loc.start.column | ||
|
|
||
| return ' '.repeat(indentSize) | ||
| } | ||
|
|
||
| /** | ||
| * @param context {RuleContext} | ||
| * @param fixer {RuleFixer} | ||
| * */ | ||
| function addUseTemplateRefImport(context, fixer) { | ||
| const sourceCode = context.getSourceCode() | ||
|
|
||
| if (!sourceCode) { | ||
| return | ||
| } | ||
|
|
||
| const body = sourceCode.ast.body | ||
| const imports = body.filter((node) => node.type === 'ImportDeclaration') | ||
|
|
||
| const vueDestructuredImport = imports.find( | ||
| (importStatement) => | ||
| importStatement.source.value === 'vue' && | ||
| importStatement.specifiers.some( | ||
| (specifier) => specifier.type === 'ImportSpecifier' | ||
| ) | ||
| ) | ||
|
|
||
| if (vueDestructuredImport) { | ||
| const importSpecifiers = vueDestructuredImport.specifiers | ||
| const lastImportSpecifier = importSpecifiers[importSpecifiers.length - 1] | ||
|
|
||
| // @ts-ignore | ||
| return fixer.insertTextAfter(lastImportSpecifier, `, useTemplateRef`) | ||
| } | ||
|
|
||
| const importStatement = "import { useTemplateRef } from 'vue';" | ||
| const lastImport = imports[imports.length - 1] | ||
|
|
||
| if (lastImport) { | ||
| const indent = createIndent(lastImport) | ||
|
|
||
| return fixer.insertTextAfter(lastImport, `\n${indent}${importStatement}`) | ||
| } | ||
|
|
||
| const firstNode = body[0] | ||
| const indent = createIndent(firstNode) | ||
|
|
||
| return fixer.insertTextBefore(firstNode, `${importStatement}\n${indent}`) | ||
| } | ||
|
|
||
| /** @type {import("eslint").Rule.RuleModule} */ | ||
| module.exports = { | ||
| meta: { | ||
|
|
@@ -54,6 +114,7 @@ module.exports = { | |
| categories: undefined, | ||
| url: 'https://eslint.vuejs.org/rules/prefer-use-template-ref.html' | ||
| }, | ||
| fixable: 'code', | ||
| schema: [], | ||
| messages: { | ||
| preferUseTemplateRef: "Replace '{{name}}' with 'useTemplateRef'." | ||
|
|
@@ -94,6 +155,8 @@ module.exports = { | |
| }), | ||
| { | ||
| 'Program:exit'() { | ||
| let missingImportChecked = false | ||
|
|
||
| for (const templateRef of templateRefs) { | ||
| const scriptRef = scriptRefs.find( | ||
| (scriptRef) => scriptRef.ref === templateRef | ||
|
|
@@ -109,6 +172,30 @@ module.exports = { | |
| data: { | ||
| // @ts-ignore | ||
| name: scriptRef.node?.callee?.name | ||
| }, | ||
| fix(fixer) { | ||
| const typeArgumentsString = scriptRef.typeArguments | ||
| ? `<${scriptRef.typeArguments.join(', ')}>` | ||
| : '' | ||
| const replaceFunctionFix = fixer.replaceText( | ||
| scriptRef.node, | ||
| `useTemplateRef${typeArgumentsString}('${scriptRef.ref}')` | ||
| ) | ||
|
|
||
| if (!missingImportChecked) { | ||
| missingImportChecked = true | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What is this flag for? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @Thomasan1999 it would be great to get this merged. Could you please have a look into this? |
||
|
|
||
| const missingImportFix = addUseTemplateRefImport( | ||
| context, | ||
| fixer | ||
| ) | ||
|
|
||
| if (missingImportFix) { | ||
| return [replaceFunctionFix, missingImportFix] | ||
| } | ||
| } | ||
|
|
||
| return replaceFunctionFix | ||
| } | ||
| }) | ||
| } | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.