Skip to content

[Update] Make vue/prop-name-casing fixable #402

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.

Sign up for GitHub

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 20 commits into from
Mar 21, 2018
Merged

[Update] Make vue/prop-name-casing fixable #402

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
98dbf8a
Add Vue.extend support, add missing info about Vue.mixin check in readme
michalsnik Jan 2, 2018
7c4a1d2
Docs: fixes wording in docs (#372)
samturrell Feb 1, 2018
cd22a28
Fix: fix script-indent to prevent removing <script> tag (fixes #367) …
mysticatea Feb 16, 2018
ee5cc0a
[Update] Make `vue/max-attributes-per-line` fixable (#380)
ota-meshi Feb 16, 2018
6861c81
Update: make `vue/order-in-components` fixable (#381)
ota-meshi Feb 17, 2018
5890808
Fix: no-async-in-computed-properties crash (fixes #390)
mysticatea Feb 16, 2018
e79dd8b
Fix: valid-v-on false positive (fixes #351)
mysticatea Feb 16, 2018
733172c
Fix: indent rules false positive (fixes #375)
mysticatea Feb 16, 2018
e887a8d
[New] Add `prop-name-casing`
Dec 10, 2017
22a3a75
fix message and category
Jan 4, 2018
a846dd1
fix category
Jan 4, 2018
b1a7cca
fix test message
Jan 4, 2018
17d8c2b
Set category to undefined
michalsnik Jan 6, 2018
789a2fc
Add more tests and fix edge case scenario
michalsnik Jan 28, 2018
e804ca2
attribute order linting
Jan 5, 2018
abbde6f
updating docs, tests and category
Feb 7, 2018
b5f9b0d
[Update] Make `vue/prop-name-casing` fixable
ota-meshi Feb 22, 2018
4338fc5
[fix] Only ASCII printable characters can be auto fixable
ota-meshi Feb 23, 2018
c6b0d17
Merge branch 'master' into develop/prop-name-casing--fixable
ota-meshi Feb 24, 2018
ff49d6d
[fix] That `vue/attributes-order` got duplicated when merging README
ota-meshi Feb 24, 2018
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
23 changes: 21 additions & 2 deletions lib/rules/prop-name-casing.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,20 @@ const utils = require('../utils')
const casing = require('../utils/casing')
const allowedCaseOptions = ['camelCase', 'snake_case']

function canFixPropertyName (node, originalName) {
// Can not fix of computed property names & shorthand
if (node.computed || node.shorthand) {
return false
}
const key = node.key
// Can not fix of unknown types
if (key.type !== 'Literal' && key.type !== 'Identifier') {
return false
}
// Can fix of ASCII printable characters
return originalName.match(/[ -~]+/)
}

// ------------------------------------------------------------------------------
// Rule Definition
// ------------------------------------------------------------------------------
Expand Down Expand Up @@ -46,7 +60,12 @@ function create (context) {
data: {
name: propName,
caseType: caseType
}
},
fix: canFixPropertyName(item, propName) ? fixer => {
return item.key.type === 'Literal'
? fixer.replaceText(item.key, item.key.raw.replace(item.key.value, convertedName))
: fixer.replaceText(item.key, convertedName)
} : undefined
})
}
}
Expand All @@ -63,7 +82,7 @@ module.exports = {
description: 'enforce specific casing for the Prop name in Vue components',
category: undefined // 'strongly-recommended'
},
fixable: null, // or "code" or "whitespace"
fixable: 'code', // null or "code" or "whitespace"
schema: [
{
enum: allowedCaseOptions
Expand Down
172 changes: 172 additions & 0 deletions tests/lib/rules/prop-name-casing.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,13 @@ ruleTester.run('prop-name-casing', rule, {
}
}
`,
output: `
export default {
props: {
greetingText: String
}
}
`,
parserOptions,
errors: [{
message: 'Prop "greeting_text" is not in camelCase.',
Expand All @@ -138,6 +145,13 @@ ruleTester.run('prop-name-casing', rule, {
}
`,
options: ['camelCase'],
output: `
export default {
props: {
greetingText: String
}
}
`,
parserOptions,
errors: [{
message: 'Prop "greeting_text" is not in camelCase.',
Expand All @@ -155,6 +169,13 @@ ruleTester.run('prop-name-casing', rule, {
}
`,
options: ['snake_case'],
output: `
export default {
props: {
greeting_text: String
}
}
`,
parserOptions,
errors: [{
message: 'Prop "greetingText" is not in snake_case.',
Expand All @@ -172,6 +193,13 @@ ruleTester.run('prop-name-casing', rule, {
}
`,
options: ['camelCase'],
output: `
export default {
props: {
'greetingText': String
}
}
`,
parserOptions,
errors: [{
message: 'Prop "greeting-text" is not in camelCase.',
Expand All @@ -189,12 +217,156 @@ ruleTester.run('prop-name-casing', rule, {
}
`,
options: ['snake_case'],
output: `
export default {
props: {
'greeting_text': String
}
}
`,
parserOptions,
errors: [{
message: 'Prop "greeting-text" is not in snake_case.',
type: 'Property',
line: 4
}]
},
{
filename: 'test.vue',
code: `
export default {
props: {
'greeting_text': String
}
}
`,
output: `
export default {
props: {
'greetingText': String
}
}
`,
parserOptions,
errors: [{
message: 'Prop "greeting_text" is not in camelCase.',
type: 'Property',
line: 4
}]
},
{
// computed property name
filename: 'test.vue',
code: `
export default {
props: {
['greeting-text']: String
}
}
`,
output: null,
parserOptions,
errors: [{
message: 'Prop "greeting-text" is not in camelCase.',
type: 'Property',
line: 4
}]
},
{
// shorthand
filename: 'test.vue',
code: `
export default {
props: {
greeting_text
}
}
`,
output: null,
parserOptions,
errors: [{
message: 'Prop "greeting_text" is not in camelCase.',
type: 'Property',
line: 4
}]
},
{
// valiable computed property name
filename: 'test.vue',
code: `
export default {
props: {
[greeting_text]: String
}
}
`,
output: null,
parserOptions,
errors: [{
// bug ?
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess so, it shouldn't throw error in this case I think.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But we can deal with it in separate task.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your view
I wrote an issue #442

message: 'Prop "greeting_text" is not in camelCase.',
type: 'Property',
line: 4
}]
},
{
// emoji
filename: 'test.vue',
code: `
export default {
props: {
'\u{1F37B}': String
}
}
`,
output: null,
parserOptions,
errors: [{
message: 'Prop "\u{1F37B}" is not in camelCase.',
type: 'Property',
line: 4
}]
},
{
// Japanese characters
filename: 'test.vue',
code: `
export default {
props: {
'漢字': String
}
}
`,
output: null,
parserOptions,
errors: [{
message: 'Prop "漢字" is not in camelCase.',
type: 'Property',
line: 4
}]
},
{
filename: 'test.vue',
code: `
export default {
props: {
'abc-123-def': String
}
}
`,
output: `
export default {
props: {
'abc123Def': String
}
}
`,
parserOptions,
errors: [{
message: 'Prop "abc-123-def" is not in camelCase.',
type: 'Property',
line: 4
}]
}
]
})