mirror of
https://github.com/oxc-project/oxc.git
synced 2026-11-04 10:29:58 +00:00
feat(linter): mark jsdoc rules as recommended (#27689)
Marking upstream recommended rules as recommended here. --- <sub>Stack created with <a href="https://github.com/github/gh-stack">GitHub Stacks CLI</a> • <a href="https://gh.io/stacks-feedback">Give Feedback 💬</a></sub>
This commit is contained in:
1 parent
780bff398e
commit
199dfdc4dd
19 files changed
+22
-4
No files matched your search
@@ -58,6 +58,7 @@ declare_oxc_lint!(
|
||||
CheckAccess,
|
||||
jsdoc,
|
||||
restriction,
|
||||
recommended,
|
||||
version = "0.2.16",
|
||||
short_description = "Checks that `@access` tags use one of the allowed values.",
|
||||
);
|
||||
|
||||
@@ -59,6 +59,7 @@ declare_oxc_lint!(
|
||||
CheckPropertyNames,
|
||||
jsdoc,
|
||||
correctness,
|
||||
recommended,
|
||||
pending,
|
||||
version = "0.2.18",
|
||||
short_description = "Ensures that property names in JSDoc are not duplicated on the same block and that nested properties have defined roots.",
|
||||
|
||||
@@ -81,6 +81,7 @@ declare_oxc_lint!(
|
||||
CheckTagNames,
|
||||
jsdoc,
|
||||
correctness,
|
||||
recommended,
|
||||
pending,
|
||||
config = CheckTagNamesConfig,
|
||||
version = "0.3.2",
|
||||
|
||||
@@ -63,6 +63,7 @@ declare_oxc_lint!(
|
||||
EmptyTags,
|
||||
jsdoc,
|
||||
restriction,
|
||||
recommended,
|
||||
pending,
|
||||
config = EmptyTagsConfig,
|
||||
version = "0.2.16",
|
||||
|
||||
@@ -56,6 +56,7 @@ declare_oxc_lint!(
|
||||
ImplementsOnClasses,
|
||||
jsdoc,
|
||||
correctness,
|
||||
recommended,
|
||||
version = "0.3.2",
|
||||
short_description = "Reports an issue with any non-constructor function using `@implements`.",
|
||||
);
|
||||
|
||||
@@ -49,6 +49,7 @@ declare_oxc_lint!(
|
||||
NoDefaults,
|
||||
jsdoc,
|
||||
correctness,
|
||||
recommended,
|
||||
pending,
|
||||
config = NoDefaultsConfig,
|
||||
version = "0.3.2",
|
||||
|
||||
@@ -108,6 +108,7 @@ declare_oxc_lint!(
|
||||
RequireParam,
|
||||
jsdoc,
|
||||
pedantic,
|
||||
recommended,
|
||||
pending,
|
||||
config = RequireParamConfig,
|
||||
version = "0.4.3",
|
||||
|
||||
@@ -77,6 +77,7 @@ declare_oxc_lint!(
|
||||
RequireParamDescription,
|
||||
jsdoc,
|
||||
pedantic,
|
||||
recommended,
|
||||
pending,
|
||||
config = RequireParamDescriptionConfig,
|
||||
version = "0.4.4",
|
||||
|
||||
@@ -44,6 +44,7 @@ declare_oxc_lint!(
|
||||
RequireParamName,
|
||||
jsdoc,
|
||||
pedantic,
|
||||
recommended,
|
||||
version = "0.4.3",
|
||||
short_description = "Requires that all `@param` tags have names.",
|
||||
);
|
||||
|
||||
@@ -59,6 +59,7 @@ declare_oxc_lint!(
|
||||
RequireProperty,
|
||||
jsdoc,
|
||||
correctness,
|
||||
recommended,
|
||||
pending,
|
||||
version = "0.2.18",
|
||||
short_description = "Requires that all `@typedef` and `@namespace` tags have `@property` tags when their type is a plain object.",
|
||||
|
||||
@@ -46,6 +46,7 @@ declare_oxc_lint!(
|
||||
RequirePropertyDescription,
|
||||
jsdoc,
|
||||
correctness,
|
||||
recommended,
|
||||
version = "0.2.18",
|
||||
short_description = "Requires that all `@property` tags have descriptions.",
|
||||
);
|
||||
|
||||
@@ -46,6 +46,7 @@ declare_oxc_lint!(
|
||||
RequirePropertyName,
|
||||
jsdoc,
|
||||
correctness,
|
||||
recommended,
|
||||
version = "0.2.18",
|
||||
short_description = "Requires that all `@property` tags have names.",
|
||||
);
|
||||
|
||||
@@ -46,6 +46,7 @@ declare_oxc_lint!(
|
||||
RequirePropertyType,
|
||||
jsdoc,
|
||||
correctness,
|
||||
recommended,
|
||||
version = "0.2.18",
|
||||
short_description = "Requires that each `@property` tag has a type value (within curly brackets).",
|
||||
);
|
||||
|
||||
@@ -93,6 +93,7 @@ declare_oxc_lint!(
|
||||
RequireReturns,
|
||||
jsdoc,
|
||||
pedantic,
|
||||
recommended,
|
||||
pending,
|
||||
config = RequireReturnsConfig,
|
||||
version = "0.4.0",
|
||||
|
||||
@@ -45,6 +45,7 @@ declare_oxc_lint!(
|
||||
RequireReturnsDescription,
|
||||
jsdoc,
|
||||
pedantic,
|
||||
recommended,
|
||||
version = "0.4.0",
|
||||
short_description = "Requires that the `@returns` tag has a description value.",
|
||||
);
|
||||
|
||||
@@ -97,7 +97,7 @@ fn test() {
|
||||
* @returns {number}
|
||||
*/
|
||||
function quux () {
|
||||
|
||||
|
||||
}
|
||||
",
|
||||
None,
|
||||
@@ -132,7 +132,7 @@ fn test() {
|
||||
* @returns
|
||||
*/
|
||||
function quux () {
|
||||
|
||||
|
||||
}
|
||||
",
|
||||
None,
|
||||
@@ -144,7 +144,7 @@ fn test() {
|
||||
* @returns Foo.
|
||||
*/
|
||||
function quux () {
|
||||
|
||||
|
||||
}
|
||||
",
|
||||
None,
|
||||
@@ -156,7 +156,7 @@ fn test() {
|
||||
* @return Foo.
|
||||
*/
|
||||
function quux () {
|
||||
|
||||
|
||||
}
|
||||
",
|
||||
None,
|
||||
|
||||
@@ -46,6 +46,7 @@ declare_oxc_lint!(
|
||||
RequireThrowsType,
|
||||
jsdoc,
|
||||
pedantic,
|
||||
recommended,
|
||||
version = "1.65.0",
|
||||
short_description = "Requires a type on the `@throws` tag.",
|
||||
);
|
||||
|
||||
@@ -100,6 +100,7 @@ declare_oxc_lint!(
|
||||
RequireYields,
|
||||
jsdoc,
|
||||
correctness,
|
||||
recommended,
|
||||
config = RequireYieldsConfig,
|
||||
version = "0.3.2",
|
||||
short_description = "Requires that yields are documented with `@yields`.",
|
||||
|
||||
@@ -42,6 +42,7 @@ declare_oxc_lint!(
|
||||
RequireYieldsType,
|
||||
jsdoc,
|
||||
pedantic,
|
||||
recommended,
|
||||
version = "1.65.0",
|
||||
short_description = "Requires a type on the `@yields` tag.",
|
||||
);
|
||||
|
||||
Reference in new issue
Block a user