@quentinhsu/biome-config 0.1.0

package/README.md

@@ -0,0 +1,138 @@
+# @quentinhsu/biome-config
+
+A modular Biome configuration preset collection built with Rslib. Includes a comprehensive base configuration with framework-specific overlays (React, Next.js, Vue, Nuxt), ultimately generating `biome.jsonc` files in the `dist/` directory that can be directly extended in projects.
+
+## Development
+
+```bash
+pnpm install
+pnpm build
+```
+
+The build process first compiles TypeScript modules to `dist/` via Rslib, then executes `dist/build.mjs` to output each preset as a JSONC file.
+
+## Available Presets
+
+| Preset | Description | Export |
+| --- | --- | --- |
+| `.` (index) | Base configuration with recommended rules | `"extends": ["@quentinhsu/biome-config"]` |
+| `./react` | React-specific rules and overrides | `"extends": ["@quentinhsu/biome-config/react"]` |
+| `./next` | Next.js-specific rules and file exclusions | `"extends": ["@quentinhsu/biome-config/next"]` |
+| `./vue` | Vue-specific rules and configuration | `"extends": ["@quentinhsu/biome-config/vue"]` |
+| `./nuxt` | Nuxt-specific rules and configuration | `"extends": ["@quentinhsu/biome-config/nuxt"]` |
+
+Each preset inherits from and extends the base configuration with framework-specific file patterns, globals, and linter rules.
+
+## Usage
+
+### Installation
+
+Install this package in your project:
+
+```bash
+pnpm add -D @quentinhsu/biome-config
+```
+
+### Basic Setup
+
+Create or update your `biome.json` (or `biome.jsonc`) file to use the base configuration:
+
+```json
+{
+  "extends": ["@quentinhsu/biome-config"]
+}
+```
+
+### Framework-Specific Configuration
+
+#### React Projects
+
+```json
+{
+  "extends": ["@quentinhsu/biome-config/react"]
+}
+```
+
+The React preset includes:
+- Fragment syntax enforcement
+- JSX quote style configuration
+- Test file rule overrides
+- Storybook exclusion
+
+#### Next.js Projects
+
+```json
+{
+  "extends": ["@quentinhsu/biome-config/next"]
+}
+```
+
+The Next.js preset extends React rules with Next.js-specific patterns.
+
+#### Vue Projects
+
+```json
+{
+  "extends": ["@quentinhsu/biome-config/vue"]
+}
+```
+
+#### Nuxt Projects
+
+```json
+{
+  "extends": ["@quentinhsu/biome-config/nuxt"]
+}
+```
+
+### Customization
+
+You can override or extend any preset rules in your own `biome.json`:
+
+```json
+{
+  "extends": ["@quentinhsu/biome-config/react"],
+  "linter": {
+    "rules": {
+      "style": {
+        "useFragmentSyntax": "warn"
+      }
+    }
+  },
+  "formatter": {
+    "lineWidth": 120
+  }
+}
+```
+
+### Base Configuration Features
+
+The base configuration includes:
+
+- **Formatter**: Space indentation, 140-character line width
+- **Linter**: Recommended rules with strict complexity and correctness checks
+- **JavaScript**: Single quotes, no arrow parentheses, trailing commas
+- **Imports**: Organized by node modules, packages, aliases, and relative paths
+- **VCS**: Git integration with `.gitignore` support
+- **Files**: Ignores common output directories (`build`, `dist`, `.next`)
+
+### Running Biome
+
+Once configured, you can use Biome commands:
+
+```bash
+# Format files
+pnpm biome format . --write
+
+# Lint files
+pnpm biome lint . --write
+
+# Check formatting and linting
+pnpm biome check .
+
+# Fix lint issues automatically
+pnpm biome lint . --fix
+```
+
+
+

package/dist/build.mjs

@@ -0,0 +1,381 @@
+import { mkdir, writeFile } from "node:fs/promises";
+import { dirname, join } from "node:path";
+import { fileURLToPath } from "node:url";
+const isPlainObject = (value)=>null !== value && 'object' == typeof value && !Array.isArray(value);
+const mergeArrays = (a, b)=>{
+    const result = [
+        ...a
+    ];
+    for (const item of b)if (!result.some((existing)=>deepEqual(existing, item))) result.push(item);
+    return result;
+};
+const deepEqual = (a, b)=>{
+    if (a === b) return true;
+    if (Array.isArray(a) && Array.isArray(b)) return a.length === b.length && a.every((item, index)=>deepEqual(item, b[index]));
+    if (isPlainObject(a) && isPlainObject(b)) {
+        const keysA = Object.keys(a);
+        const keysB = Object.keys(b);
+        return keysA.length === keysB.length && keysA.every((key)=>deepEqual(a[key], b[key]));
+    }
+    return false;
+};
+const deepMerge = (target, source)=>{
+    for (const [key, value] of Object.entries(source)){
+        const current = target[key];
+        if (Array.isArray(value)) {
+            if (Array.isArray(current)) target[key] = mergeArrays(current, value);
+            else target[key] = [
+                ...value
+            ];
+            continue;
+        }
+        if (isPlainObject(value)) {
+            const nextTarget = isPlainObject(current) ? {
+                ...current
+            } : {};
+            target[key] = deepMerge(nextTarget, value);
+            continue;
+        }
+        target[key] = value;
+    }
+    return target;
+};
+const mergeConfigs = (...configs)=>{
+    const merged = configs.reduce((accumulator, config)=>deepMerge(accumulator, config), {});
+    return merged;
+};
+const BIOME_SCHEMA_URL = 'https://biomejs.dev/schemas/2.2.6/schema.json';
+const indexConfig = {
+    $schema: BIOME_SCHEMA_URL,
+    root: true,
+    vcs: {
+        enabled: true,
+        clientKind: 'git',
+        useIgnoreFile: true,
+        defaultBranch: 'main'
+    },
+    files: {
+        ignoreUnknown: true,
+        includes: [
+            '**',
+            '!**/build',
+            '!**/dist',
+            '!**/.next'
+        ]
+    },
+    formatter: {
+        enabled: true,
+        indentStyle: 'space',
+        lineWidth: 140,
+        formatWithErrors: true
+    },
+    assist: {
+        actions: {
+            source: {
+                organizeImports: {
+                    level: 'on',
+                    options: {
+                        groups: [
+                            [
+                                ':NODE:',
+                                ':BUN:',
+                                ':PACKAGE_WITH_PROTOCOL:',
+                                ':PACKAGE:'
+                            ],
+                            ':BLANK_LINE:',
+                            ':ALIAS:',
+                            ':BLANK_LINE:',
+                            ':PATH:'
+                        ]
+                    }
+                }
+            }
+        }
+    },
+    linter: {
+        enabled: true,
+        rules: {
+            recommended: true,
+            complexity: {
+                noUselessStringConcat: 'error',
+                noUselessUndefinedInitialization: 'error',
+                noVoid: 'error',
+                useDateNow: 'error'
+            },
+            correctness: {
+                noConstantMathMinMaxClamp: 'error',
+                noUndeclaredVariables: 'error',
+                noUnusedImports: 'error',
+                noUnusedFunctionParameters: 'error',
+                noUnusedPrivateClassMembers: 'error',
+                useExhaustiveDependencies: {
+                    level: 'error',
+                    options: {
+                        reportUnnecessaryDependencies: false
+                    }
+                },
+                noUnusedVariables: 'error'
+            },
+            style: {
+                noParameterProperties: 'error',
+                noYodaExpression: 'error',
+                useConsistentBuiltinInstantiation: 'error',
+                useFragmentSyntax: 'error',
+                useImportType: {
+                    level: 'error',
+                    fix: 'safe',
+                    options: {
+                        style: 'separatedType'
+                    }
+                },
+                useSelfClosingElements: {
+                    level: 'error',
+                    fix: 'safe',
+                    options: {}
+                },
+                useShorthandAssign: 'error',
+                useArrayLiterals: 'error'
+            },
+            nursery: {
+                useSortedClasses: {
+                    level: 'error',
+                    fix: 'safe',
+                    options: {
+                        functions: [
+                            'clsx',
+                            'cn'
+                        ]
+                    }
+                }
+            },
+            suspicious: {
+                useAwait: 'error',
+                noEvolvingTypes: 'error'
+            }
+        }
+    },
+    javascript: {
+        formatter: {
+            quoteStyle: 'single',
+            jsxQuoteStyle: 'single',
+            arrowParentheses: 'asNeeded',
+            trailingCommas: 'all'
+        }
+    },
+    overrides: [
+        {
+            includes: [
+                '**/*.jsx',
+                '**/*.tsx'
+            ],
+            linter: {
+                rules: {
+                    style: {
+                        noParameterAssign: 'error'
+                    }
+                }
+            }
+        },
+        {
+            includes: [
+                '**/*.ts',
+                '**/*.tsx'
+            ],
+            linter: {
+                rules: {
+                    correctness: {
+                        noUnusedVariables: 'off'
+                    }
+                }
+            }
+        }
+    ]
+};
+const reactOverlay = {
+    files: {
+        includes: [
+            '!**/.storybook'
+        ]
+    },
+    javascript: {
+        jsxRuntime: 'reactClassic'
+    },
+    linter: {
+        rules: {
+            style: {
+                useFragmentSyntax: 'error'
+            }
+        }
+    },
+    overrides: [
+        {
+            includes: [
+                '**/__tests__/**',
+                '**/*.{test,spec}.{ts,tsx,js,jsx}'
+            ],
+            linter: {
+                rules: {
+                    correctness: {
+                        noUnusedVariables: 'off'
+                    }
+                }
+            }
+        }
+    ]
+};
+const reactConfig = mergeConfigs(indexConfig, reactOverlay);
+const nextOverlay = {
+    files: {
+        includes: [
+            '!**/.next',
+            '!**/.vercel',
+            '!**/out'
+        ]
+    },
+    javascript: {
+        jsxRuntime: 'transparent'
+    },
+    linter: {
+        rules: {
+            correctness: {
+                useExhaustiveDependencies: {
+                    level: 'error',
+                    options: {
+                        reportUnnecessaryDependencies: true
+                    }
+                }
+            }
+        }
+    }
+};
+const nextConfig = mergeConfigs(reactConfig, nextOverlay);
+const vueOverlay = {
+    files: {
+        includes: [
+            '!**/.vitepress',
+            '!**/.output'
+        ]
+    },
+    javascript: {
+        parser: {
+            jsxEverywhere: false
+        }
+    },
+    html: {
+        formatter: {
+            indentScriptAndStyle: true,
+            selfCloseVoidElements: 'always'
+        }
+    },
+    overrides: [
+        {
+            includes: [
+                '**/*.vue'
+            ],
+            formatter: {
+                lineWidth: 120
+            },
+            javascript: {
+                formatter: {
+                    quoteStyle: 'single'
+                }
+            }
+        }
+    ]
+};
+const vueConfig = mergeConfigs(indexConfig, vueOverlay);
+const nuxtOverlay = {
+    files: {
+        includes: [
+            '!**/.nuxt',
+            '!**/.nitro',
+            '!**/.output'
+        ]
+    },
+    javascript: {
+        globals: [
+            'defineNuxtConfig',
+            'defineAppConfig',
+            'defineNuxtPlugin',
+            'defineNuxtRouteMiddleware',
+            'defineNuxtServerPlugin',
+            'defineNitroPlugin',
+            'defineEventHandler',
+            'defineLazyEventHandler',
+            'definePayloadPlugin',
+            'defineRouteRules',
+            'definePageMeta',
+            'useRuntimeConfig',
+            'useNuxtApp',
+            'useAsyncData',
+            'useLazyAsyncData',
+            'useFetch',
+            'useLazyFetch',
+            'useState',
+            'useCookie',
+            'useHead',
+            'useSeoMeta',
+            'useError',
+            'clearError',
+            'showError',
+            'navigateTo',
+            'abortNavigation',
+            'refreshNuxtData',
+            'onNuxtReady',
+            'useRouter',
+            'useRoute',
+            'useRequestEvent',
+            'useRequestHeaders'
+        ]
+    },
+    overrides: [
+        {
+            includes: [
+                '**/*.ts'
+            ],
+            linter: {
+                rules: {
+                    correctness: {
+                        noUndeclaredVariables: 'error'
+                    }
+                }
+            }
+        }
+    ]
+};
+const nuxtConfig = mergeConfigs(vueConfig, nuxtOverlay);
+const allPresets = Object.freeze({
+    index: indexConfig,
+    react: reactConfig,
+    next: nextConfig,
+    vue: vueConfig,
+    nuxt: nuxtConfig
+});
+const currentDir = dirname(fileURLToPath(import.meta.url));
+const outputDir = currentDir;
+const serialize = (config)=>`${JSON.stringify(config, null, 2)}\n`;
+async function ensureDir(path) {
+    await mkdir(path, {
+        recursive: true
+    });
+}
+async function buildJsonPresets() {
+    await ensureDir(outputDir);
+    const tasks = Object.entries(allPresets).map(async ([name, config])=>{
+        const filePath = join(outputDir, `${name}.jsonc`);
+        const data = serialize(config);
+        await writeFile(filePath, data, 'utf8');
+        return filePath;
+    });
+    const writtenFiles = await Promise.all(tasks);
+    return writtenFiles;
+}
+(async ()=>{
+    try {
+        const files = await buildJsonPresets();
+        console.log(`Generated presets: ${files.join(', ')}`);
+    } catch (error) {
+        console.error('Failed to generate Biome presets', error);
+        process.exitCode = 1;
+    }
+})();

package/dist/index.jsonc

@@ -0,0 +1,146 @@
+{
+  "$schema": "https://biomejs.dev/schemas/2.2.6/schema.json",
+  "root": true,
+  "vcs": {
+    "enabled": true,
+    "clientKind": "git",
+    "useIgnoreFile": true,
+    "defaultBranch": "main"
+  },
+  "files": {
+    "ignoreUnknown": true,
+    "includes": [
+      "**",
+      "!**/build",
+      "!**/dist",
+      "!**/.next"
+    ]
+  },
+  "formatter": {
+    "enabled": true,
+    "indentStyle": "space",
+    "lineWidth": 140,
+    "formatWithErrors": true
+  },
+  "assist": {
+    "actions": {
+      "source": {
+        "organizeImports": {
+          "level": "on",
+          "options": {
+            "groups": [
+              [
+                ":NODE:",
+                ":BUN:",
+                ":PACKAGE_WITH_PROTOCOL:",
+                ":PACKAGE:"
+              ],
+              ":BLANK_LINE:",
+              ":ALIAS:",
+              ":BLANK_LINE:",
+              ":PATH:"
+            ]
+          }
+        }
+      }
+    }
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": true,
+      "complexity": {
+        "noUselessStringConcat": "error",
+        "noUselessUndefinedInitialization": "error",
+        "noVoid": "error",
+        "useDateNow": "error"
+      },
+      "correctness": {
+        "noConstantMathMinMaxClamp": "error",
+        "noUndeclaredVariables": "error",
+        "noUnusedImports": "error",
+        "noUnusedFunctionParameters": "error",
+        "noUnusedPrivateClassMembers": "error",
+        "useExhaustiveDependencies": {
+          "level": "error",
+          "options": {
+            "reportUnnecessaryDependencies": false
+          }
+        },
+        "noUnusedVariables": "error"
+      },
+      "style": {
+        "noParameterProperties": "error",
+        "noYodaExpression": "error",
+        "useConsistentBuiltinInstantiation": "error",
+        "useFragmentSyntax": "error",
+        "useImportType": {
+          "level": "error",
+          "fix": "safe",
+          "options": {
+            "style": "separatedType"
+          }
+        },
+        "useSelfClosingElements": {
+          "level": "error",
+          "fix": "safe",
+          "options": {}
+        },
+        "useShorthandAssign": "error",
+        "useArrayLiterals": "error"
+      },
+      "nursery": {
+        "useSortedClasses": {
+          "level": "error",
+          "fix": "safe",
+          "options": {
+            "functions": [
+              "clsx",
+              "cn"
+            ]
+          }
+        }
+      },
+      "suspicious": {
+        "useAwait": "error",
+        "noEvolvingTypes": "error"
+      }
+    }
+  },
+  "javascript": {
+    "formatter": {
+      "quoteStyle": "single",
+      "jsxQuoteStyle": "single",
+      "arrowParentheses": "asNeeded",
+      "trailingCommas": "all"
+    }
+  },
+  "overrides": [
+    {
+      "includes": [
+        "**/*.jsx",
+        "**/*.tsx"
+      ],
+      "linter": {
+        "rules": {
+          "style": {
+            "noParameterAssign": "error"
+          }
+        }
+      }
+    },
+    {
+      "includes": [
+        "**/*.ts",
+        "**/*.tsx"
+      ],
+      "linter": {
+        "rules": {
+          "correctness": {
+            "noUnusedVariables": "off"
+          }
+        }
+      }
+    }
+  ]
+}