@gv-tech/eslint-config 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Eric Garcia
+
+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

@@ -0,0 +1,133 @@
+# @gv-tech/eslint-config
+
+Shareable ESLint configuration for Garcia Ventures projects. Uses **ESLint v9** flat config format (forward-compatible with v10).
+
+## Features
+
+- 🚀 **ESLint v9+ Flat Config** - Modern configuration format
+- 📦 **Modular** - Use only what you need
+- 🔷 **TypeScript** - First-class TypeScript support via typescript-eslint v8
+- ⚛️ **Next.js** - Next.js 15+ with Core Web Vitals
+- 💅 **Prettier** - Integrated formatting as ESLint rules
+
+## Requirements
+
+- Node.js >= 20.19.0
+- ESLint >= 9.0.0
+
+## Installation
+
+```bash
+npm install --save-dev @gv-tech/eslint-config eslint
+```
+
+### With TypeScript
+
+```bash
+npm install --save-dev @gv-tech/eslint-config eslint typescript-eslint typescript
+```
+
+### With Next.js
+
+```bash
+npm install --save-dev @gv-tech/eslint-config eslint typescript-eslint typescript @next/eslint-plugin-next
+```
+
+### With Prettier
+
+```bash
+npm install --save-dev @gv-tech/eslint-config eslint eslint-plugin-prettier eslint-config-prettier @eng618/prettier-config
+```
+
+> **Note:** Add `"prettier": "@eng618/prettier-config"` to your `package.json` to use the shared Prettier config.
+
+## Usage
+
+Create an `eslint.config.mjs` file in your project root:
+
+### Basic JavaScript
+
+```js
+import { base } from '@gv-tech/eslint-config';
+
+export default [...base];
+```
+
+### TypeScript Project
+
+```js
+import { typescript, prettier } from '@gv-tech/eslint-config';
+
+export default [...typescript, ...prettier];
+```
+
+### Next.js Project
+
+```js
+import { next, prettier } from '@gv-tech/eslint-config';
+
+export default [...next, ...prettier];
+```
+
+### Using Presets
+
+For convenience, pre-combined presets are available:
+
+```js
+// TypeScript + Prettier (recommended)
+import { recommended } from '@gv-tech/eslint-config';
+export default [...recommended];
+
+// Next.js + TypeScript + Prettier
+import { nextjs } from '@gv-tech/eslint-config';
+export default [...nextjs];
+```
+
+### Custom Configuration
+
+Extend and customize as needed:
+
+```js
+import { typescript, prettier } from '@gv-tech/eslint-config';
+
+export default [
+  ...typescript,
+  ...prettier,
+  {
+    // Add project-specific ignores
+    ignores: ['custom-folder/**'],
+  },
+  {
+    // Override rules
+    files: ['**/*.ts'],
+    rules: {
+      '@typescript-eslint/no-unused-vars': 'warn',
+    },
+  },
+];
+```
+
+## Available Configurations
+
+| Export | Description |
+|--------|-------------|
+| `base` | Core JavaScript rules |
+| `typescript` | TypeScript support (includes base) |
+| `next` | Next.js 16+ (includes TypeScript) |
+| `prettier` | Prettier formatting integration |
+| `recommended` | TypeScript + Prettier |
+| `nextjs` | Next.js + Prettier |
+
+## Exported Utilities
+
+| Export | Description |
+|--------|-------------|
+| `jsFiles` | JavaScript file patterns |
+| `tsFiles` | TypeScript file patterns |
+| `allJsTsFiles` | All JS/TS file patterns |
+| `commonIgnores` | Common ignore patterns |
+| `nextIgnores` | Next.js-specific ignores |
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,82 @@
+{
+  "name": "@gv-tech/eslint-config",
+  "version": "0.1.0",
+  "description": "Shareable ESLint configuration for Garcia Ventures projects - ESLint v9 flat config",
+  "type": "module",
+  "exports": {
+    ".": "./src/index.mjs",
+    "./base": "./src/base.mjs",
+    "./typescript": "./src/typescript.mjs",
+    "./next": "./src/next.mjs",
+    "./prettier": "./src/prettier.mjs"
+  },
+  "files": [
+    "src"
+  ],
+  "keywords": [
+    "eslint",
+    "eslintconfig",
+    "eslint-config",
+    "flat-config",
+    "eslint-v10",
+    "typescript",
+    "nextjs",
+    "prettier"
+  ],
+  "author": "Eric N. Garcia <eng618@garciaericn.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Garcia-Ventures/eslint-config.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Garcia-Ventures/eslint-config/issues"
+  },
+  "homepage": "https://github.com/Garcia-Ventures/eslint-config#readme",
+  "engines": {
+    "node": ">=20.19.0"
+  },
+  "peerDependencies": {
+    "@eng618/prettier-config": "^1.0.0",
+    "@eslint/js": "^9.0.0",
+    "@next/eslint-plugin-next": "^15.0.0 || ^16.0.0",
+    "eslint": "^9.0.0",
+    "eslint-config-prettier": "^9.0.0 || ^10.0.0",
+    "eslint-plugin-prettier": "^5.0.0",
+    "globals": "^15.0.0 || ^16.0.0",
+    "typescript": ">=5.0.0",
+    "typescript-eslint": "^8.0.0"
+  },
+  "peerDependenciesMeta": {
+    "typescript-eslint": {
+      "optional": true
+    },
+    "typescript": {
+      "optional": true
+    },
+    "@next/eslint-plugin-next": {
+      "optional": true
+    },
+    "eslint-plugin-prettier": {
+      "optional": true
+    },
+    "eslint-config-prettier": {
+      "optional": true
+    },
+    "@eng618/prettier-config": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@eng618/prettier-config": "^1.8.0",
+    "@eslint/js": "^9.0.0",
+    "@next/eslint-plugin-next": "^15.0.0",
+    "eslint": "^9.0.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-prettier": "^5.0.0",
+    "globals": "^15.0.0",
+    "typescript": "^5.7.0",
+    "typescript-eslint": "^8.0.0"
+  },
+  "prettier": "@eng618/prettier-config"
+}

package/src/base.mjs

@@ -0,0 +1,57 @@
+/**
+ * @gv-tech/eslint-config - Base Configuration
+ *
+ * Core ESLint configuration with recommended JavaScript rules.
+ * Uses ESLint v10 flat config format.
+ */
+
+import js from '@eslint/js';
+import globals from 'globals';
+
+/** File patterns for JavaScript files */
+export const jsFiles = ['**/*.js', '**/*.jsx', '**/*.mjs', '**/*.cjs'];
+
+/** Common ignore patterns */
+export const commonIgnores = [
+  '**/node_modules/**',
+  '**/dist/**',
+  '**/build/**',
+  '**/coverage/**',
+  '**/.git/**',
+];
+
+/**
+ * Base ESLint configuration for JavaScript projects.
+ *
+ * @example
+ * ```js
+ * // eslint.config.mjs
+ * import { base } from '@gv-tech/eslint-config';
+ *
+ * export default [...base];
+ * ```
+ */
+export const base = [
+  // Global ignores
+  {
+    ignores: commonIgnores,
+  },
+  // Base configuration for all JS files
+  {
+    files: jsFiles,
+    ...js.configs.recommended,
+    languageOptions: {
+      ecmaVersion: 'latest',
+      sourceType: 'module',
+      globals: {
+        ...globals.node,
+        ...globals.browser,
+      },
+    },
+    linterOptions: {
+      reportUnusedDisableDirectives: 'error',
+    },
+  },
+];
+
+export default base;

package/src/index.mjs

@@ -0,0 +1,56 @@
+/**
+ * @gv-tech/eslint-config
+ *
+ * Shareable ESLint configuration for Garcia Ventures projects.
+ * Supports ESLint v9+ flat config format.
+ *
+ * @example Basic JavaScript
+ * ```js
+ * import { base } from '@gv-tech/eslint-config';
+ * export default [...base];
+ * ```
+ *
+ * @example TypeScript
+ * ```js
+ * import { typescript, prettier } from '@gv-tech/eslint-config';
+ * export default [...typescript, ...prettier];
+ * ```
+ *
+ * @example Next.js
+ * ```js
+ * import { next, prettier } from '@gv-tech/eslint-config';
+ * export default [...next, ...prettier];
+ * ```
+ */
+
+// Import for creating combined presets
+import { base, jsFiles, commonIgnores } from './base.mjs';
+import { typescript, tsFiles, allJsTsFiles } from './typescript.mjs';
+import { next, nextIgnores } from './next.mjs';
+import { prettier } from './prettier.mjs';
+
+// Re-export individual configurations
+export { base, jsFiles, commonIgnores };
+export { typescript, tsFiles, allJsTsFiles };
+export { next, nextIgnores };
+export { prettier };
+
+/**
+ * Recommended configuration for TypeScript projects with Prettier.
+ * Combines TypeScript and Prettier configurations.
+ */
+export const recommended = [...typescript, ...prettier];
+
+/**
+ * Recommended configuration for Next.js projects with Prettier.
+ * Combines Next.js (which includes TypeScript) and Prettier configurations.
+ */
+export const nextjs = [...next, ...prettier];
+
+/**
+ * Base configuration preset for simple JavaScript projects.
+ */
+export const javascript = [...base];
+
+// Default export is the recommended TypeScript + Prettier config
+export default recommended;

package/src/next.mjs

@@ -0,0 +1,53 @@
+/**
+ * @gv-tech/eslint-config - Next.js Configuration
+ *
+ * Next.js 15+ ESLint configuration with Core Web Vitals.
+ * Uses ESLint v9 flat config format.
+ */
+
+import nextPlugin from '@next/eslint-plugin-next';
+import { typescript, allJsTsFiles } from './typescript.mjs';
+import { commonIgnores } from './base.mjs';
+
+/** Next.js specific ignore patterns */
+export const nextIgnores = [
+  ...commonIgnores,
+  '.next/**',
+  'out/**',
+  'next-env.d.ts',
+];
+
+/**
+ * Next.js ESLint configuration.
+ * Extends TypeScript configuration and adds Next.js-specific rules.
+ *
+ * @example
+ * ```js
+ * // eslint.config.mjs
+ * import { next } from '@gv-tech/eslint-config';
+ *
+ * export default [...next];
+ * ```
+ */
+export const next = [
+  // Global ignores including Next.js specific
+  {
+    ignores: nextIgnores,
+  },
+  // Extend TypeScript config
+  ...typescript.filter((config) => !config.ignores),
+  // Next.js plugin configuration
+  {
+    files: allJsTsFiles,
+    plugins: {
+      '@next/next': nextPlugin,
+    },
+    rules: {
+      // Core Web Vitals rules
+      ...nextPlugin.configs.recommended.rules,
+      ...nextPlugin.configs['core-web-vitals'].rules,
+    },
+  },
+];
+
+export default next;

package/src/prettier.mjs

@@ -0,0 +1,47 @@
+/**
+ * @gv-tech/eslint-config - Prettier Configuration
+ *
+ * Prettier integration for ESLint - runs Prettier as an ESLint rule.
+ * Uses @eng618/prettier-config for consistent formatting.
+ * Uses ESLint v9 flat config format.
+ */
+
+import prettierPlugin from 'eslint-plugin-prettier';
+import prettierConfig from 'eslint-config-prettier';
+import { allJsTsFiles } from './typescript.mjs';
+
+/**
+ * Prettier ESLint configuration.
+ * Disables formatting rules that conflict with Prettier and runs Prettier as an ESLint rule.
+ * Uses @eng618/prettier-config for Prettier options.
+ *
+ * @example
+ * ```js
+ * // eslint.config.mjs
+ * import { typescript, prettier } from '@gv-tech/eslint-config';
+ *
+ * export default [...typescript, ...prettier];
+ * ```
+ */
+export const prettier = [
+  // Disable ESLint rules that conflict with Prettier
+  prettierConfig,
+  // Run Prettier as an ESLint rule with @eng618/prettier-config
+  {
+    files: allJsTsFiles,
+    plugins: {
+      prettier: prettierPlugin,
+    },
+    rules: {
+      'prettier/prettier': [
+        'error',
+        {},
+        {
+          usePrettierrc: true, // Will find @eng618/prettier-config via package.json or .prettierrc
+        },
+      ],
+    },
+  },
+];
+
+export default prettier;

package/src/typescript.mjs

@@ -0,0 +1,50 @@
+/**
+ * @gv-tech/eslint-config - TypeScript Configuration
+ *
+ * TypeScript-specific ESLint configuration using typescript-eslint v8.
+ * Uses ESLint v9 flat config format.
+ */
+
+import tseslint from 'typescript-eslint';
+import { base, jsFiles, commonIgnores } from './base.mjs';
+
+/** File patterns for TypeScript files */
+export const tsFiles = ['**/*.ts', '**/*.tsx', '**/*.mts', '**/*.cts'];
+
+/** All JavaScript and TypeScript file patterns */
+export const allJsTsFiles = [...jsFiles, ...tsFiles];
+
+/**
+ * TypeScript ESLint configuration.
+ * Extends base configuration and adds TypeScript-specific rules.
+ *
+ * @example
+ * ```js
+ * // eslint.config.mjs
+ * import { typescript } from '@gv-tech/eslint-config';
+ *
+ * export default [...typescript];
+ * ```
+ */
+export const typescript = [
+  // Global ignores
+  {
+    ignores: commonIgnores,
+  },
+  // Extend base JS config
+  ...base.filter((config) => !config.ignores),
+  // TypeScript configuration
+  ...tseslint.configs.recommended.map((config) => ({
+    ...config,
+    files: tsFiles,
+  })),
+  // Ensure JS files still get base rules
+  {
+    files: jsFiles,
+    rules: {
+      // Any JS-specific overrides if needed
+    },
+  },
+];
+
+export default typescript;