Skip to content

Commit e386e34

Browse files
authoredJun 10, 2023
chore: remove require-jsdoc internal rule (#497)
1 parent 2ef1462 commit e386e34

File tree

3 files changed

+1
-8
lines changed

3 files changed

+1
-8
lines changed
 

‎.eslintrc.js

+1-2
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ module.exports = {
2020
"plugin:@ota-meshi/+prettier",
2121
],
2222
rules: {
23-
"require-jsdoc": "error",
23+
"require-jsdoc": "off",
2424
"no-warning-comments": "warn",
2525
"no-lonely-if": "off",
2626
"new-cap": "off",
@@ -150,7 +150,6 @@ module.exports = {
150150
project: require.resolve("./tsconfig.json"),
151151
},
152152
rules: {
153-
"require-jsdoc": "off",
154153
"no-console": "off",
155154
},
156155
},

‎tools/render-rules.ts

-3
Original file line numberDiff line numberDiff line change
@@ -44,13 +44,11 @@ const categoryRules = categories.map((cat) => {
4444
}
4545
})
4646

47-
//eslint-disable-next-line require-jsdoc -- ignore
4847
export default function renderRulesTableContent(
4948
buildRulePath = (ruleName: string) => `./rules/${ruleName}.md`,
5049
): string {
5150
// -----------------------------------------------------------------------------
5251

53-
//eslint-disable-next-line require-jsdoc -- ignore
5452
function toRuleRow(rule: RuleModule) {
5553
const mark = `${rule.meta.docs.recommended ? ":star:" : ""}${
5654
rule.meta.fixable ? ":wrench:" : ""
@@ -65,7 +63,6 @@ export default function renderRulesTableContent(
6563
return `| ${link} | ${description} | ${mark} |`
6664
}
6765

68-
//eslint-disable-next-line require-jsdoc -- ignore
6966
function toDeprecatedRuleRow(rule: RuleModule) {
7067
const link = `[${rule.meta.docs.ruleId}](${buildRulePath(
7168
rule.meta.docs.ruleName || "",

‎tools/update-docs.ts

-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ import { rules } from "../src/utils/rules"
44
import type { RuleModule } from "../src/types"
55
import { getNewVersion } from "./lib/changesets-util"
66

7-
//eslint-disable-next-line require-jsdoc -- tools
87
function formatItems(items: string[]) {
98
if (items.length <= 2) {
109
return items.join(" and ")
@@ -14,7 +13,6 @@ function formatItems(items: string[]) {
1413
}`
1514
}
1615

17-
//eslint-disable-next-line require-jsdoc -- tools
1816
function yamlValue(val: unknown) {
1917
if (typeof val === "string") {
2018
return `"${val.replace(/\\/gu, "\\\\").replace(/"/gu, '\\"')}"`
@@ -24,7 +22,6 @@ function yamlValue(val: unknown) {
2422

2523
const ROOT = path.resolve(__dirname, "../docs/rules")
2624

27-
//eslint-disable-next-line require-jsdoc -- tools
2825
function pickSince(content: string): string | null | Promise<string> {
2926
const fileIntro = /^---\n((?:.*\n)+)---\n*/.exec(content)
3027
if (fileIntro) {

0 commit comments

Comments
 (0)
Please sign in to comment.