@jmlweb/eslint-config-astro 1.0.2 → 1.0.4

package/CHANGELOG.md

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

package/README.md

@@ -22,9 +22,11 @@
 ## 📦 Installation
 
 ```bash
-npm install --save-dev @jmlweb/eslint-config-astro eslint @eslint/js typescript-eslint eslint-config-prettier eslint-plugin-astro eslint-plugin-simple-import-sort @jmlweb/eslint-config-base
+pnpm add -D @jmlweb/eslint-config-astro eslint @eslint/js typescript-eslint eslint-config-prettier eslint-plugin-astro eslint-plugin-simple-import-sort @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:
@@ -146,9 +148,35 @@ import { Component } from './component';
 Fix import order automatically:
 
 ```bash
-npx eslint --fix .
+pnpm exec eslint --fix .
 ```
 
+## 🤔 Why Use This?
+
+> **Philosophy**: Astro components should follow Astro's mental model - islands of interactivity with server-first rendering.
+
+This package extends the base TypeScript config with Astro-specific rules that enforce best practices for `.astro` files, prevent common pitfalls with Astro's unique component model, and ensure proper usage of Astro directives.
+
+### Design Decisions
+
+**Astro Plugin (`eslint-plugin-astro`)**: Enforces Astro-specific rules and patterns
+
+- **Why**: Astro has a unique component format that blends frontmatter, markup, and optional client-side interactivity. The plugin catches misuse of directives, style conflicts, and component structure issues
+- **Trade-off**: Additional rules specific to Astro, but prevents framework-specific bugs
+- **When to override**: When you have a legitimate reason to deviate from Astro conventions (rare)
+
+**Astro File Support**: Properly lints `.astro` files with awareness of their structure
+
+- **Why**: `.astro` files have three sections (frontmatter, template, style) that need different parsing. Standard linters don't understand this format
+- **Trade-off**: None - this is essential for Astro development
+- **When to override**: Never - Astro files require Astro-aware linting
+
+**Extends Base TypeScript Config**: Inherits all strict type checking rules for TypeScript in frontmatter
+
+- **Why**: Astro components often contain complex TypeScript logic in frontmatter. Strict typing catches bugs early
+- **Trade-off**: More verbose frontmatter code, but prevents runtime errors
+- **When to override**: Follow the same guidelines as the base TypeScript config
+
 ## 🎯 When to Use
 
 Use this configuration when you want:
@@ -201,8 +229,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
@@ -227,10 +255,35 @@ This package requires the following peer dependencies:
 
 ## 🔗 Related Packages
 
+### Internal Packages
+
 - [`@jmlweb/eslint-config-base`](../eslint-config-base) - Base TypeScript ESLint config (extended by this package)
 - [`@jmlweb/tsconfig-astro`](../tsconfig-astro) - TypeScript configuration for Astro projects
 - [`@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
+- [Astro](https://astro.build/) - The web framework for content-driven websites
+- [eslint-plugin-astro](https://ota-meshi.github.io/eslint-plugin-astro/) - ESLint plugin for Astro components
+- [Prettier Plugin Astro](https://github.com/withastro/prettier-plugin-astro) - Prettier plugin for .astro files
+
+## 🔄 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-astro",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "ESLint configuration for Astro projects with TypeScript. Extends @jmlweb/eslint-config-base with Astro-specific rules.",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -52,10 +52,10 @@
     "eslint-plugin-astro": "^1.5.0",
     "eslint-plugin-simple-import-sort": "^12.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",
@@ -67,8 +67,8 @@
     "tsup": "^8.5.1",
     "typescript": "^5.9.3",
     "typescript-eslint": "^8.34.1",
-    "@jmlweb/eslint-config-base": "2.0.2",
-    "@jmlweb/tsconfig-internal": "0.0.1"
+    "@jmlweb/tsconfig-internal": "0.0.1",
+    "@jmlweb/eslint-config-base": "2.0.4"
   },
   "scripts": {
     "build": "tsup",