Skip to content

Commit 96eb868

Browse files
update docs
1 parent 95aa2a3 commit 96eb868

File tree

4 files changed

+8
-5
lines changed

4 files changed

+8
-5
lines changed

docs/rules/force-types-on-object-props.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,14 @@
22
pageClass: rule-details
33
sidebarDepth: 0
44
title: vue/force-types-on-object-props
5-
description: xxx
5+
description: enforce user to add type declaration to object props
66
---
77
# vue/force-types-on-object-props
88

9-
> xxx
9+
> enforce user to add type declaration to object props
1010
1111
- :exclamation: <badge text="This rule has not been released yet." vertical="middle" type="error"> ***This rule has not been released yet.*** </badge>
12+
- :gear: This rule is included in all of `"plugin:vue/base"`, `"plugin:vue/essential"`, `"plugin:vue/vue3-essential"`, `"plugin:vue/strongly-recommended"`, `"plugin:vue/vue3-strongly-recommended"`, `"plugin:vue/recommended"` and `"plugin:vue/vue3-recommended"`.
1213

1314
## :book: Rule Details
1415

@@ -78,11 +79,11 @@ export default {
7879

7980
Nothing.
8081

81-
## When Not To Use It
82+
## :mute: When Not To Use It
8283

8384
When you're not using TypeScript in the project****.
8485

85-
## Further Reading
86+
## :books: Further Reading
8687

8788
Nothing
8889

docs/rules/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ Rules in this category are enabled for all presets provided by eslint-plugin-vue
2828
| Rule ID | Description | | |
2929
|:--------|:------------|:--:|:--:|
3030
| [vue/comment-directive](./comment-directive.md) | support comment-directives in `<template>` | | :warning: |
31+
| [vue/force-types-on-object-props](./force-types-on-object-props.md) | enforce user to add type declaration to object props | | :hammer: |
3132
| [vue/jsx-uses-vars](./jsx-uses-vars.md) | prevent variables used in JSX to be marked as unused | | :warning: |
3233

3334
</rules-table>

lib/index.js

+1
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ module.exports = {
3535
'dot-notation': require('./rules/dot-notation'),
3636
eqeqeq: require('./rules/eqeqeq'),
3737
'first-attribute-linebreak': require('./rules/first-attribute-linebreak'),
38+
'force-types-on-object-props': require('./rules/force-types-on-object-props'),
3839
'func-call-spacing': require('./rules/func-call-spacing'),
3940
'html-button-has-type': require('./rules/html-button-has-type'),
4041
'html-closing-bracket-newline': require('./rules/html-closing-bracket-newline'),

lib/rules/force-types-on-object-props.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ module.exports = {
3838
type: 'suggestion',
3939
docs: {
4040
description: 'enforce user to add type declaration to object props',
41-
categories: ['Internal'],
41+
categories: ['base'],
4242
recommended: false,
4343
url: 'https://eslint.vuejs.org/rules/force-types-on-object-props.html'
4444
},

0 commit comments

Comments
 (0)