@dvukovic/style-guide 0.3.96 → 0.3.98

package/src/eslint/rules/no-commented-out-code/no-commented-out-code.test.js

@@ -0,0 +1,89 @@
+import { ESLint } from "eslint"
+import tseslint from "typescript-eslint"
+
+import { dvukovic } from "../../plugins/dvukovic.js"
+
+const eslint = new ESLint({
+    overrideConfig: [
+        {
+            files: ["**/*.ts"],
+            languageOptions: {
+                parser: tseslint.parser,
+            },
+        },
+        dvukovic,
+    ],
+    overrideConfigFile: true,
+})
+
+describe("dvukovic/no-commented-out-code", () => {
+    test("detects commented-out code", async () => {
+        const code = `// const x = 1\nconst y = 2\n`
+
+        const results = await eslint.lintText(code, { filePath: "test.ts" })
+        const errors = results[0]?.messages.filter((message) => {
+            return message.ruleId === "dvukovic/no-commented-out-code"
+        })
+
+        expect(errors?.length).toBe(1)
+    })
+
+    test("detects multi-line commented-out code", async () => {
+        const code = `// function foo() {
+//     return 1
+// }
+const y = 2
+`
+
+        const results = await eslint.lintText(code, { filePath: "test.ts" })
+        const errors = results[0]?.messages.filter((message) => {
+            return message.ruleId === "dvukovic/no-commented-out-code"
+        })
+
+        expect(errors?.length).toBe(1)
+    })
+
+    test("detects block commented-out code", async () => {
+        const code = `/* const x = 1 */\nconst y = 2\n`
+
+        const results = await eslint.lintText(code, { filePath: "test.ts" })
+        const errors = results[0]?.messages.filter((message) => {
+            return message.ruleId === "dvukovic/no-commented-out-code"
+        })
+
+        expect(errors?.length).toBe(1)
+    })
+
+    test("allows regular comments", async () => {
+        const code = `// This is a regular comment\nconst y = 2\n`
+
+        const results = await eslint.lintText(code, { filePath: "test.ts" })
+        const errors = results[0]?.messages.filter((message) => {
+            return message.ruleId === "dvukovic/no-commented-out-code"
+        })
+
+        expect(errors?.length).toBe(0)
+    })
+
+    test("allows TODO comments", async () => {
+        const code = `// TODO: fix this later\nconst y = 2\n`
+
+        const results = await eslint.lintText(code, { filePath: "test.ts" })
+        const errors = results[0]?.messages.filter((message) => {
+            return message.ruleId === "dvukovic/no-commented-out-code"
+        })
+
+        expect(errors).toHaveLength(0)
+    })
+
+    test("allows region comments", async () => {
+        const code = `// #region\nconst y = 2\n// #endregion\n`
+
+        const results = await eslint.lintText(code, { filePath: "test.ts" })
+        const errors = results[0]?.messages.filter((message) => {
+            return message.ruleId === "dvukovic/no-commented-out-code"
+        })
+
+        expect(errors).toHaveLength(0)
+    })
+})

package/src/eslint/rules/no-commented-out-code/no-commented-out-code.utils.js

@@ -0,0 +1,119 @@
+export function isExpressionOrIdentifierOrLiteral(node) {
+    if (node.type === "Identifier") {
+        return true
+    }
+
+    if (node.type === "Literal") {
+        return true
+    }
+
+    if (node.type === "BinaryExpression") {
+        return (
+            isExpressionOrIdentifierOrLiteral(node.left) &&
+            isExpressionOrIdentifierOrLiteral(node.right)
+        )
+    }
+
+    return false
+}
+
+export function hasEmptyBody(program) {
+    return program.type === "Program" && program.body.length === 0
+}
+
+export function hasExpressionBody(program) {
+    return (
+        program.type === "Program" &&
+        program.body.every((statement) => {
+            return (
+                statement.type === "ExpressionStatement" &&
+                isExpressionOrIdentifierOrLiteral(statement.expression)
+            )
+        })
+    )
+}
+
+export function hasLabeledStatementBody(program) {
+    return (
+        program.type === "Program" &&
+        program.body.length === 1 &&
+        program.body[0]?.type === "LabeledStatement"
+    )
+}
+
+export function isRegionComment(content) {
+    return /\s*#(end)?region/.test(content)
+}
+
+export function toBlocks(comments) {
+    const blocks = []
+    let prevLine
+
+    for (const comment of comments) {
+        if (comment.type === "Block") {
+            blocks.push({
+                content: comment.value.replace(/^\s*\*/, "").replaceAll(/\n\s*\*/g, "\n"),
+                loc: { ...comment.loc },
+            })
+            prevLine = undefined
+        } else if (comment.type === "Line") {
+            if (prevLine && prevLine.loc.start.line === comment.loc.start.line - 1) {
+                const previousBlock = blocks.at(-1)
+
+                previousBlock.content = `${previousBlock.content}\n${comment.value}`
+                previousBlock.loc.end = comment.loc.end
+            } else {
+                blocks.push({
+                    content: comment.value,
+                    loc: { ...comment.loc },
+                })
+            }
+
+            prevLine = comment
+        } else {
+            prevLine = undefined
+        }
+    }
+
+    return blocks
+}
+
+export function wrapContent(content, node) {
+    switch (node?.type) {
+        case "ArrayExpression": {
+            return `let wrapper = [${content}]`
+        }
+
+        case "ClassBody": {
+            return `class Wrapper { ${content} }`
+        }
+
+        case "ImportDeclaration": {
+            return `import { ${content} } from "wrapper"`
+        }
+
+        case "ObjectExpression": {
+            return `let wrapper = { ${content} }`
+        }
+
+        case "FunctionDeclaration": {
+            return `function wrapper(${content}) {}`
+        }
+
+        case "SwitchStatement": {
+            return `switch (wrapper) { ${content} }`
+        }
+
+        case "TSInterfaceBody": {
+            return `interface Wrapper { ${content} }`
+        }
+
+        case "TSTypeLiteral": {
+            return `type Wrapper = { ${content} }`
+        }
+
+        default: {
+            return null
+        }
+    }
+}

package/src/eslint/types.js

@@ -0,0 +1,19 @@
+/**
+ * @typedef {Object} ConfigOptions
+ * @property {boolean} [replace=false] - If true, replaces default config entirely with custom
+ *   configs. Default is `false`
+ * @property {any[]} [configs=[]] - Additional configs to append or use as replacement. Default is
+ *   `[]`
+ */
+
+/**
+ * @typedef {Object} TypeScriptConfigOptions
+ * @property {boolean} [replace=false] - If true, replaces default config entirely with custom
+ *   configs. Default is `false`
+ * @property {any[]} [configs=[]] - Additional configs to append or use as replacement. Default is
+ *   `[]`
+ * @property {string} [tsconfigPath="./tsconfig.json"] - Path to tsconfig.json file. Default is
+ *   `"./tsconfig.json"`
+ */
+
+export {}

package/src/eslint/plugins/etc.js

@@ -1,3 +0,0 @@
-const plugin = {}
-
-export default plugin