name-property-casing.js 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. /**
  2. * @fileoverview Requires specific casing for the name property in Vue components
  3. * @author Armano
  4. */
  5. 'use strict'
  6. const utils = require('../utils')
  7. const casing = require('../utils/casing')
  8. const allowedCaseOptions = ['PascalCase', 'kebab-case']
  9. // ------------------------------------------------------------------------------
  10. // Rule Definition
  11. // ------------------------------------------------------------------------------
  12. module.exports = {
  13. meta: {
  14. docs: {
  15. description: 'enforce specific casing for the name property in Vue components',
  16. category: 'strongly-recommended',
  17. url: 'https://github.com/vuejs/eslint-plugin-vue/blob/v4.7.1/docs/rules/name-property-casing.md'
  18. },
  19. fixable: 'code', // or "code" or "whitespace"
  20. schema: [
  21. {
  22. enum: allowedCaseOptions
  23. }
  24. ]
  25. },
  26. create (context) {
  27. const options = context.options[0]
  28. const caseType = allowedCaseOptions.indexOf(options) !== -1 ? options : 'PascalCase'
  29. // ----------------------------------------------------------------------
  30. // Public
  31. // ----------------------------------------------------------------------
  32. return utils.executeOnVue(context, (obj) => {
  33. const node = obj.properties
  34. .find(item => (
  35. item.type === 'Property' &&
  36. item.key.name === 'name' &&
  37. item.value.type === 'Literal'
  38. ))
  39. if (!node) return
  40. const value = casing.getConverter(caseType)(node.value.value)
  41. if (value !== node.value.value) {
  42. context.report({
  43. node: node.value,
  44. message: 'Property name "{{value}}" is not {{caseType}}.',
  45. data: {
  46. value: node.value.value,
  47. caseType: caseType
  48. },
  49. fix: fixer => fixer.replaceText(node.value, node.value.raw.replace(node.value.value, value))
  50. })
  51. }
  52. })
  53. }
  54. }