Commit 536c6a1

committed

feature: rename autoFixToSeparateInterface option and describe it in the docs

1 parent f6c205f commit 536c6a1Copy full SHA for 536c6a1

File tree

+13

-5

lines changed

+13

-5

lines changed

Lines changed: 9 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -41,11 +41,19 @@ const props = defineProps({`
`41`	`41`	`## :wrench: Options`
`42`	`42`
`43`	`43`	```json
`44`		`- "vue/define-props-declaration": ["error", "type-based" \| "runtime"]`
	`44`	`+{`
	`45`	`+ "vue/define-props-declaration": ["error",`
	`46`	`+ "type-based" \| "runtime",`
	`47`	`+ {`
	`48`	`+ "autoFixToSeparateInterface": false`
	`49`	`+ }`
	`50`	`+ ]`
	`51`	`+}`
`45`	`52`	```
`46`	`53`
`47`	`54`	- `type-based` (default) enforces type-based declaration
`48`	`55`	- `runtime` enforces runtime declaration
	`56`	+- `autoFixToSeparateInterface` (`boolean`) define `interface Props` used for type-based declaration instead of providing types inline
`49`	`57`
`50`	`58`	### `"runtime"`
`51`	`59`

Lines changed: 3 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -184,7 +184,7 @@ module.exports = {`
`184`	`184`	`{`
`185`	`185`	`type: 'object',`
`186`	`186`	`properties: {`
`187`		`- separateInterface: {`
	`187`	`+ autoFixToSeparateInterface: {`
`188`	`188`	`type: 'boolean',`
`189`	`189`	`default: false`
`190`	`190`	`}`
`@@ -206,7 +206,7 @@ module.exports = {`
`206`	`206`	`}`
`207`	`207`
`208`	`208`	`const defineType = context.options[0] \|\| 'type-based'`
`209`		`- const separateInterface = context.options[1]?.separateInterface \|\| false`
	`209`	`+ const autoFixToSeparateInterface = context.options[1]?.autoFixToSeparateInterface \|\| false`
`210`	`210`
`211`	`211`	`return utils.defineScriptSetupVisitor(context, {`
`212`	`212`	`onDefinePropsEnter(node, props) {`
`@@ -235,7 +235,7 @@ module.exports = {`
`235`	`235`	`yield fixer.replaceText(node.arguments[0], '')`
`236`	`236`
`237`	`237`	`// add type annotation`
`238`		`- if (separateInterface) {`
	`238`	`+ if (autoFixToSeparateInterface) {`
`239`	`239`	`const variableDeclarationNode = node.parent.parent`
`240`	`240`	`if (!variableDeclarationNode) {`
`241`	`241`	`return`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -555,7 +555,7 @@ tester.run('define-props-declaration', rule, {`
`555`	`555`	`interface Props { kind?: { id: number, name: string } }; const props = defineProps<Props>()`
`556`	`556`	`</script>`
`557`	`557`	`,
`558`		`- options: ['type-based', { separateInterface: true }],`
	`558`	`+ options: ['type-based', { autoFixToSeparateInterface: true }],`
`559`	`559`	`errors: [`
`560`	`560`	`{`
`561`	`561`	`message: 'Use type-based declaration instead of runtime declaration.',`

Comments

(0)