@jmlweb/eslint-config-astro 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# @jmlweb/eslint-config-astro
+
+## 1.0.0
+
+### Added
+
+- Initial release
+- ESLint configuration for Astro projects
+- Extends `@jmlweb/eslint-config-base` with Astro-specific rules
+- Support for `.astro` files with proper TypeScript parsing
+- Integration with `eslint-plugin-astro` recommended config

package/README.md

@@ -0,0 +1,236 @@
+# @jmlweb/eslint-config-astro
+
+[![npm version](https://img.shields.io/npm/v/@jmlweb/eslint-config-astro)](https://www.npmjs.com/package/@jmlweb/eslint-config-astro)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![Node.js](https://img.shields.io/badge/Node.js-%3E%3D20.11.0-339933.svg)](https://nodejs.org/)
+[![ESLint](https://img.shields.io/badge/ESLint-9.0%2B-4B32C3.svg)](https://eslint.org/)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.0%2B-3178C6.svg)](https://www.typescriptlang.org/)
+[![Astro](https://img.shields.io/badge/Astro-4.0%2B-FF5D01.svg)](https://astro.build/)
+
+> ESLint configuration for Astro projects with TypeScript. Extends `@jmlweb/eslint-config-base` with Astro-specific rules and best practices for `.astro` files.
+
+## ✨ Features
+
+- 🔒 **Strict Type Checking**: Inherits all strict TypeScript rules from base config
+- 🚀 **Astro Support**: Enforces Astro-specific rules and patterns
+- 📝 **Astro File Handling**: Proper linting for `.astro` files
+- 📦 **Import Management**: Enforces type-only imports with inline style + automatic sorting
+- 🎯 **Code Quality**: Prevents common Astro pitfalls and anti-patterns
+- 🎨 **Prettier Integration**: Disables all ESLint rules that conflict with Prettier
+- 🚀 **Flat Config**: Uses ESLint 9+ flat config format (latest stable)
+
+## 📦 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
+```
+
+## 🚀 Quick Start
+
+Create an `eslint.config.js` file in your project root:
+
+```javascript
+import astroConfig from '@jmlweb/eslint-config-astro';
+
+export default [
+  ...astroConfig,
+  // Add your project-specific overrides here
+];
+```
+
+## 💡 Examples
+
+### Basic Setup
+
+```javascript
+// eslint.config.js
+import astroConfig from '@jmlweb/eslint-config-astro';
+
+export default [...astroConfig];
+```
+
+### With Project-Specific Overrides
+
+```javascript
+// eslint.config.js
+import astroConfig from '@jmlweb/eslint-config-astro';
+
+export default [
+  ...astroConfig,
+  {
+    files: ['**/*.test.ts', '**/*.test.astro'],
+    rules: {
+      // Allow any in tests
+      '@typescript-eslint/no-explicit-any': 'off',
+      // Allow console in tests
+      'no-console': 'off',
+    },
+  },
+  {
+    ignores: ['dist/', '.astro/', 'node_modules/', '*.config.ts'],
+  },
+];
+```
+
+### With Custom Astro Settings
+
+```javascript
+// eslint.config.js
+import astroConfig from '@jmlweb/eslint-config-astro';
+
+export default [
+  ...astroConfig,
+  {
+    files: ['**/*.astro'],
+    rules: {
+      // Customize Astro-specific rules
+      'astro/no-conflict-set-directives': 'error',
+      'astro/no-unused-define-vars-in-style': 'warn',
+    },
+  },
+];
+```
+
+## 📋 Configuration Details
+
+### Astro Files
+
+This configuration applies Astro-specific rules to:
+
+- `**/*.astro` - Astro component files
+
+### TypeScript Files
+
+TypeScript rules are also applied to:
+
+- `**/*.ts` - TypeScript files
+- `**/*.tsx` - TypeScript React files (if used in Astro project)
+
+### Key Rules Enforced
+
+| Rule                                   | Level   | Description                         |
+| -------------------------------------- | ------- | ----------------------------------- |
+| `astro/no-conflict-set-directives`     | `error` | Prevents conflicting set directives |
+| `astro/no-unused-define-vars-in-style` | `warn`  | Warns about unused CSS variables    |
+| `simple-import-sort/imports`           | `error` | Enforces import sorting             |
+| `simple-import-sort/exports`           | `error` | Enforces export sorting             |
+
+### What's Included
+
+- ✅ All TypeScript ESLint rules from `@jmlweb/eslint-config-base`
+- ✅ Astro recommended rules from `eslint-plugin-astro`
+- ✅ Proper handling of `.astro` files with TypeScript parser
+- ✅ Automatic import/export sorting
+- ✅ Prettier conflict resolution
+
+## 🔄 Import Sorting
+
+The configuration automatically sorts imports and enforces type-only imports:
+
+**Before:**
+
+```typescript
+import { Component } from './component';
+import type { User } from './types';
+import fs from 'fs';
+```
+
+**After auto-fix:**
+
+```typescript
+import fs from 'fs';
+import type { User } from './types';
+import { Component } from './component';
+```
+
+Fix import order automatically:
+
+```bash
+npx eslint --fix .
+```
+
+## 🎯 When to Use
+
+Use this configuration when you want:
+
+- ✅ Astro project development with TypeScript
+- ✅ Maximum type safety with Astro
+- ✅ Strict code quality standards for Astro code
+- ✅ Consistent Astro patterns across the team
+- ✅ Prevention of common Astro pitfalls
+
+**For non-Astro TypeScript projects**, use [`@jmlweb/eslint-config-base`](../eslint-config-base) instead.
+
+**For React projects**, use [`@jmlweb/eslint-config-react`](../eslint-config-react) instead.
+
+## 🔧 Extending the Configuration
+
+You can extend or override the configuration for your specific needs:
+
+```javascript
+import astroConfig from '@jmlweb/eslint-config-astro';
+
+export default [
+  ...astroConfig,
+  {
+    files: ['**/*.test.ts', '**/*.test.astro'],
+    rules: {
+      // Test-specific rules
+      '@typescript-eslint/no-explicit-any': 'off',
+    },
+  },
+  {
+    ignores: ['dist/', '.astro/', 'node_modules/'],
+  },
+];
+```
+
+## 📝 Usage with Scripts
+
+Add linting scripts to your `package.json`:
+
+```json
+{
+  "scripts": {
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix"
+  }
+}
+```
+
+Then run:
+
+```bash
+npm run lint      # Lint all files
+npm run lint:fix  # Fix auto-fixable issues
+```
+
+## 📋 Requirements
+
+- **Node.js** >= 20.11.0 (required for `import.meta.dirname` in config files)
+- **ESLint** >= 9.0.0 (flat config format)
+- **TypeScript** project with `tsconfig.json`
+- **Astro** >= 4.0.0
+- **TypeScript project service** enabled (automatic with this config)
+
+## 📦 Peer Dependencies
+
+This package requires the following peer dependencies:
+
+- `eslint` (^9.0.0)
+- `@eslint/js` (^9.0.0)
+- `typescript-eslint` (^8.0.0)
+- `eslint-config-prettier` (^9.1.0)
+- `eslint-plugin-astro` (^1.5.0)
+- `eslint-plugin-simple-import-sort` (^12.0.0)
+- `@jmlweb/eslint-config-base` (^2.0.2)
+
+## 🔗 Related 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
+
+## 📄 License
+
+MIT

package/dist/index.cjs

@@ -0,0 +1,75 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  default: () => index_default
+});
+module.exports = __toCommonJS(index_exports);
+var import_eslint_config_base = __toESM(require("@jmlweb/eslint-config-base"), 1);
+var import_eslint_config_prettier = __toESM(require("eslint-config-prettier"), 1);
+var import_eslint_plugin_astro = __toESM(require("eslint-plugin-astro"), 1);
+var import_eslint_plugin_simple_import_sort = __toESM(require("eslint-plugin-simple-import-sort"), 1);
+var config = [
+  ...import_eslint_config_base.default,
+  // Astro recommended config
+  ...import_eslint_plugin_astro.default.configs.recommended,
+  {
+    files: ["**/*.astro"],
+    plugins: {
+      astro: import_eslint_plugin_astro.default,
+      "simple-import-sort": import_eslint_plugin_simple_import_sort.default
+    },
+    languageOptions: {
+      parserOptions: {
+        parser: "@typescript-eslint/parser",
+        extraFileExtensions: [".astro"]
+      }
+    },
+    rules: {
+      ...import_eslint_config_prettier.default.rules,
+      "simple-import-sort/imports": "error",
+      "simple-import-sort/exports": "error"
+    }
+  },
+  // Also apply to TypeScript files in Astro projects
+  {
+    files: ["**/*.ts", "**/*.tsx"],
+    plugins: {
+      "simple-import-sort": import_eslint_plugin_simple_import_sort.default
+    },
+    rules: {
+      ...import_eslint_config_prettier.default.rules,
+      "simple-import-sort/imports": "error",
+      "simple-import-sort/exports": "error"
+    }
+  }
+];
+var index_default = config;

package/dist/index.d.cts

@@ -0,0 +1,10 @@
+import { Linter } from 'eslint';
+
+/**
+ * Astro ESLint configuration that extends the base TypeScript config.
+ * Includes Astro-specific rules and best practices for .astro files.
+ * For Astro project development with TypeScript.
+ */
+declare const config: Linter.Config[];
+
+export { config as default };

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+import { Linter } from 'eslint';
+
+/**
+ * Astro ESLint configuration that extends the base TypeScript config.
+ * Includes Astro-specific rules and best practices for .astro files.
+ * For Astro project development with TypeScript.
+ */
+declare const config: Linter.Config[];
+
+export { config as default };

package/dist/index.js

@@ -0,0 +1,44 @@
+// src/index.ts
+import baseConfig from "@jmlweb/eslint-config-base";
+import prettierConfig from "eslint-config-prettier";
+import astro from "eslint-plugin-astro";
+import simpleImportSort from "eslint-plugin-simple-import-sort";
+var config = [
+  ...baseConfig,
+  // Astro recommended config
+  ...astro.configs.recommended,
+  {
+    files: ["**/*.astro"],
+    plugins: {
+      astro,
+      "simple-import-sort": simpleImportSort
+    },
+    languageOptions: {
+      parserOptions: {
+        parser: "@typescript-eslint/parser",
+        extraFileExtensions: [".astro"]
+      }
+    },
+    rules: {
+      ...prettierConfig.rules,
+      "simple-import-sort/imports": "error",
+      "simple-import-sort/exports": "error"
+    }
+  },
+  // Also apply to TypeScript files in Astro projects
+  {
+    files: ["**/*.ts", "**/*.tsx"],
+    plugins: {
+      "simple-import-sort": simpleImportSort
+    },
+    rules: {
+      ...prettierConfig.rules,
+      "simple-import-sort/imports": "error",
+      "simple-import-sort/exports": "error"
+    }
+  }
+];
+var index_default = config;
+export {
+  index_default as default
+};

package/package.json

@@ -0,0 +1,77 @@
+{
+  "name": "@jmlweb/eslint-config-astro",
+  "version": "1.0.0",
+  "description": "ESLint configuration for Astro projects with TypeScript. Extends @jmlweb/eslint-config-base with Astro-specific rules.",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "keywords": [
+    "code-quality",
+    "eslint",
+    "eslint-config",
+    "linting",
+    "astro",
+    "typescript"
+  ],
+  "author": "jmlweb",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jmlweb/tooling.git"
+  },
+  "bugs": "https://github.com/jmlweb/tooling/issues",
+  "homepage": "https://github.com/jmlweb/tooling/tree/main/packages/eslint-config-astro#readme",
+  "engines": {
+    "node": ">=20.11.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "@eslint/js": "^9.0.0",
+    "@jmlweb/eslint-config-base": "^2.0.2",
+    "eslint": "^9.0.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-astro": "^1.5.0",
+    "eslint-plugin-simple-import-sort": "^12.0.0",
+    "typescript-eslint": "^8.0.0"
+  },
+  "dependencies": {
+    "@jmlweb/eslint-config-base": "2.0.2"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.39.2",
+    "@types/eslint": "^9.6.1",
+    "eslint": "^9.39.2",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-astro": "^1.5.0",
+    "eslint-plugin-simple-import-sort": "^12.1.1",
+    "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"
+  },
+  "scripts": {
+    "build": "tsup",
+    "clean": "rm -rf dist"
+  }
+}