@dvukovic/style-guide 0.3.97 → 0.3.98

package/src/eslint/configs/playwright.js

@@ -1,5 +1,28 @@
-import playwrightPlugin from "../plugins/playwright.js"
+import { playwright as playwrightPlugin } from "../plugins/playwright.js"
 
-const playwrightConfig = [playwrightPlugin]
+export const playwrightConfig = [playwrightPlugin]
 
-export default playwrightConfig
+/**
+ * Playwright testing configuration
+ *
+ * @param {import("@eslint/config-helpers").ConfigWithExtends} [config] - Additional config
+ * @returns {import("@eslint/config-helpers").ConfigWithExtends} ESLint config
+ */
+export function playwright(config) {
+    return {
+        extends: [...playwrightConfig, ...(config?.extends ?? [])],
+        files: [
+            "**/*.test.js",
+            "**/*.test.ts",
+            "**/*.spec.js",
+            "**/*.spec.ts",
+            "**/*.unit.test.js",
+            "**/*.unit.test.ts",
+            "**/*.int.test.js",
+            "**/*.int.test.ts",
+            "**/*.integration.test.js",
+            "**/*.integration.test.ts",
+        ],
+        ...config,
+    }
+}

package/src/eslint/configs/playwright.test.js

@@ -1,9 +1,9 @@
 import { ESLint } from "eslint"
 
-import config from "./playwright.js"
+import { playwrightConfig } from "./playwright.js"
 
 const eslint = new ESLint({
-    overrideConfig: config,
+    overrideConfig: playwrightConfig,
     overrideConfigFile: true,
 })
 
@@ -12,6 +12,6 @@ describe("playwright", () => {
         const results = await eslint.lintText("const x = 1\n", { filePath: "test.spec.ts" })
 
         expect(results).toBeDefined()
-        expect(results[0].fatalErrorCount).toBe(0)
+        expect(results[0]?.fatalErrorCount).toBe(0)
     })
 })

package/src/eslint/configs/react.js

@@ -1,6 +1,18 @@
-import reactPlugin from "../plugins/react.js"
-import reactHooksPlugin from "../plugins/react-hooks.js"
+import { react as reactPlugin } from "../plugins/react.js"
+import { reactHooks as reactHooksPlugin } from "../plugins/react-hooks.js"
 
-const reactConfig = [reactPlugin, reactHooksPlugin]
+export const reactConfig = [reactPlugin, reactHooksPlugin]
 
-export default reactConfig
+/**
+ * React framework configuration
+ *
+ * @param {import("@eslint/config-helpers").ConfigWithExtends} [config] - Additional config
+ * @returns {import("@eslint/config-helpers").ConfigWithExtends} ESLint config
+ */
+export function react(config) {
+    return {
+        extends: [...reactConfig, ...(config?.extends ?? [])],
+        files: ["**/*.jsx", "**/*.tsx"],
+        ...config,
+    }
+}

package/src/eslint/configs/react.test.js

@@ -1,9 +1,9 @@
 import { ESLint } from "eslint"
 
-import config from "./react.js"
+import { reactConfig } from "./react.js"
 
 const eslint = new ESLint({
-    overrideConfig: config,
+    overrideConfig: reactConfig,
     overrideConfigFile: true,
 })
 
@@ -12,6 +12,6 @@ describe("react", () => {
         const results = await eslint.lintText("const x = 1\n", { filePath: "test.tsx" })
 
         expect(results).toBeDefined()
-        expect(results[0].fatalErrorCount).toBe(0)
+        expect(results[0]?.fatalErrorCount).toBe(0)
     })
 })

package/src/eslint/configs/storybook.js

@@ -1,6 +1,6 @@
-import storybookPlugin from "../plugins/storybook.js"
+import { storybook as storybookPlugin } from "../plugins/storybook.js"
 
-const storybookConfig = [
+export const storybookConfig = [
     storybookPlugin,
     {
         rules: {
@@ -13,4 +13,16 @@ const storybookConfig = [
     },
 ]
 
-export default storybookConfig
+/**
+ * Storybook ESLint configuration with relaxed rules for story files
+ *
+ * @param {import("@eslint/config-helpers").ConfigWithExtends} [config] - Additional config
+ * @returns {import("@eslint/config-helpers").ConfigWithExtends} ESLint config
+ */
+export function storybook(config) {
+    return {
+        extends: [...storybookConfig, ...(config?.extends ?? [])],
+        files: ["**/*.stories.js", "**/*.stories.ts", "**/*.stories.jsx", "**/*.stories.tsx"],
+        ...config,
+    }
+}

package/src/eslint/configs/storybook.test.js

@@ -1,9 +1,9 @@
 import { ESLint } from "eslint"
 
-import config from "./storybook.js"
+import { storybookConfig } from "./storybook.js"
 
 const eslint = new ESLint({
-    overrideConfig: config,
+    overrideConfig: storybookConfig,
     overrideConfigFile: true,
 })
 
@@ -12,6 +12,6 @@ describe("storybook", () => {
         const results = await eslint.lintText("const x = 1\n", { filePath: "test.stories.tsx" })
 
         expect(results).toBeDefined()
-        expect(results[0].fatalErrorCount).toBe(0)
+        expect(results[0]?.fatalErrorCount).toBe(0)
     })
 })

package/src/eslint/configs/typescript-strict.js

@@ -1,6 +1,6 @@
 import typescriptEslint from "typescript-eslint"
 
-const typescriptStrictConfig = [
+export const typescriptStrictConfig = [
     {
         plugins: {
             "@typescript-eslint": typescriptEslint.plugin,
@@ -29,4 +29,16 @@ const typescriptStrictConfig = [
     },
 ]
 
-export default typescriptStrictConfig
+/**
+ * Strict TypeScript ESLint configuration with additional safety rules
+ *
+ * @param {import("@eslint/config-helpers").ConfigWithExtends} [config] - Additional config
+ * @returns {import("@eslint/config-helpers").ConfigWithExtends} ESLint config
+ */
+export function typescriptStrict(config) {
+    return {
+        extends: [...typescriptStrictConfig, ...(config?.extends ?? [])],
+        files: ["**/*.ts", "**/*.tsx", "**/*.cts", "**/*.mts"],
+        ...config,
+    }
+}

package/src/eslint/configs/typescript-strict.test.js

@@ -1,17 +1,19 @@
 import { ESLint } from "eslint"
 
-import config from "./typescript-strict.js"
+import { typescriptStrictConfig } from "./typescript-strict.js"
 
 const eslint = new ESLint({
-    overrideConfig: config,
+    overrideConfig: typescriptStrictConfig,
     overrideConfigFile: true,
 })
 
 describe("typescript-strict", () => {
     test("loads without errors", async () => {
-        const results = await eslint.lintText("const x: number = 1\n", { filePath: "test.ts" })
+        const results = await eslint.lintText("const x: number = 1\n", {
+            filePath: "src/eslint/configs/typescript-strict.test.ts",
+        })
 
         expect(results).toBeDefined()
-        expect(results[0].fatalErrorCount).toBe(0)
+        expect(results[0]?.fatalErrorCount).toBe(0)
     })
 })

package/src/eslint/configs/typescript.js

@@ -1,6 +1,39 @@
-import typescriptEslintPlugin from "../plugins/typescript-eslint.js"
-import typescriptSortKeysPlugin from "../plugins/typescript-sort-keys.js"
+import tseslint from "typescript-eslint"
 
-const typescriptConfig = [typescriptEslintPlugin, typescriptSortKeysPlugin]
+import { typescriptEslint } from "../plugins/typescript-eslint.js"
+import { typescriptSortKeys } from "../plugins/typescript-sort-keys.js"
 
-export default typescriptConfig
+export const typescriptConfig = [
+    {
+        files: ["**/*.js", "**/*.ts", "**/*.tsx", "**/*.cjs"],
+        languageOptions: {
+            parser: tseslint.parser,
+            parserOptions: {
+                ecmaVersion: 2024,
+                project: "./tsconfig.json",
+            },
+        },
+    },
+    {
+        files: ["**/*.ts", "**/*.tsx"],
+        ...typescriptEslint,
+    },
+    {
+        files: ["**/*.ts", "**/*.tsx"],
+        ...typescriptSortKeys,
+    },
+]
+
+/**
+ * TypeScript ESLint configuration with parser setup and rules
+ *
+ * @param {import("@eslint/config-helpers").ConfigWithExtends} [config] - Additional config
+ * @returns {import("@eslint/config-helpers").ConfigWithExtends} ESLint config
+ */
+export function typescript(config) {
+    return {
+        extends: [...typescriptConfig, ...(config?.extends ?? [])],
+        files: ["**/*.js", "**/*.ts", "**/*.tsx", "**/*.cjs", "**/*.cts", "**/*.mts"],
+        ...config,
+    }
+}

package/src/eslint/configs/typescript.test.js

@@ -1,17 +1,19 @@
 import { ESLint } from "eslint"
 
-import config from "./typescript.js"
+import { typescriptConfig } from "./typescript.js"
 
 const eslint = new ESLint({
-    overrideConfig: config,
+    overrideConfig: typescriptConfig,
     overrideConfigFile: true,
 })
 
 describe("typescript", () => {
     test("loads without errors", async () => {
-        const results = await eslint.lintText("const x: number = 1\n", { filePath: "test.ts" })
+        const results = await eslint.lintText("const x = 1\n", {
+            filePath: "src/eslint/configs/typescript.test.js",
+        })
 
         expect(results).toBeDefined()
-        expect(results[0].fatalErrorCount).toBe(0)
+        expect(results[0]?.fatalErrorCount).toBe(0)
     })
 })

package/src/eslint/configs/vitest.js

@@ -1,5 +1,28 @@
-import vitestPlugin from "../plugins/vitest.js"
+import { vitest as vitestPlugin } from "../plugins/vitest.js"
 
-const vitestConfig = [vitestPlugin]
+export const vitestConfig = [vitestPlugin]
 
-export default vitestConfig
+/**
+ * Vitest testing framework configuration
+ *
+ * @param {import("@eslint/config-helpers").ConfigWithExtends} [config] - Additional config
+ * @returns {import("@eslint/config-helpers").ConfigWithExtends} ESLint config
+ */
+export function vitest(config) {
+    return {
+        extends: [...vitestConfig, ...(config?.extends ?? [])],
+        files: [
+            "**/*.test.js",
+            "**/*.test.ts",
+            "**/*.spec.js",
+            "**/*.spec.ts",
+            "**/*.unit.test.js",
+            "**/*.unit.test.ts",
+            "**/*.int.test.js",
+            "**/*.int.test.ts",
+            "**/*.integration.test.js",
+            "**/*.integration.test.ts",
+        ],
+        ...config,
+    }
+}

package/src/eslint/configs/vitest.test.js

@@ -1,9 +1,9 @@
 import { ESLint } from "eslint"
 
-import config from "./vitest.js"
+import { vitestConfig } from "./vitest.js"
 
 const eslint = new ESLint({
-    overrideConfig: config,
+    overrideConfig: vitestConfig,
     overrideConfigFile: true,
 })
 
@@ -12,6 +12,6 @@ describe("vitest", () => {
         const results = await eslint.lintText("const x = 1\n", { filePath: "test.test.ts" })
 
         expect(results).toBeDefined()
-        expect(results[0].fatalErrorCount).toBe(0)
+        expect(results[0]?.fatalErrorCount).toBe(0)
     })
 })

package/src/eslint/index.js

@@ -0,0 +1,25 @@
+// @ts-nocheck
+import { defineConfig, globalIgnores } from "eslint/config"
+
+/**
+ * Custom wrapper for ESLint defineConfig with simplified API
+ *
+ * @param {string[]} ignores - Paths to ignore
+ * @param {Array} configs - Array of ESLint config objects
+ * @returns {Array} ESLint configuration
+ */
+export function customDefineConfig(ignores, configs = []) {
+    return defineConfig(globalIgnores(["node_modules", ...ignores]), ...configs)
+}
+
+export * from "./configs/core.js"
+export * from "./configs/jest.js"
+export * from "./configs/mobx.js"
+export * from "./configs/next.js"
+export * from "./configs/node.js"
+export * from "./configs/playwright.js"
+export * from "./configs/react.js"
+export * from "./configs/storybook.js"
+export * from "./configs/typescript.js"
+export * from "./configs/typescript-strict.js"
+export * from "./configs/vitest.js"

package/src/eslint/plugins/dvukovic.js

@@ -0,0 +1,15 @@
+import { noCommentedOutCode } from "../rules/no-commented-out-code/no-commented-out-code.js"
+
+/** @type {import("@eslint/config-helpers").Config} */
+export const dvukovic = {
+    plugins: {
+        dvukovic: {
+            rules: {
+                "no-commented-out-code": noCommentedOutCode,
+            },
+        },
+    },
+    rules: {
+        "dvukovic/no-commented-out-code": "error",
+    },
+}

package/src/eslint/plugins/es-x.js

@@ -1,10 +1,11 @@
-import esX from "eslint-plugin-es-x"
+import plugin from "eslint-plugin-es-x"
 
-const plugin = {
+/** @type {import("@eslint/config-helpers").Config} */
+export const esX = {
     plugins: {
-        "es-x": esX,
+        "es-x": plugin,
+    },
+    rules: {
+        ...plugin.configs["flat/restrict-to-es2022"].rules,
     },
-    rules: {},
 }
-
-export default plugin

package/src/eslint/plugins/eslint-comments.js

@@ -1,8 +1,9 @@
-import eslintComments from "@eslint-community/eslint-plugin-eslint-comments"
+import plugin from "@eslint-community/eslint-plugin-eslint-comments"
 
-const plugin = {
+/** @type {import("@eslint/config-helpers").Config} */
+export const eslintComments = {
     plugins: {
-        "@eslint-community/eslint-comments": eslintComments,
+        "@eslint-community/eslint-comments": plugin,
     },
     rules: {
         "@eslint-community/eslint-comments/no-aggregating-enable": "error",
@@ -13,5 +14,3 @@ const plugin = {
         "@eslint-community/eslint-comments/require-description": "error",
     },
 }
-
-export default plugin

package/src/eslint/plugins/eslint.js

@@ -1,6 +1,7 @@
 import globals from "globals"
 
-const plugin = {
+/** @type {import("@eslint/config-helpers").Config} */
+export const eslint = {
     languageOptions: {
         ecmaVersion: 2024,
         globals: {
@@ -101,6 +102,13 @@ const plugin = {
         "no-proto": "error",
         "no-prototype-builtins": "error",
         "no-regex-spaces": "error",
+        "no-restricted-syntax": [
+            "error",
+            {
+                message: "Use union types or const objects instead of enums.",
+                selector: "TSEnumDeclaration",
+            },
+        ],
         "no-return-assign": "error",
         "no-script-url": "error",
         "no-self-assign": "error",
@@ -166,5 +174,3 @@ const plugin = {
         yoda: "error",
     },
 }
-
-export default plugin

package/src/eslint/plugins/eslint.test.js

@@ -0,0 +1,42 @@
+import { ESLint } from "eslint"
+import tseslint from "typescript-eslint"
+
+import { eslint as base } from "./eslint.js"
+
+const eslint = new ESLint({
+    overrideConfig: [
+        {
+            files: ["**/*.ts"],
+            languageOptions: {
+                parser: tseslint.parser,
+            },
+        },
+        base,
+    ],
+    overrideConfigFile: true,
+})
+
+describe("eslint no-enum", () => {
+    test("detects enum declarations", async () => {
+        const code = `enum Status { Active, Inactive }\n`
+        const results = await eslint.lintText(code, { filePath: "test.ts" })
+
+        const enumErrors = results[0]?.messages.filter((message) => {
+            return message.ruleId === "no-restricted-syntax"
+        })
+
+        expect(enumErrors?.length).toBe(1)
+        expect(enumErrors?.[0]?.message).toContain("enum")
+    })
+
+    test("allows union types", async () => {
+        const code = `type Status = "active" | "inactive"\n`
+        const results = await eslint.lintText(code, { filePath: "test.ts" })
+
+        const restrictedSyntaxErrors = results?.[0]?.messages.filter((message) => {
+            return message.ruleId === "no-restricted-syntax"
+        })
+
+        expect(restrictedSyntaxErrors?.length).toBe(0)
+    })
+})

package/src/eslint/plugins/import-x.js

@@ -1,8 +1,9 @@
-import importXPlugin from "eslint-plugin-import-x"
+import plugin from "eslint-plugin-import-x"
 
-const plugin = {
+/** @type {import("@eslint/config-helpers").Config} */
+export const importX = {
     plugins: {
-        "import-x": importXPlugin,
+        "import-x": plugin,
     },
     rules: {
         "import-x/default": "error",
@@ -33,5 +34,3 @@ const plugin = {
         "import-x/no-useless-path-segments": "error",
     },
 }
-
-export default plugin

package/src/eslint/plugins/jest.js

@@ -1,8 +1,9 @@
-import jest from "eslint-plugin-jest"
+import plugin from "eslint-plugin-jest"
 
-const plugin = {
+/** @type {import("@eslint/config-helpers").Config} */
+export const jest = {
     plugins: {
-        jest,
+        jest: plugin,
     },
     rules: {
         "jest/consistent-test-it": ["error", { fn: "test", withinDescribe: "test" }],
@@ -60,5 +61,3 @@ const plugin = {
         "jest/valid-title": "error",
     },
 }
-
-export default plugin

package/src/eslint/plugins/mobx.js

@@ -1,8 +1,9 @@
-import mobx from "eslint-plugin-mobx"
+import plugin from "eslint-plugin-mobx"
 
-const plugin = {
+/** @type {import("@eslint/config-helpers").Config} */
+export const mobx = {
     plugins: {
-        mobx,
+        mobx: plugin,
     },
     rules: {
         "mobx/exhaustive-make-observable": "error",
@@ -10,5 +11,3 @@ const plugin = {
         "mobx/unconditional-make-observable": "error",
     },
 }
-
-export default plugin

package/src/eslint/plugins/n.js

@@ -1,8 +1,9 @@
-import pluginNode from "eslint-plugin-n"
+import plugin from "eslint-plugin-n"
 
-const plugin = {
+/** @type {import("@eslint/config-helpers").Config} */
+export const nodeN = {
     plugins: {
-        n: pluginNode,
+        n: plugin,
     },
     rules: {
         "n/callback-return": "error",
@@ -37,5 +38,3 @@ const plugin = {
         "n/prefer-promises/fs": "error",
     },
 }
-
-export default plugin

package/src/eslint/plugins/next.js

@@ -1,8 +1,9 @@
-import next from "@next/eslint-plugin-next"
+import plugin from "@next/eslint-plugin-next"
 
-const plugin = {
+/** @type {import("@eslint/config-helpers").Config} */
+export const next = {
     plugins: {
-        "@next/next": next,
+        "@next/next": plugin,
     },
     rules: {
         "@next/next/google-font-display": "error",
@@ -28,5 +29,3 @@ const plugin = {
         "@next/next/no-unwanted-polyfillio": "error",
     },
 }
-
-export default plugin

package/src/eslint/plugins/playwright.js

@@ -1,8 +1,9 @@
-import playwright from "eslint-plugin-playwright"
+import plugin from "eslint-plugin-playwright"
 
-const plugin = {
+/** @type {import("@eslint/config-helpers").Config} */
+export const playwright = {
     plugins: {
-        playwright,
+        playwright: plugin,
     },
     rules: {
         "playwright/expect-expect": "error",
@@ -56,5 +57,3 @@ const plugin = {
         "playwright/valid-title": "error",
     },
 }
-
-export default plugin

package/src/eslint/plugins/promise.js

@@ -1,8 +1,9 @@
-import promise from "eslint-plugin-promise"
+import plugin from "eslint-plugin-promise"
 
-const plugin = {
+/** @type {import("@eslint/config-helpers").Config} */
+export const promise = {
     plugins: {
-        promise,
+        promise: plugin,
     },
     rules: {
         "promise/always-return": "error",
@@ -18,5 +19,3 @@ const plugin = {
         "promise/valid-params": "error",
     },
 }
-
-export default plugin

package/src/eslint/plugins/react-hooks.js

@@ -1,12 +1,11 @@
-import reactHooks from "eslint-plugin-react-hooks"
+import plugin from "eslint-plugin-react-hooks"
 
-const plugin = {
+/** @type {import("@eslint/config-helpers").Config} */
+export const reactHooks = {
     plugins: {
-        "react-hooks": reactHooks,
+        "react-hooks": plugin,
     },
     rules: {
         "react-hooks/rules-of-hooks": "error",
     },
 }
-
-export default plugin

package/src/eslint/plugins/react.js

@@ -1,8 +1,9 @@
-import react from "eslint-plugin-react"
+import plugin from "eslint-plugin-react"
 
-const plugin = {
+/** @type {import("@eslint/config-helpers").Config} */
+export const react = {
     plugins: {
-        react,
+        react: plugin,
     },
     rules: {
         "react/boolean-prop-naming": "error",
@@ -106,5 +107,3 @@ const plugin = {
         },
     },
 }
-
-export default plugin

package/src/eslint/plugins/rimac.js

@@ -1,13 +1,12 @@
-import rimac from "@rimac-technology/eslint-plugin"
+import plugin from "@rimac-technology/eslint-plugin"
 
-const plugin = {
+/** @type {import("@eslint/config-helpers").Config} */
+export const rimac = {
     plugins: {
-        "@rimac-technology": rimac,
+        "@rimac-technology": plugin,
     },
     rules: {
         "@rimac-technology/class-element-sorting": "error",
         "@rimac-technology/document-todos": ["error", { url: "http" }],
     },
 }
-
-export default plugin