Skip to content
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

Jump to bottom

Drop autofix of prop-name-casing. #940

Merged
merged 2 commits into from Sep 25, 2019
Merged

Drop autofix of prop-name-casing. #940

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f923ddd
Drop autofix of prop-name-casing.
ota-meshi Aug 10, 2019
efd10c0
Fixed eslint error
ota-meshi Aug 10, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/rules/README.md
View file
Open in desktop
Expand Up @@ -98,7 +98,7 @@ Enforce all the rules in this category, as well as all higher priority rules, wi
| [vue/no-multi-spaces](./no-multi-spaces.md) | disallow multiple spaces | :wrench: |
| [vue/no-spaces-around-equal-signs-in-attribute](./no-spaces-around-equal-signs-in-attribute.md) | disallow spaces around equal signs in attribute | :wrench: |
| [vue/no-template-shadow](./no-template-shadow.md) | disallow variable declarations from shadowing variables declared in the outer scope | |
| [vue/prop-name-casing](./prop-name-casing.md) | enforce specific casing for the Prop name in Vue components | :wrench: |
| [vue/prop-name-casing](./prop-name-casing.md) | enforce specific casing for the Prop name in Vue components | |
| [vue/require-default-prop](./require-default-prop.md) | require default value for props | |
| [vue/require-prop-types](./require-prop-types.md) | require type definitions in props | |
| [vue/singleline-html-element-content-newline](./singleline-html-element-content-newline.md) | require a line break before and after the contents of a singleline element | :wrench: |
Expand Down
5 changes: 2 additions & 3 deletions docs/rules/prop-name-casing.md
View file
Open in desktop
Expand Up @@ -8,13 +8,12 @@ description: enforce specific casing for the Prop name in Vue components
> enforce specific casing for the Prop name in Vue components

- :gear: This rule is included in `"plugin:vue/strongly-recommended"` and `"plugin:vue/recommended"`.
- :wrench: The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the problems reported by this rule.

## :book: Rule Details

This rule enforce proper casing of props in vue components(camelCase).

<eslint-code-block fix :rules="{'vue/prop-name-casing': ['error']}">
<eslint-code-block :rules="{'vue/prop-name-casing': ['error']}">

```vue
<script>
Expand Down Expand Up @@ -46,7 +45,7 @@ export default {

### `"snake_case"`

<eslint-code-block fix :rules="{'vue/prop-name-casing': ['error', 'snake_case']}">
<eslint-code-block :rules="{'vue/prop-name-casing': ['error', 'snake_case']}">

```vue
<script>
Expand Down
23 changes: 2 additions & 21 deletions lib/rules/prop-name-casing.js
View file
Open in desktop
Expand Up @@ -8,20 +8,6 @@ const utils = require('../utils')
const casing = require('../utils/casing')
const allowedCaseOptions = ['camelCase', 'snake_case']

function canFixPropertyName (node, key, originalName) {
// Can not fix of computed property names & shorthand
if (node.computed || node.shorthand) {
return false
}

// 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 @@ -53,12 +39,7 @@ function create (context) {
data: {
name: propName,
caseType: caseType
},
fix: canFixPropertyName(item.node, item.key, 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 @@ -77,7 +58,7 @@ module.exports = {
category: 'strongly-recommended',
url: 'https://eslint.vuejs.org/rules/prop-name-casing.html'
},
fixable: 'code', // null or "code" or "whitespace"
fixable: null, // null or "code" or "whitespace"
schema: [
{
enum: allowedCaseOptions
Expand Down
59 changes: 0 additions & 59 deletions tests/lib/rules/prop-name-casing.js
View file
Open in desktop
Expand Up @@ -300,13 +300,6 @@ ruleTester.run('prop-name-casing', rule, {
}
}
`,
output: `
export default {
props: {
greetingText: String
}
}
`,
parserOptions,
errors: [{
message: 'Prop "greeting_text" is not in camelCase.',
Expand All @@ -324,13 +317,6 @@ 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 @@ -346,11 +332,6 @@ ruleTester.run('prop-name-casing', rule, {
}
`,
options: ['camelCase'],
output: `
export default {
props: ['greetingText']
}
`,
parserOptions,
errors: [{
message: 'Prop "greeting_text" is not in camelCase.',
Expand All @@ -368,13 +349,6 @@ 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 @@ -392,13 +366,6 @@ 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 @@ -416,13 +383,6 @@ 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.',
Expand All @@ -439,13 +399,6 @@ ruleTester.run('prop-name-casing', rule, {
}
}
`,
output: `
export default {
props: {
'greetingText': String
}
}
`,
parserOptions,
errors: [{
message: 'Prop "greeting_text" is not in camelCase.',
Expand All @@ -463,7 +416,6 @@ ruleTester.run('prop-name-casing', rule, {
}
}
`,
output: null,
parserOptions,
errors: [{
message: 'Prop "greeting-text" is not in camelCase.',
Expand All @@ -481,7 +433,6 @@ ruleTester.run('prop-name-casing', rule, {
}
}
`,
output: null,
parserOptions,
errors: [{
message: 'Prop "greeting_text" is not in camelCase.',
Expand All @@ -499,7 +450,6 @@ ruleTester.run('prop-name-casing', rule, {
}
}
`,
output: null,
parserOptions,
errors: [{
message: 'Prop "\u{1F37B}" is not in camelCase.',
Expand All @@ -517,7 +467,6 @@ ruleTester.run('prop-name-casing', rule, {
}
}
`,
output: null,
parserOptions,
errors: [{
message: 'Prop "漢字" is not in camelCase.',
Expand All @@ -534,13 +483,6 @@ ruleTester.run('prop-name-casing', rule, {
}
}
`,
output: `
export default {
props: {
'abc123Def': String
}
}
`,
parserOptions,
errors: [{
message: 'Prop "abc-123-def" is not in camelCase.',
Expand All @@ -558,7 +500,6 @@ ruleTester.run('prop-name-casing', rule, {
}
}
`,
output: null,
parserOptions,
errors: [{
message: 'Prop "greeting-text" is not in camelCase.',
Expand Down