Skip to content

Update vue/prop-name-casing rule to support <script setup> #1544

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

Merged
merged 2 commits into from
Jul 5, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 22 additions & 3 deletions lib/rules/prop-name-casing.js
Original file line number Diff line number Diff line change
@@ -8,6 +8,12 @@ const utils = require('../utils')
const casing = require('../utils/casing')
const allowedCaseOptions = ['camelCase', 'snake_case']

/**
* @typedef {import('../utils').ComponentArrayProp} ComponentArrayProp
* @typedef {import('../utils').ComponentObjectProp} ComponentObjectProp
* @typedef {import('../utils').ComponentTypeProp} ComponentTypeProp
*/

// ------------------------------------------------------------------------------
// Rule Definition
// ------------------------------------------------------------------------------
@@ -22,8 +28,11 @@ function create(context) {
// Public
// ----------------------------------------------------------------------

return utils.executeOnVue(context, (obj) => {
for (const item of utils.getComponentProps(obj)) {
/**
* @param {(ComponentArrayProp | ComponentObjectProp | ComponentTypeProp)[]} props
*/
function processProps(props) {
for (const item of props) {
const propName = item.propName
if (propName == null) {
continue
@@ -39,7 +48,17 @@ function create(context) {
})
}
}
})
}
return utils.compositingVisitors(
utils.defineScriptSetupVisitor(context, {
onDefinePropsEnter(_node, props) {
processProps(props)
}
}),
utils.executeOnVue(context, (obj) => {
processProps(utils.getComponentProps(obj))
})
)
}

// ------------------------------------------------------------------------------
104 changes: 103 additions & 1 deletion tests/lib/rules/prop-name-casing.js
Original file line number Diff line number Diff line change
@@ -8,6 +8,7 @@
// Requirements
// ------------------------------------------------------------------------------

const semver = require('semver')
const rule = require('../../../lib/rules/prop-name-casing')
const RuleTester = require('eslint').RuleTester

@@ -322,6 +323,44 @@ ruleTester.run('prop-name-casing', rule, {
`,
options: ['snake_case'],
parserOptions
},
{
filename: 'test.vue',
code: `
<script setup>
defineProps({
greetingText: String
})
</script>
`,
parser: require.resolve('vue-eslint-parser'),
parserOptions
},
{
filename: 'test.vue',
code: `
<script setup>
defineProps(['greetingText'])
</script>
`,
parser: require.resolve('vue-eslint-parser'),
parserOptions
},
{
filename: 'test.vue',
code: `
<script setup lang="ts">
interface Props {
greetingText: number
}
defineProps<Props>()
</script>
`,
parser: require.resolve('vue-eslint-parser'),
parserOptions: {
...parserOptions,
parser: require.resolve('@typescript-eslint/parser')
}
}
],

@@ -580,6 +619,69 @@ ruleTester.run('prop-name-casing', rule, {
`,
parserOptions,
errors: ['Prop "/greeting-text/" is not in camelCase.']
}
},
{
filename: 'test.vue',
code: `
<script setup>
defineProps({
greeting_text: String
})
</script>
`,
parser: require.resolve('vue-eslint-parser'),
parserOptions,
errors: [
{
message: 'Prop "greeting_text" is not in camelCase.',
line: 4
}
]
},
{
filename: 'test.vue',
code: `
<script setup>
defineProps(['greeting_text'])
</script>
`,
parser: require.resolve('vue-eslint-parser'),
parserOptions,
errors: [
{
message: 'Prop "greeting_text" is not in camelCase.',
line: 3
}
]
},
...(semver.lt(
require('@typescript-eslint/parser/package.json').version,
'4.0.0'
)
? []
: [
{
filename: 'test.vue',
code: `
<script setup lang="ts">
interface Props {
greeting_text: number
}
defineProps<Props>()
</script>
`,
parser: require.resolve('vue-eslint-parser'),
parserOptions: {
...parserOptions,
parser: require.resolve('@typescript-eslint/parser')
},
errors: [
{
message: 'Prop "greeting_text" is not in camelCase.',
line: 4
}
]
}
])
]
})