| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788 |
- /**
- * @fileoverview Requires specific casing for the Prop name in Vue components
- * @author Yu Kimura
- */
- 'use strict'
- const utils = require('../utils')
- const casing = require('../utils/casing')
- const { toRegExp } = require('../utils/regexp')
- const allowedCaseOptions = ['camelCase', 'snake_case']
- /**
- * @typedef {import('../utils').ComponentProp} ComponentProp
- */
- /** @param {RuleContext} context */
- function create(context) {
- const options = context.options[0]
- /** @type {RegExp[]} */
- const ignoreProps = (context.options[1]?.ignoreProps || []).map(toRegExp)
- const caseType = allowedCaseOptions.includes(options) ? options : 'camelCase'
- const checker = casing.getChecker(caseType)
- /**
- * @param {ComponentProp[]} props
- */
- function processProps(props) {
- for (const item of props) {
- const propName = item.propName
- if (propName == null) {
- continue
- }
- if (!checker(propName) && !ignoreProps.some((re) => re.test(propName))) {
- context.report({
- node: item.node,
- messageId: 'invalidCase',
- data: {
- name: propName,
- caseType
- }
- })
- }
- }
- }
- return utils.compositingVisitors(
- utils.defineScriptSetupVisitor(context, {
- onDefinePropsEnter(_node, props) {
- processProps(props)
- }
- }),
- utils.executeOnVue(context, (obj) => {
- processProps(utils.getComponentPropsFromOptions(obj))
- })
- )
- }
- module.exports = {
- meta: {
- type: 'suggestion',
- docs: {
- description:
- 'enforce specific casing for the Prop name in Vue components',
- categories: ['vue3-strongly-recommended', 'vue2-strongly-recommended'],
- url: 'https://eslint.vuejs.org/rules/prop-name-casing.html'
- },
- fixable: null, // null or "code" or "whitespace"
- schema: [
- {
- enum: allowedCaseOptions
- },
- {
- type: 'object',
- properties: {
- ignoreProps: {
- type: 'array',
- items: { type: 'string' },
- uniqueItems: true
- }
- },
- additionalProperties: false
- }
- ],
- messages: {
- invalidCase: 'Prop "{{name}}" is not in {{caseType}}.'
- }
- },
- create
- }
|