diff --git a/docs/rules/component-api-style.md b/docs/rules/component-api-style.md index d20dc9fe3..af29316e3 100644 --- a/docs/rules/component-api-style.md +++ b/docs/rules/component-api-style.md @@ -73,14 +73,15 @@ export default { ```json { "vue/component-api-style": ["error", - ["script-setup", "composition"] // "script-setup", "composition", or "options" + ["script-setup", "composition"] // "script-setup", "composition", "composition-vue2", or "options" ] } ``` - Array options ... Defines the API styles you want to allow. Default is `["script-setup", "composition"]`. You can use the following values. - - `"script-setup"` ... If set, allows ` ` + }, + { + filename: 'test.vue', + options: [['composition-vue2']], + code: ` + + ` } ], invalid: [ @@ -180,7 +202,7 @@ tester.run('component-api-style', rule, { errors: [ { message: - 'Options API is not allowed in your project. `data` option is the API of Options API. Use ` + `, + options: [['composition-vue2']], + errors: [ + { + message: + '` + `, + errors: [ + { + message: + 'Options API is not allowed in your project. `data` option is part of the Options API. Use Composition API (Vue 2) instead.', + line: 4, + column: 9 + } + ] + }, + { + filename: 'test.vue', + options: [['composition-vue2']], + code: ` + + `, + errors: [ + { + message: + 'Options API is not allowed in your project. `mixins` option is part of the Options API. Use Composition API (Vue 2) instead.', + line: 4, + column: 9 + }, + { + message: + 'Options API is not allowed in your project. `extends` option is part of the Options API. Use Composition API (Vue 2) instead.', + line: 5, + column: 9 + }, + { + message: + 'Options API is not allowed in your project. `data` option is part of the Options API. Use Composition API (Vue 2) instead.', + line: 7, + column: 9 + }, + { + message: + 'Options API is not allowed in your project. `computed` option is part of the Options API. Use Composition API (Vue 2) instead.', + line: 8, + column: 9 + }, + { + message: + 'Options API is not allowed in your project. `methods` option is part of the Options API. Use Composition API (Vue 2) instead.', + line: 9, + column: 9 + }, + { + message: + 'Options API is not allowed in your project. `watch` option is part of the Options API. Use Composition API (Vue 2) instead.', + line: 10, + column: 9 + }, + { + message: + 'Options API is not allowed in your project. `provide` option is part of the Options API. Use Composition API (Vue 2) instead.', + line: 11, + column: 9 + }, + { + message: + 'Options API is not allowed in your project. `inject` option is part of the Options API. Use Composition API (Vue 2) instead.', + line: 12, + column: 9 + }, + { + message: + 'Options API is not allowed in your project. `beforeCreate` lifecycle hook is part of the Options API. Use Composition API (Vue 2) instead.', + line: 14, + column: 9 + }, + { + message: + 'Options API is not allowed in your project. `created` lifecycle hook is part of the Options API. Use Composition API (Vue 2) instead.', + line: 15, + column: 9 + }, + { + message: + 'Options API is not allowed in your project. `beforeMount` lifecycle hook is part of the Options API. Use Composition API (Vue 2) instead.', + line: 16, + column: 9 + }, + { + message: + 'Options API is not allowed in your project. `mounted` lifecycle hook is part of the Options API. Use Composition API (Vue 2) instead.', + line: 17, + column: 9 + }, + { + message: + 'Options API is not allowed in your project. `beforeUpdate` lifecycle hook is part of the Options API. Use Composition API (Vue 2) instead.', + line: 18, + column: 9 + }, + { + message: + 'Options API is not allowed in your project. `updated` lifecycle hook is part of the Options API. Use Composition API (Vue 2) instead.', + line: 19, + column: 9 + }, + { + message: + 'Options API is not allowed in your project. `activated` lifecycle hook is part of the Options API. Use Composition API (Vue 2) instead.', + line: 20, + column: 9 + }, + { + message: + 'Options API is not allowed in your project. `deactivated` lifecycle hook is part of the Options API. Use Composition API (Vue 2) instead.', + line: 21, + column: 9 + }, + { + message: + 'Options API is not allowed in your project. `beforeDestroy` lifecycle hook is part of the Options API. Use Composition API (Vue 2) instead.', + line: 22, + column: 9 + }, + { + message: + 'Options API is not allowed in your project. `beforeUnmount` lifecycle hook is part of the Options API. Use Composition API (Vue 2) instead.', + line: 23, + column: 9 + }, + { + message: + 'Options API is not allowed in your project. `destroyed` lifecycle hook is part of the Options API. Use Composition API (Vue 2) instead.', + line: 24, + column: 9 + }, + { + message: + 'Options API is not allowed in your project. `unmounted` lifecycle hook is part of the Options API. Use Composition API (Vue 2) instead.', + line: 25, + column: 9 + }, + { + message: + 'Options API is not allowed in your project. `errorCaptured` lifecycle hook is part of the Options API. Use Composition API (Vue 2) instead.', line: 29, column: 9 }, { message: - 'Options API is not allowed in your project. `expose` option is the API of Options API. Use Composition API instead.', + 'Options API is not allowed in your project. `expose` option is part of the Options API. Use Composition API (Vue 2) instead.', line: 31, column: 9 }