@dvukovic/style-guide 0.3.97 → 0.3.98

package/README.md

@@ -1,187 +1,121 @@
-# Style Guide
+# @dvukovic/style-guide
 
-Linting and formatting configuration for TypeScript/JavaScript projects.
+Personal style guide with ESLint, Prettier, and other code quality tools.
 
 ## Installation
 
 ```bash
-yarn add -D @dvukovic/style-guide eslint prettier cspell stylelint npm-package-json-lint
+yarn add -D @dvukovic/style-guide eslint prettier cspell stylelint
 ```
 
-## Setup
-
-Add these scripts to your `package.json`:
-
-```json
-{
-    "scripts": {
-        "lint": "yarn lint:eslint && yarn lint:prettier && yarn lint:stylelint && yarn lint:spell && yarn lint:package-json",
-        "lint:eslint": "eslint . --cache --concurrency=auto",
-        "lint:fix": "yarn lint:eslint --fix && yarn lint:prettier --write && yarn lint:stylelint --fix",
-        "lint:package-json": "npmPkgJsonLint --configFile ./.packagerc.js .",
-        "lint:prettier": "prettier --check --cache '**/*.{json,yaml,yml,md,css,html}'",
-        "lint:spell": "cspell --config ./.cspellrc.js --no-progress --no-summary --unique '**'",
-        "lint:stylelint": "stylelint ./**/*.css --cache"
-    }
-}
-```
+## ESLint Configuration
 
-Add to `.gitignore`:
+### Basic Usage
 
-```
-.eslintcache
-.stylelintcache
-```
+Create an `eslint.config.js` file in your project root:
 
----
-
-## ESLint
-
-Prettier is integrated into ESLint via `eslint-plugin-prettier` for JS/TS files. The separate
-`lint:prettier` script handles JSON, YAML, MD, and other files.
-
-Create `eslint.config.js`:
-
-```javascript
-import tseslint from "typescript-eslint"
-
-import core from "@dvukovic/style-guide/src/eslint/configs/core.js"
-import jest from "@dvukovic/style-guide/src/eslint/configs/jest.js"
-import mobx from "@dvukovic/style-guide/src/eslint/configs/mobx.js"
-import next from "@dvukovic/style-guide/src/eslint/configs/next.js"
-import node from "@dvukovic/style-guide/src/eslint/configs/node.js"
-import playwright from "@dvukovic/style-guide/src/eslint/configs/playwright.js"
-import react from "@dvukovic/style-guide/src/eslint/configs/react.js"
-import storybook from "@dvukovic/style-guide/src/eslint/configs/storybook.js"
-import typescript from "@dvukovic/style-guide/src/eslint/configs/typescript.js"
-import typescriptStrict from "@dvukovic/style-guide/src/eslint/configs/typescript-strict.js"
-import vitest from "@dvukovic/style-guide/src/eslint/configs/vitest.js"
-
-export default tseslint.config(
-    { ignores: ["node_modules", ".next", "dist", "build"] },
-    ...core,
-    ...node,
-    ...next,
-    ...mobx,
-    ...react,
-    {
-        languageOptions: {
-            parser: tseslint.parser,
-            parserOptions: {
-                project: "./tsconfig.json",
-            },
-        },
-    },
-    {
-        files: ["**/*.ts", "**/*.tsx"],
-        extends: [...typescript, ...typescriptStrict],
-    },
-    {
-        files: ["**/*.test.ts"],
-        extends: [...jest],
-    },
-    {
-        files: ["**/*.test.ts"],
-        extends: [...vitest],
-    },
-    {
-        files: ["**/*.ui.test.ts"],
-        extends: [...playwright],
-    },
-    {
-        files: ["**/*.stories.ts", "**/*.stories.tsx"],
-        extends: [...storybook],
-    },
-)
+```js
+import { customDefineConfig, core, typescript } from "@dvukovic/style-guide/eslint"
+
+export default customDefineConfig(["dist/**", "build/**"], [core(), typescript()])
 ```
 
 ### Available Configs
 
-| Config              | Description                      |
-| ------------------- | -------------------------------- |
-| `core`              | Base JavaScript rules + Prettier |
-| `node`              | Node.js specific rules           |
-| `react`             | React and JSX rules              |
-| `next`              | Next.js specific rules           |
-| `mobx`              | MobX state management rules      |
-| `typescript`        | TypeScript rules                 |
-| `typescript-strict` | Strict TypeScript rules          |
-| `jest`              | Jest testing rules               |
-| `vitest`            | Vitest testing rules             |
-| `playwright`        | Playwright E2E testing rules     |
-| `storybook`         | Storybook rules                  |
-
----
-
-## Prettier
-
-Create `prettier.config.js`:
-
-```javascript
-import prettierConfig from "@dvukovic/style-guide/src/prettier/configs/core.js"
-
-/** @type {import("prettier").Config} */
-export default {
-    ...prettierConfig,
-}
+Each config is a factory function that returns ESLint configuration:
+
+- `core()` - Essential rules for all JavaScript/TypeScript projects
+- `node()` - Node.js specific rules
+- `react()` - React framework rules
+- `typescript()` - TypeScript parser and rules
+- `typescriptStrict()` - Additional strict TypeScript rules
+- `jest()` - Jest testing framework
+- `vitest()` - Vitest testing framework
+- `playwright()` - Playwright e2e testing
+- `mobx()` - MobX state management
+- `next()` - Next.js framework
+- `storybook()` - Storybook
+
+### Customizing Configs
+
+Each factory function accepts a `config` parameter to extend or override settings:
+
+```js
+import { customDefineConfig, core, typescript } from "@dvukovic/style-guide/eslint"
+
+export default customDefineConfig(
+    [],
+    [
+        core(),
+        typescript({
+            rules: {
+                "@typescript-eslint/no-unused-vars": "warn",
+            },
+        }),
+    ],
+)
 ```
 
----
+### Complete Example
+
+A full-featured project (this is the actual config used by this package):
+
+```js
+import {
+    customDefineConfig,
+    core,
+    node,
+    mobx,
+    react,
+    next,
+    typescript,
+    typescriptStrict,
+    jest,
+    vitest,
+    playwright,
+} from "@dvukovic/style-guide/eslint"
+
+export default customDefineConfig(
+    ["node_modules"],
+    [
+        core(),
+        node(),
+        mobx(),
+        react(),
+        next(),
+        typescript(),
+        typescriptStrict(),
+        jest(),
+        vitest(),
+        playwright(),
+    ],
+)
+```
 
-## Stylelint
+## Prettier Configuration
 
-Create `.stylelintrc.js`:
+```js
+import { prettier } from "@dvukovic/style-guide/prettier"
 
-```javascript
-/** @type {import("stylelint").Config} */
-export default {
-    extends: "@dvukovic/style-guide/src/stylelint/configs/core.js",
-}
+export default prettier
 ```
 
----
-
-## CSpell
-
-Create `.cspellrc.js`:
-
-```javascript
-/** @type {import("cspell").FileSettings} */
-export default {
-    cache: {
-        cacheLocation: "./node_modules/.cache/cspell",
-        useCache: true,
-    },
-    caseSensitive: false,
-    dictionaries: ["shared"],
-    dictionaryDefinitions: [
-        {
-            name: "shared",
-            path: "./node_modules/@dvukovic/style-guide/src/cspell/base.txt",
-        },
-    ],
-    useGitignore: true,
-}
-```
+## Stylelint Configuration
+
+```js
+import { stylelint } from "@dvukovic/style-guide/stylelint"
 
----
+export default stylelint
+```
 
-## Package JSON Lint
+## Package.json Configuration
 
-Create `.packagerc.js`:
+```js
+import { packageJson } from "@dvukovic/style-guide/package-json"
 
-```javascript
-/** @type {import("npm-package-json-lint").NpmPackageJsonLint} */
-export default {
-    extends: "@dvukovic/style-guide/src/package-json/configs/core.js",
-}
+export default packageJson
 ```
 
----
-
-## Requirements
+## License
 
-- Node.js >= 20.0.0
-- ESLint 9+
-- Prettier 3+
-- Stylelint 16+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@dvukovic/style-guide",
-    "version": "0.3.97",
+    "version": "0.3.98",
     "description": "My own style guide",
     "repository": {
         "type": "git",
@@ -21,8 +21,8 @@
     "scripts": {
         "lint": "yarn lint:eslint && yarn lint:prettier && yarn lint:stylelint && yarn lint:spell",
         "lint:eslint": "eslint . --cache --concurrency=auto",
-        "lint:fix": "yarn lint:eslint --fix && yarn lint:prettier --write && yarn lint:stylelint --fix",
-        "lint:prettier": "prettier --check --cache '**/*.{json,yaml,yml,md,css,html}'",
+        "lint:fix": "yarn lint:eslint --fix && yarn lint:prettier --write && yarn lint:stylelint --fix && yarn lint:spell",
+        "lint:prettier": "prettier --check --cache .",
         "lint:spell": "cspell --config ./.cspellrc.js --no-progress --no-summary --unique '**'",
         "lint:stylelint": "stylelint ./**/*.css --cache",
         "release": "release-it",
@@ -30,14 +30,14 @@
     },
     "dependencies": {
         "@eslint-community/eslint-plugin-eslint-comments": "4.5.0",
-        "@next/eslint-plugin-next": "16.0.6",
+        "@eslint/compat": "^2.0.0",
+        "@next/eslint-plugin-next": "16.0.7",
         "@prettier/plugin-xml": "3.4.2",
         "@rimac-technology/eslint-plugin": "1.5.0",
         "@stylistic/eslint-plugin": "5.6.1",
-        "@typescript-eslint/parser": "8.48.0",
+        "@typescript-eslint/parser": "8.48.1",
         "@vitest/eslint-plugin": "1.5.1",
-        "eslint-plugin-es-x": "9.2.0",
-        "eslint-plugin-etc": "2.0.3",
+        "eslint-plugin-es-x": "9.3.0",
         "eslint-plugin-import-x": "4.16.1",
         "eslint-plugin-jest": "29.2.1",
         "eslint-plugin-mobx": "0.0.13",
@@ -51,13 +51,13 @@
         "eslint-plugin-sonarjs": "3.0.5",
         "eslint-plugin-sort-destructure-keys": "2.0.0",
         "eslint-plugin-sort-keys-fix": "1.1.2",
-        "eslint-plugin-storybook": "10.1.2",
+        "eslint-plugin-storybook": "10.1.4",
         "eslint-plugin-typescript-sort-keys": "3.3.0",
         "eslint-plugin-unicorn": "62.0.0",
         "eslint-plugin-unused-imports": "4.3.0",
         "globals": "16.5.0",
         "prettier-plugin-embed": "0.5.0",
-        "prettier-plugin-jsdoc": "1.7.0",
+        "prettier-plugin-jsdoc": "1.8.0",
         "prettier-plugin-packagejson": "2.5.20",
         "prettier-plugin-prisma": "5.0.0",
         "prettier-plugin-sh": "0.18.0",
@@ -66,25 +66,25 @@
         "prettier-plugin-toml": "2.0.6",
         "stylelint-no-unused-selectors": "1.0.40",
         "stylelint-order": "7.0.0",
-        "typescript-eslint": "8.48.0"
+        "typescript-eslint": "8.48.1"
     },
     "devDependencies": {
-        "@storybook/react": "10.1.2",
+        "@storybook/react": "10.1.4",
         "@types/eslint": "9.6.1",
         "@types/jest": "30.0.0",
         "@types/node": "24.10.1",
         "@types/react": "19.2.7",
-        "cspell": "9.3.2",
+        "cspell": "9.4.0",
         "eslint": "9.39.1",
         "jest": "30.2.0",
         "npm-package-json-lint": "9.0.0",
-        "prettier": "3.7.3",
-        "react": "19.2.0",
+        "prettier": "3.7.4",
+        "react": "19.2.1",
         "release-it": "19.0.6",
-        "storybook": "^10.1.2",
+        "storybook": "^10.1.4",
         "stylelint": "16.26.1",
         "typescript": "5.9.3",
-        "vitest": "^4.0.14"
+        "vitest": "^4.0.15"
     },
     "peerDependencies": {
         "cspell": "9",

package/src/cspell/base.txt

@@ -113,3 +113,15 @@ speculationrules
 hrefs
 supabase
 tslog
+pablle
+fkey
+msword
+openxmlformats
+officedocument
+wordprocessingml
+presentationml
+spreadsheetml
+pageleave
+opensearchservice
+httponly
+unthrown

package/src/eslint/configs/core.js

@@ -1,33 +1,45 @@
-import esXPlugin from "../plugins/es-x.js"
-import eslintPlugin from "../plugins/eslint.js"
-import eslintCommentsPlugin from "../plugins/eslint-comments.js"
-import etcPlugin from "../plugins/etc.js"
-import importXPlugin from "../plugins/import-x.js"
-import promisePlugin from "../plugins/promise.js"
-import rimacPlugin from "../plugins/rimac.js"
-import simpleImportSortPlugin from "../plugins/simple-import-sort.js"
-import sonarjsPlugin from "../plugins/sonarjs.js"
-import sortDestructureKeysPlugin from "../plugins/sort-destructure-keys.js"
-import sortKeysFixPlugin from "../plugins/sort-keys-fix.js"
-import stylisticPlugin from "../plugins/stylistic.js"
-import unicornPlugin from "../plugins/unicorn.js"
-import unusedImportsPlugin from "../plugins/unused-imports.js"
+import { dvukovic } from "../plugins/dvukovic.js"
+import { esX } from "../plugins/es-x.js"
+import { eslint } from "../plugins/eslint.js"
+import { eslintComments } from "../plugins/eslint-comments.js"
+import { importX } from "../plugins/import-x.js"
+import { promise } from "../plugins/promise.js"
+import { rimac } from "../plugins/rimac.js"
+import { simpleImportSort } from "../plugins/simple-import-sort.js"
+import { sonarjs } from "../plugins/sonarjs.js"
+import { sortDestructureKeys } from "../plugins/sort-destructure-keys.js"
+import { sortKeysFix } from "../plugins/sort-keys-fix.js"
+import { stylistic } from "../plugins/stylistic.js"
+import { unicorn } from "../plugins/unicorn.js"
+import { unusedImports } from "../plugins/unused-imports.js"
 
-const coreConfig = [
-    eslintPlugin,
-    esXPlugin,
-    eslintCommentsPlugin,
-    promisePlugin,
-    unicornPlugin,
-    unusedImportsPlugin,
-    importXPlugin,
-    sonarjsPlugin,
-    etcPlugin,
-    sortKeysFixPlugin,
-    sortDestructureKeysPlugin,
-    stylisticPlugin,
-    simpleImportSortPlugin,
-    rimacPlugin,
+export const coreConfig = [
+    esX,
+    eslint,
+    eslintComments,
+    importX,
+    promise,
+    rimac,
+    simpleImportSort,
+    sonarjs,
+    sortDestructureKeys,
+    sortKeysFix,
+    stylistic,
+    unicorn,
+    unusedImports,
+    dvukovic,
 ]
 
-export default coreConfig
+/**
+ * Core ESLint configuration with essential rules and plugins
+ *
+ * @param {import("@eslint/config-helpers").ConfigWithExtends} [config] - Additional config
+ * @returns {import("@eslint/config-helpers").ConfigWithExtends} ESLint config
+ */
+export function core(config) {
+    return {
+        extends: [...coreConfig, ...(config?.extends ?? [])],
+        files: ["**/*.js", "**/*.cjs", "**/*.mjs", "**/*.ts", "**/*.tsx"],
+        ...config,
+    }
+}

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

@@ -1,9 +1,9 @@
 import { ESLint } from "eslint"
 
-import config from "./core.js"
+import { coreConfig } from "./core.js"
 
 const eslint = new ESLint({
-    overrideConfig: config,
+    overrideConfig: coreConfig,
     overrideConfigFile: true,
 })
 
@@ -12,12 +12,12 @@ describe("core", () => {
         const results = await eslint.lintText("const x = 1\n", { filePath: "test.js" })
 
         expect(results).toBeDefined()
-        expect(results[0].fatalErrorCount).toBe(0)
+        expect(results[0]?.fatalErrorCount).toBe(0)
     })
 
     test("detects violations", async () => {
         const results = await eslint.lintText("var x = 1\n", { filePath: "test.js" })
 
-        expect(results[0].errorCount).toBeGreaterThan(0)
+        expect(results[0]?.errorCount).toBeGreaterThan(0)
     })
 })

package/src/eslint/configs/jest.js

@@ -1,5 +1,28 @@
-import jestPlugin from "../plugins/jest.js"
+import { jest as jestPlugin } from "../plugins/jest.js"
 
-const jestConfig = [jestPlugin]
+export const jestConfig = [jestPlugin]
 
-export default jestConfig
+/**
+ * Jest testing framework configuration
+ *
+ * @param {import("@eslint/config-helpers").ConfigWithExtends} [config] - Additional config
+ * @returns {import("@eslint/config-helpers").ConfigWithExtends} ESLint config
+ */
+export function jest(config) {
+    return {
+        extends: [...jestConfig, ...(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/jest.test.js

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

package/src/eslint/configs/mobx.js

@@ -1,5 +1,17 @@
-import mobxPlugin from "../plugins/mobx.js"
+import { mobx as mobxPlugin } from "../plugins/mobx.js"
 
-const mobxConfig = [mobxPlugin]
+export const mobxConfig = [mobxPlugin]
 
-export default mobxConfig
+/**
+ * MobX state management configuration
+ *
+ * @param {import("@eslint/config-helpers").ConfigWithExtends} [config] - Additional config
+ * @returns {import("@eslint/config-helpers").ConfigWithExtends} ESLint config
+ */
+export function mobx(config) {
+    return {
+        extends: [...mobxConfig, ...(config?.extends ?? [])],
+        files: ["**/*.js", "**/*.ts", "**/*.jsx", "**/*.tsx"],
+        ...config,
+    }
+}

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

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

package/src/eslint/configs/next.js

@@ -1,5 +1,17 @@
-import nextPlugin from "../plugins/next.js"
+import { next as nextPlugin } from "../plugins/next.js"
 
-const nextConfig = [nextPlugin]
+export const nextConfig = [nextPlugin]
 
-export default nextConfig
+/**
+ * Next.js framework configuration
+ *
+ * @param {import("@eslint/config-helpers").ConfigWithExtends} [config] - Additional config
+ * @returns {import("@eslint/config-helpers").ConfigWithExtends} ESLint config
+ */
+export function next(config) {
+    return {
+        extends: [...nextConfig, ...(config?.extends ?? [])],
+        files: ["**/*.js", "**/*.ts", "**/*.jsx", "**/*.tsx"],
+        ...config,
+    }
+}

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

@@ -1,9 +1,9 @@
 import { ESLint } from "eslint"
 
-import config from "./next.js"
+import { nextConfig } from "./next.js"
 
 const eslint = new ESLint({
-    overrideConfig: config,
+    overrideConfig: nextConfig,
     overrideConfigFile: true,
 })
 
@@ -12,6 +12,6 @@ describe("next", () => {
         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/node.js

@@ -1,6 +1,18 @@
-import nPlugin from "../plugins/n.js"
-import securityNodePlugin from "../plugins/security-node.js"
+import { nodeN } from "../plugins/n.js"
+import { securityNode } from "../plugins/security-node.js"
 
-const nodeConfig = [nPlugin, securityNodePlugin]
+export const nodeConfig = [nodeN, securityNode]
 
-export default nodeConfig
+/**
+ * Node.js ESLint configuration
+ *
+ * @param {import("@eslint/config-helpers").ConfigWithExtends} [config] - Additional config
+ * @returns {import("@eslint/config-helpers").ConfigWithExtends} ESLint config
+ */
+export function node(config) {
+    return {
+        extends: [...nodeConfig, ...(config?.extends ?? [])],
+        files: ["**/*.js", "**/*.cjs", "**/*.mjs", "**/*.ts", "**/*.cts", "**/*.mts"],
+        ...config,
+    }
+}

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

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