@jmlweb/eslint-config-node 2.0.3 → 2.0.5

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @jmlweb/eslint-config-node
 
+## 2.0.5
+
+### Patch Changes
+
+- 4a9ece1: Update documentation to use pnpm commands instead of npm
+- Updated dependencies [4a9ece1]
+  - @jmlweb/eslint-config-base@2.0.4
+
+## 2.0.4
+
+### Patch Changes
+
+- 6b73301: Add changelog section with link to CHANGELOG.md in package READMEs
+- Updated dependencies [6b73301]
+  - @jmlweb/eslint-config-base@2.0.3
+
 ## 2.0.3
 
 ### Patch Changes

package/README.md

@@ -21,9 +21,11 @@
 ## 📦 Installation
 
 ```bash
-npm install --save-dev @jmlweb/eslint-config-node eslint @eslint/js typescript-eslint eslint-config-prettier eslint-plugin-n eslint-plugin-simple-import-sort globals @jmlweb/eslint-config-base
+pnpm add -D @jmlweb/eslint-config-node eslint @eslint/js typescript-eslint eslint-config-prettier eslint-plugin-n eslint-plugin-simple-import-sort globals @jmlweb/eslint-config-base
 ```
 
+> 💡 **Upgrading from a previous version?** See the [Migration Guide](#-migration-guide) for breaking changes and upgrade instructions.
+
 ## 🚀 Quick Start
 
 Create an `eslint.config.js` file in your project root:
@@ -160,9 +162,35 @@ import { Component } from './component';
 Fix import order automatically:
 
 ```bash
-npx eslint --fix .
+pnpm exec eslint --fix .
 ```
 
+## 🤔 Why Use This?
+
+> **Philosophy**: Node.js applications should follow Node.js best practices and leverage the platform's capabilities correctly.
+
+This package extends the base TypeScript config with Node.js-specific rules that prevent common Node.js pitfalls, enforce best practices for the platform, and provide proper global variable handling for the Node.js runtime.
+
+### Design Decisions
+
+**Node.js Plugin (`eslint-plugin-n`)**: Enforces Node.js best practices and catches platform-specific issues
+
+- **Why**: Node.js has unique patterns (async I/O, modules, process management) that require specific rules. The plugin catches deprecated APIs, improper module usage, and process handling issues
+- **Trade-off**: Additional rules to learn, but prevents Node.js-specific bugs
+- **When to override**: When you know you're using a pattern correctly despite the warning (rare)
+
+**Node.js Globals**: Automatically includes Node.js global variables (`process`, `__dirname`, `Buffer`, etc.)
+
+- **Why**: Node.js applications need access to platform globals. Explicitly declaring them prevents "undefined variable" errors
+- **Trade-off**: None - this is required for Node.js development
+- **When to override**: Never - Node.js code needs these globals
+
+**Extends Base TypeScript Config**: Inherits all strict type checking rules
+
+- **Why**: Node.js applications benefit from strict typing, especially for API contracts, database models, and configuration
+- **Trade-off**: More verbose code, but prevents runtime errors in production
+- **When to override**: Follow the same guidelines as the base TypeScript config
+
 ## 🎯 When to Use
 
 Use this configuration when you want:
@@ -217,8 +245,8 @@ Add linting scripts to your `package.json`:
 Then run:
 
 ```bash
-npm run lint      # Lint all files
-npm run lint:fix  # Fix auto-fixable issues
+pnpm lint      # Lint all files
+pnpm lint:fix  # Fix auto-fixable issues
 ```
 
 ## 📋 Requirements
@@ -249,10 +277,35 @@ See real-world usage examples:
 
 ## 🔗 Related Packages
 
+### Internal Packages
+
 - [`@jmlweb/eslint-config-base`](../eslint-config-base) - Base TypeScript ESLint config (extended by this package)
 - [`@jmlweb/tsconfig-node`](../tsconfig-node) - TypeScript configuration for Node.js libraries
 - [`@jmlweb/prettier-config-base`](../prettier-config-base) - Prettier config for consistent formatting
 
+### External Tools
+
+- [ESLint](https://eslint.org/) - Pluggable linting utility for JavaScript and TypeScript
+- [Node.js](https://nodejs.org/) - JavaScript runtime built on Chrome's V8 engine
+- [eslint-plugin-n](https://github.com/eslint-community/eslint-plugin-n) - ESLint rules for Node.js
+- [tsx](https://github.com/privatenumber/tsx) - TypeScript execute (ts-node alternative)
+
+## 🔄 Migration Guide
+
+### Upgrading to a New Version
+
+> **Note:** If no breaking changes were introduced in a version, it's safe to upgrade without additional steps.
+
+**No breaking changes have been introduced yet.** This package follows semantic versioning. When breaking changes are introduced, detailed migration instructions will be provided here.
+
+For version history, see the [Changelog](./CHANGELOG.md).
+
+**Need Help?** If you encounter issues during migration, please [open an issue](https://github.com/jmlweb/tooling/issues/new).
+
+## 📜 Changelog
+
+See [CHANGELOG.md](./CHANGELOG.md) for version history and release notes.
+
 ## 📄 License
 
 MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jmlweb/eslint-config-node",
-  "version": "2.0.3",
+  "version": "2.0.5",
   "description": "ESLint configuration for Node.js projects with TypeScript, extending base config with Node.js-specific rules",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -54,10 +54,10 @@
     "eslint-plugin-simple-import-sort": "^12.0.0",
     "globals": "^15.0.0",
     "typescript-eslint": "^8.0.0",
-    "@jmlweb/eslint-config-base": "2.0.2"
+    "@jmlweb/eslint-config-base": "2.0.4"
   },
   "dependencies": {
-    "@jmlweb/eslint-config-base": "2.0.2"
+    "@jmlweb/eslint-config-base": "2.0.4"
   },
   "devDependencies": {
     "@eslint/js": "^9.39.2",
@@ -71,7 +71,7 @@
     "typescript": "^5.9.3",
     "typescript-eslint": "^8.34.1",
     "@jmlweb/tsconfig-internal": "0.0.1",
-    "@jmlweb/eslint-config-base": "2.0.2"
+    "@jmlweb/eslint-config-base": "2.0.4"
   },
   "scripts": {
     "build": "tsup",