no-shared-component-data.js 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  1. /**
  2. * @fileoverview Enforces component's data property to be a function.
  3. * @author Armano
  4. */
  5. 'use strict'
  6. const utils = require('../utils')
  7. /** @param {Token} token */
  8. function isOpenParen(token) {
  9. return token.type === 'Punctuator' && token.value === '('
  10. }
  11. /** @param {Token} token */
  12. function isCloseParen(token) {
  13. return token.type === 'Punctuator' && token.value === ')'
  14. }
  15. /**
  16. * @param {Expression} node
  17. * @param {SourceCode} sourceCode
  18. */
  19. function getFirstAndLastTokens(node, sourceCode) {
  20. let first = sourceCode.getFirstToken(node)
  21. let last = sourceCode.getLastToken(node)
  22. // If the value enclosed by parentheses, update the 'first' and 'last' by the parentheses.
  23. while (true) {
  24. const prev = sourceCode.getTokenBefore(first)
  25. const next = sourceCode.getTokenAfter(last)
  26. if (isOpenParen(prev) && isCloseParen(next)) {
  27. first = prev
  28. last = next
  29. } else {
  30. return { first, last }
  31. }
  32. }
  33. }
  34. module.exports = {
  35. meta: {
  36. type: 'problem',
  37. docs: {
  38. description: "enforce component's data property to be a function",
  39. categories: ['vue3-essential', 'essential'],
  40. url: 'https://eslint.vuejs.org/rules/no-shared-component-data.html'
  41. },
  42. fixable: 'code',
  43. schema: []
  44. },
  45. /** @param {RuleContext} context */
  46. create(context) {
  47. const sourceCode = context.getSourceCode()
  48. return utils.executeOnVueComponent(context, (obj) => {
  49. const invalidData = utils.findProperty(
  50. obj,
  51. 'data',
  52. (p) =>
  53. p.value.type !== 'FunctionExpression' &&
  54. p.value.type !== 'ArrowFunctionExpression' &&
  55. p.value.type !== 'Identifier'
  56. )
  57. if (invalidData) {
  58. context.report({
  59. node: invalidData,
  60. message: '`data` property in component must be a function.',
  61. fix(fixer) {
  62. const tokens = getFirstAndLastTokens(invalidData.value, sourceCode)
  63. return [
  64. fixer.insertTextBefore(tokens.first, 'function() {\nreturn '),
  65. fixer.insertTextAfter(tokens.last, ';\n}')
  66. ]
  67. }
  68. })
  69. }
  70. })
  71. }
  72. }