@wowlab/eslint-config 0.1.2 → 0.2.0

package/README.md

@@ -7,7 +7,7 @@ Composable ESLint flat configs for JavaScript and TypeScript
 ## Getting started
 
 ```console
-pnpm add --save-dev @wowlab/eslint-config eslint typescript
+pnpm add --save-dev @wowlab/eslint-config eslint@10 typescript@6.0
 ```
 
 ```js
@@ -38,12 +38,17 @@ export default createConfig({
 
 `createConfig` includes the base rules. Consumer rules and overrides are applied last.
 
+Requires ESLint 10.4 or newer within version 10 and TypeScript 5.6 through 6.0.
+Runtime dependencies use exact versions so plugin updates are tested before release.
+Transitive dependencies can still update; commit your project's lockfile and generate
+it using the same pnpm release-age policy as CI.
+
 ## Presets
 
 - `deno` adds Deno globals.
 - `next` adds the Next.js Core Web Vitals rules.
 - `node` adds Node.js globals.
-- `react` adds React rules for JavaScript. Set `typescript: true` to add TypeScript support or `typeChecked: true` to add TypeScript and type-aware rules together.
+- `react` adds React rules for JavaScript. Set `typescript: true` to add TypeScript support or `typeChecked: true` to add type-aware React and TypeScript rules. Set `typescriptTypeChecked: false` when only the React rules need type information.
 - `tanstackQuery` adds TanStack Query rules.
 - `typescript` adds TypeScript rules, optionally using the project service.
 

package/dist/core/base.js

@@ -4,6 +4,7 @@ import sonarjs from "eslint-plugin-sonarjs";
 import switchCase from "eslint-plugin-switch-case";
 import unicorn from "eslint-plugin-unicorn";
 import { perfectionistConfig } from "./perfectionist.js";
+import { wowlabPlugin } from "./plugin.js";
 import { stylisticConfig } from "./stylistic.js";
 const ruleOverrides = {
     "@eslint-community/eslint-comments/disable-enable-pair": [
@@ -37,6 +38,11 @@ export function createBaseConfig({ internalPatterns = [], } = {}) {
             name: "wowlab/javascript",
         },
         perfectionistConfig(internalPatterns),
+        {
+            name: "wowlab/layout",
+            plugins: { wowlab: wowlabPlugin },
+            rules: { "wowlab/function-padding": "error" },
+        },
         stylisticConfig,
         {
             name: "wowlab/switch-case",
@@ -49,7 +55,7 @@ export function createBaseConfig({ internalPatterns = [], } = {}) {
                 ],
             },
         },
-        unicorn.configs["flat/recommended"],
+        unicorn.configs.recommended,
         sonarjs.configs.recommended,
         comments.recommended,
         { name: "wowlab/rule-defaults", rules: ruleOverrides },

package/dist/core/perfectionist.js

@@ -30,7 +30,14 @@ export function perfectionistConfig(internalPatterns) {
         rules: {
             curly: ["error", "all"],
             "perfectionist/sort-array-includes": "warn",
-            "perfectionist/sort-classes": ["warn", { groups: CLASS_GROUPS }],
+            "perfectionist/sort-classes": [
+                "warn",
+                {
+                    groups: CLASS_GROUPS,
+                    newlinesBetween: "ignore",
+                    newlinesInside: "ignore",
+                },
+            ],
             "perfectionist/sort-decorators": "warn",
             "perfectionist/sort-enums": ["warn", { partitionByComment: true }],
             "perfectionist/sort-exports": "warn",
@@ -39,7 +46,13 @@ export function perfectionistConfig(internalPatterns) {
             "perfectionist/sort-interfaces": "warn",
             "perfectionist/sort-intersection-types": "warn",
             "perfectionist/sort-maps": ["warn", { partitionByComment: true }],
-            "perfectionist/sort-modules": "warn",
+            "perfectionist/sort-modules": [
+                "warn",
+                {
+                    newlinesBetween: "ignore",
+                    newlinesInside: "ignore",
+                },
+            ],
             "perfectionist/sort-named-exports": "warn",
             "perfectionist/sort-named-imports": "warn",
             "perfectionist/sort-objects": ["warn", { partitionByComment: true }],

package/dist/core/plugin.d.ts

@@ -0,0 +1,2 @@
+import type { ESLint } from "eslint";
+export declare const wowlabPlugin: ESLint.Plugin;

package/dist/core/plugin.js

@@ -0,0 +1,6 @@
+import { functionPadding } from "./rules/function-padding.js";
+export const wowlabPlugin = {
+    rules: {
+        "function-padding": functionPadding,
+    },
+};

package/dist/core/rules/function-padding.d.ts

@@ -0,0 +1,2 @@
+import type { Rule } from "eslint";
+export declare const functionPadding: Rule.RuleModule;

package/dist/core/rules/function-padding.js

@@ -0,0 +1,81 @@
+function functionDeclaration(statement) {
+    const declaration = statement.type === "ExportDefaultDeclaration" ||
+        statement.type === "ExportNamedDeclaration"
+        ? statement.declaration
+        : statement;
+    if (!declaration ||
+        (declaration.type !== "FunctionDeclaration" &&
+            declaration.type !== "TSDeclareFunction")) {
+        return null;
+    }
+    return {
+        implementation: declaration.type === "FunctionDeclaration" && declaration.body != null,
+        name: declaration.id?.name,
+    };
+}
+function isSameOverloadGroup(current, previous) {
+    return (!previous.implementation &&
+        current.name != null &&
+        current.name === previous.name);
+}
+export const functionPadding = {
+    create(context) {
+        const sourceCode = context.sourceCode;
+        function firstAttachedLine(current, previous) {
+            let startLine = current.loc?.start.line ?? 0;
+            const comments = sourceCode.getCommentsBefore(current);
+            for (let index = comments.length - 1; index >= 0; index -= 1) {
+                const comment = comments[index];
+                if (!comment?.loc ||
+                    comment.loc.start.line <= (previous.loc?.end.line ?? 0) ||
+                    startLine > comment.loc.end.line + 1) {
+                    break;
+                }
+                startLine = comment.loc.start.line;
+            }
+            return startLine;
+        }
+        function checkStatements(statements) {
+            for (let index = 1; index < statements.length; index += 1) {
+                const current = statements[index];
+                const previous = statements[index - 1];
+                if (!current || !previous || !current.loc || !previous.loc) {
+                    continue;
+                }
+                const currentFunction = functionDeclaration(current);
+                const previousFunction = functionDeclaration(previous);
+                const startLine = firstAttachedLine(current, previous);
+                if (!currentFunction ||
+                    !previousFunction ||
+                    isSameOverloadGroup(currentFunction, previousFunction) ||
+                    startLine > previous.loc.end.line + 1) {
+                    continue;
+                }
+                const lineStart = sourceCode.text.lastIndexOf("\n", sourceCode.getIndexFromLoc({ column: 0, line: startLine }) - 1);
+                context.report({
+                    fix: (fixer) => fixer.insertTextBeforeRange([lineStart + 1, lineStart + 1], "\n"),
+                    messageId: "expected",
+                    node: current,
+                });
+            }
+        }
+        return {
+            BlockStatement: (node) => checkStatements(node.body),
+            Program: (node) => checkStatements(node.body),
+            StaticBlock: (node) => checkStatements(node.body),
+            SwitchCase: (node) => checkStatements(node.consequent),
+            TSModuleBlock: (node) => checkStatements(node.body),
+        };
+    },
+    meta: {
+        docs: {
+            description: "Require blank lines around function declaration groups",
+        },
+        fixable: "whitespace",
+        messages: {
+            expected: "Expected a blank line around the function declaration.",
+        },
+        schema: [],
+        type: "layout",
+    },
+};

package/dist/core/stylistic.js

@@ -68,7 +68,7 @@ const structuralRules = {
         { blankLine: "always", next: "*", prev: ["if", "for", "while", "switch", "try", "function", "class"] },
         { blankLine: "always", next: "block-like", prev: "block-like" },
         { blankLine: "always", next: "export", prev: "*" },
-        { blankLine: "any", next: "function", prev: "function" },
+        { blankLine: "any", next: ["function", "function-overload"], prev: ["function", "function-overload"] },
         { blankLine: "any", next: "export", prev: "export" },
     ],
     "@stylistic/quotes": [

package/dist/presets/react.d.ts

@@ -5,5 +5,6 @@ export interface ReactOptions extends FilesOptions {
     typeChecked?: boolean;
     typescript?: boolean;
     typescriptFiles?: string[];
+    typescriptTypeChecked?: boolean;
 }
-export declare function react({ files, tsconfigRootDir, typeChecked, typescript, typescriptFiles, }?: ReactOptions): Linter.Config[];
+export declare function react({ files, tsconfigRootDir, typeChecked, typescript, typescriptFiles, typescriptTypeChecked, }?: ReactOptions): Linter.Config[];

package/dist/presets/react.js

@@ -3,7 +3,7 @@ import reactHooks from "eslint-plugin-react-hooks";
 import { typescript as typescriptPreset } from "./typescript.js";
 const JAVASCRIPT_FILES = ["**/*.{js,jsx,mjs,cjs}"];
 const TYPESCRIPT_FILES = ["**/*.{ts,tsx,mts,cts}"];
-export function react({ files = JAVASCRIPT_FILES, tsconfigRootDir, typeChecked = false, typescript = false, typescriptFiles = TYPESCRIPT_FILES, } = {}) {
+export function react({ files = JAVASCRIPT_FILES, tsconfigRootDir, typeChecked = false, typescript = false, typescriptFiles = TYPESCRIPT_FILES, typescriptTypeChecked = typeChecked, } = {}) {
     const typescriptConfigName = typeChecked
         ? "recommended-type-checked"
         : "recommended";
@@ -35,8 +35,22 @@ export function react({ files = JAVASCRIPT_FILES, tsconfigRootDir, typeChecked =
         ...typescriptPreset({
             files: typescriptFiles,
             tsconfigRootDir,
-            typeChecked,
+            typeChecked: typescriptTypeChecked,
         }),
+        ...(typeChecked && !typescriptTypeChecked
+            ? [
+                {
+                    files: typescriptFiles,
+                    languageOptions: {
+                        parserOptions: {
+                            projectService: true,
+                            ...(tsconfigRootDir && { tsconfigRootDir }),
+                        },
+                    },
+                    name: "wowlab/react/typescript/project-service",
+                },
+            ]
+            : []),
         {
             ...typescriptConfig,
             files: typescriptFiles,

package/dist/presets/typescript.js

@@ -8,15 +8,15 @@ export function typescript({ files = ["**/*.{ts,tsx,mts,cts}"], tsconfigRootDir,
             ? {
                 ...config.languageOptions,
                 parserOptions: {
-                    ...(typeChecked ? { projectService: true } : {}),
-                    ...(tsconfigRootDir ? { tsconfigRootDir } : {}),
+                    ...(typeChecked && { projectService: true }),
+                    ...(tsconfigRootDir && { tsconfigRootDir }),
                 },
             }
             : undefined;
         return {
             ...config,
             files,
-            ...(languageOptions ? { languageOptions } : {}),
+            ...(languageOptions && { languageOptions }),
             name: config.name?.replace("typescript-eslint/", "wowlab/typescript/"),
         };
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wowlab/eslint-config",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "description": "Composable ESLint flat configs for JavaScript and TypeScript",
   "license": "MIT",
   "type": "module",
@@ -37,23 +37,23 @@
     "access": "public"
   },
   "peerDependencies": {
-    "eslint": "^10.0.0",
-    "typescript": ">=4.8.4 <6.1.0"
+    "eslint": "^10.4.0",
+    "typescript": ">=5.6.0 <6.1.0"
   },
   "dependencies": {
-    "@eslint-community/eslint-plugin-eslint-comments": "^4.7.2",
-    "@eslint-react/eslint-plugin": "^5.8.6",
-    "@eslint/config-helpers": "^0.7.0",
-    "@eslint/js": "^10.0.1",
-    "@next/eslint-plugin-next": "16.2.9",
-    "@stylistic/eslint-plugin": "^5.10.0",
-    "@tanstack/eslint-plugin-query": "^5.100.14",
-    "eslint-plugin-perfectionist": "^5.9.0",
-    "eslint-plugin-react-hooks": "^7.1.1",
-    "eslint-plugin-sonarjs": "^4.0.3",
-    "eslint-plugin-switch-case": "^4.0.0",
-    "eslint-plugin-unicorn": "^64.0.0",
-    "globals": "^17.6.0",
-    "typescript-eslint": "8.68.0"
+    "@eslint-community/eslint-plugin-eslint-comments": "4.8.1",
+    "@eslint-react/eslint-plugin": "5.28.8",
+    "@eslint/config-helpers": "0.7.0",
+    "@eslint/js": "10.0.1",
+    "@next/eslint-plugin-next": "16.4.5",
+    "@stylistic/eslint-plugin": "5.10.0",
+    "@tanstack/eslint-plugin-query": "5.107.1",
+    "eslint-plugin-perfectionist": "5.13.0",
+    "eslint-plugin-react-hooks": "7.1.1",
+    "eslint-plugin-sonarjs": "4.2.2",
+    "eslint-plugin-switch-case": "4.0.0",
+    "eslint-plugin-unicorn": "79.0.0",
+    "globals": "17.14.0",
+    "typescript-eslint": "8.72.1"
   }
 }