@quentinhsu/biome-config 0.1.0 → 0.2.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 QuentinHsu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,17 +1,23 @@
 # @quentinhsu/biome-config
 
+[![npm version](https://img.shields.io/npm/v/@quentinhsu/biome-config?style=flat-square)](https://www.npmjs.com/package/@quentinhsu/biome-config)
+[![npm downloads](https://img.shields.io/npm/dm/@quentinhsu/biome-config?style=flat-square)](https://www.npmjs.com/package/@quentinhsu/biome-config)
+[![Node.js](https://img.shields.io/badge/node-%3E%3D18-green?style=flat-square)](https://nodejs.org/)
+[![license](https://img.shields.io/npm/l/@quentinhsu/biome-config?style=flat-square)](LICENSE)
+
 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
+## Usage
+
+### Installation
+
+Install this package in your project:
 
 ```bash
-pnpm install
-pnpm build
+pnpm add -D @quentinhsu/biome-config
 ```
 
-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
+### Available Presets
 
 | Preset | Description | Export |
 | --- | --- | --- |
@@ -23,16 +29,6 @@ The build process first compiles TypeScript modules to `dist/` via Rslib, then e
 
 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:
@@ -116,6 +112,50 @@ The base configuration includes:
 - **VCS**: Git integration with `.gitignore` support
 - **Files**: Ignores common output directories (`build`, `dist`, `.next`)
 
+### VS Code Integration
+
+To integrate Biome with VS Code, install the [Biome extension](https://marketplace.visualstudio.com/items?itemName=biomejs.biome) and configure it in `.vscode/settings.json`:
+
+<details>
+<summary><b>.vscode/settings.json</b></summary>
+
+```json
+{
+  "editor.formatOnSave": true,
+  "editor.defaultFormatter": "biomejs.biome",
+  "[javascript]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  },
+  "[javascriptreact]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  },
+  "[typescript]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  },
+  "[typescriptreact]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  },
+  "[json]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  },
+  "[jsonc]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  },
+  "editor.codeActionsOnSave": {
+    "source.fixAll.biome": "explicit",
+    "source.organizeImports.biome": "explicit",
+    "source.action.useSortedKeys.biome": "explicit"
+  }
+}
+```
+
+This configuration:
+- Enables automatic formatting on save
+- Sets Biome as the default formatter for JavaScript, TypeScript, and JSON files
+- Automatically runs Biome's fix and import organization on save
+
+</details>
+
 ### Running Biome
 
 Once configured, you can use Biome commands:
@@ -134,5 +174,29 @@ pnpm biome check .
 pnpm biome lint . --fix
 ```
 
+## Development
+
+### Setup
+
+```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.
+
+### Publishing
+
+For instructions on how to release a new version, see [PUBLISHING.md](PUBLISHING.md).
+
+## Contributing
+
+Found an issue or have a suggestion? Please open an [issue](https://github.com/QuentinHsu/biome-config/issues) on GitHub.
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+
 
 

package/package.json

@@ -1,10 +1,15 @@
 {
   "name": "@quentinhsu/biome-config",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "author": "QuentinHsu",
-  "repository": "https://github.com/QuentinHsu/biome-config",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/QuentinHsu/biome-config.git"
+  },
   "description": "Modular Biome configuration presets.",
   "type": "module",
+  "packageManager": "pnpm@9.15.0",
   "files": [
     "dist"
   ],
@@ -19,6 +24,7 @@
     "generate:types": "tsx scripts/generate-biome-types.ts",
     "prebuild": "pnpm run generate:types",
     "build": "rslib build && node dist/build.mjs",
+    "dev": "nodemon --exec tsx scripts/build-presets.ts",
     "lint": "npx biome check ."
   },
   "keywords": [
@@ -28,13 +34,16 @@
     "formatter"
   ],
   "publishConfig": {
+    "provenance": true,
     "access": "public"
   },
   "devDependencies": {
-    "@biomejs/biome": "^2.3.0",
-    "@rslib/core": "^0.16.1",
+    "@biomejs/biome": "2.3.2",
+    "@quentinhsu/biome-config": "workspace:*",
+    "@rslib/core": "^0.17.0",
     "@types/node": "^24.9.1",
     "json-schema-to-typescript": "^15.0.4",
+    "nodemon": "^3.1.10",
     "tsx": "^4.16.2",
     "typescript": "^5.6.3"
   }

package/dist/build.mjs

@@ -1,381 +0,0 @@
-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;
-    }
-})();