@santi020k/eslint-config-basic 0.1.0 → 0.3.0

package/README.md

@@ -1,275 +1,5 @@
 # @santi020k/eslint-config-basic
 
-[![CI](https://github.com/santi020k/eslint-config/actions/workflows/build.yml/badge.svg)](https://github.com/santi020k/eslint-config/actions/workflows/build.yml)
-[![npm version](https://img.shields.io/npm/v/@santi020k/eslint-config-basic.svg)](https://www.npmjs.com/package/@santi020k/eslint-config-basic)
-[![npm downloads](https://img.shields.io/npm/dm/@santi020k/eslint-config-basic.svg)](https://www.npmjs.com/package/@santi020k/eslint-config-basic)
-[![Docs](https://img.shields.io/badge/docs-TypeDoc-blue.svg)](https://santi020k.github.io/eslint-config-basic/)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+This package is part of the [`@santi020k/eslint-config-basic`](https://github.com/santi020k/eslint-config-basic) monorepo.
 
-Welcome to **@santi020k/eslint-config-basic**, a comprehensive and opinionated ESLint configuration package for JavaScript, TypeScript, React, and other frameworks. Born from a desire to eliminate bad practices and ensure high-quality code, this configuration automates code quality checks and reduces cognitive load during code reviews by enforcing a consistent coding style across your projects.
-
-## Why Use This Configuration?
-
-- **Consistency:** Enforces a uniform coding style, reducing code discrepancies and easing collaboration.
-- **Quality:** Promotes best practices and helps avoid common pitfalls in JavaScript, TypeScript, Frameworks, Libraries, Tools and more.
-- **Automation:** Catches issues early in the development process, minimizing manual code review effort.
-- **Customization:** While it comes with strong opinions, you can tailor it to suit your project's specific needs.
-
-## Installation
-
-Before installing, make sure you have ESLint (version 9.0.0 or later) installed:
-
-```bash
-npm install eslint --save-dev
-```
-
-Then, install the configuration package. **Important:** I recommend using a fixed version (do not use `^` or `~`), as any new functionality or change may introduce new linter errors that require manual updates.
-
-```bash
-npm install @santi020k/eslint-config-basic --save-dev
-```
-
-## Usage
-
-Create an `eslint.config.js` file (or update your existing one) and extend **@santi020k/eslint-config-basic** based on your project type.
-
-### Basic Usage
-
-For a basic JavaScript/Node.js project:
-
-```js
-import { eslintConfig } from '@santi020k/eslint-config-basic'
-
-export default [
-  ...eslintConfig()
-  // Your custom config
-]
-```
-
-### Advanced Usage
-
-For projects that require specific configurations (e.g., TypeScript, React, Next.js, ...Etc), use the appropriate options:
-
-```js
-import { ConfigOption, eslintConfig } from '@santi020k/eslint-config-basic'
-
-// TypeScript project
-export default [
-  ...eslintConfig({ config: [ConfigOption.Ts] })
-  // Your custom config
-]
-
-// React project
-export default [
-  ...eslintConfig({ config: [ConfigOption.React] })
-  // Your custom config
-]
-
-// TypeScript and React project
-export default [
-  ...eslintConfig({ config: [ConfigOption.React, ConfigOption.Ts] })
-  // Your custom config
-]
-
-// Next.js project
-export default [
-  ...eslintConfig({ config: [ConfigOption.Next] })
-  // Your custom config
-]
-
-// Expo project
-export default [
-  ...eslintConfig({ config: [ConfigOption.Expo] })
-  // Your custom config
-]
-
-// Astro project (supports Astro with React)
-export default [
-  ...eslintConfig({ config: [ConfigOption.Astro] })
-  // Your custom config
-]
-
-// NestJS project
-export default [
-  ...eslintConfig({ config: [ConfigOption.Nest] })
-  // Your custom config
-]
-```
-
-### Optional Usage
-
-There are additional optional parameters to add support for other front-end/back-end technologies. This enables you to extend support as needed:
-
-```js
-import { ConfigOption, eslintConfig, OptionalOption } from '@santi020k/eslint-config-basic'
-
-export default [
-  ...eslintConfig({
-    config: [ConfigOption.Next, ConfigOption.Ts],
-    optionals: [
-      // Spell checker
-      OptionalOption.Cspell,
-      // TailwindCss
-      OptionalOption.Tailwind,
-      // Vitest and testing-library
-      OptionalOption.Vitest,
-      // I18next
-      OptionalOption.I18next,
-      // Mdx
-      OptionalOption.Mdx,
-      // Markdown
-      OptionalOption.Markdown,
-      // Stencil
-      OptionalOption.Stencil
-    ]
-  })
-  // Your custom config
-]
-```
-
-### Settings Usage (Experimental)
-
-This experimental option allows ESLint to honor your `.gitignore` file:
-
-```js
-import { eslintConfig, SettingOption } from '@santi020k/eslint-config-basic'
-
-export default [
-  ...eslintConfig({
-    // ESLint will ignore files specified in .gitignore
-    settings: [SettingOption.Gitignore]
-  })
-  // Your custom config
-]
-```
-
-## Monorepo Structure
-
-This project is a monorepo managed with **Turbo** and **npm Workspaces**.
-
-- `packages/basic`: Main package entry point.
-- `packages/core`: Core logic and shared types.
-- `packages/typescript`: TypeScript specific rules.
-- `packages/react`: React and Hooks rules.
-- `packages/next`: Next.js rules.
-- `packages/astro`: Astro rules.
-- `packages/expo`: Expo/React Native rules.
-- `packages/optionals`: Optional configurations (Tailwind, Vitest, etc.).
-- `packages/tests`: Integration tests.
-- `packages/playground`: Testing playground for local development.
-
-## Development
-
-If you want to contribute or modify the configurations:
-
-### Prerequisites
-- Node.js (version specified in `.nvmrc`)
-- npm
-
-### Setup
-```bash
-npm install
-```
-
-### Useful Commands
-```bash
-npm run build      # Build all packages using Turbo
-npm run lint       # Lint all packages
-npm run test       # Run integration tests
-npm run dev        # Development mode with watch
-npm run inspector  # Open ESLint config inspector
-npm run docs       # Generate API documentation
-```
-
-### ESLint Config Inspector
-
-You can visually inspect the generated ESLint configuration using the built-in inspector:
-
-```bash
-npm run inspector
-```
-
-This opens an interactive UI where you can see all active rules, plugins, and config layers. It's useful for debugging which rules are applied and understanding the final merged configuration.
-
-### API Documentation
-
-### API Documentation
-
-Auto-generated API docs are available online:
-[**https://santi020k.github.io/eslint-config-basic/**](https://santi020k.github.io/eslint-config-basic/)
-
-You can also generate them locally:
-
-```bash
-npm run docs
-```
-
-This outputs markdown documentation to the `docs/` directory.
-
-## Opinionated but Flexible
-
-This ESLint configuration is based on my personal preferences and practices, and it may evolve over time. **Important:** I recommend using a fixed version to avoid unexpected changes that might introduce new linter errors. To ensure stability, do not use `^` or `~` when specifying the version. If a rule feels too strict, consider changing it from an error to a warning to allow more flexibility during development.
-
-## Scripts
-
-Add the following useful scripts to your `package.json`:
-
-```json
-"scripts": {
-  "lint": "eslint . --report-unused-disable-directives",
-  "lint:fix": "npm run lint -- --fix"
-}
-```
-
-## How to Implement in an Existing Project
-
-1.  **Install the Dependencies:** Ensure that both ESLint and this configuration package are installed.
-2.  **Update Your ESLint Configuration:** Extend **@santi020k/eslint-config-basic** in your ESLint configuration file as shown above.
-3.  **Run ESLint:** Lint your project files and automatically fix issues if possible:
-
-    ```bash
-    npm run lint
-    npm run lint:fix
-    ```
-
-4.  **Adjust as Necessary:** Review and modify the linting rules based on your project's needs. Some rules might be too strict or not applicable; feel free to disable or adjust them.
-
-## Future Features
-
-- [x] Testing
-- [x] Refactored rules structure (Monorepo transition)
-- [x] Astro and Expo support
-- [x] Enhanced documentation
-- [ ] Additional framework support (contributions welcome!):
-  - [ ] Vue
-  - [ ] Angular
-  - [x] NestJS
-
-## Contributing
-
-Contributions are welcome! Please read the [Contributing Guide](CONTRIBUTING.md) for details on setting up the project, adding new configurations, and submitting pull requests.
-
-## Acknowledgements
-
-Special thanks to the developers and maintainers of the following libraries, which form the backbone of this ESLint configuration:
-
-- eslint-config-standard
-- eslint-plugin-import
-- eslint-plugin-jsx-a11y
-- eslint-plugin-n
-- eslint-plugin-promise
-- eslint-plugin-react
-- eslint-plugin-react-hooks
-- eslint-plugin-simple-import-sort
-- eslint-plugin-sonarjs
-- eslint-plugin-unused-imports
-- @stylistic/eslint-plugin
-- @typescript-eslint
-- @cspell/eslint-plugin
-- eslint-plugin-tailwindcss
-- eslint-plugin-vitest
-- ...and many others
-
-Their ongoing contributions help maintain the high standards of code quality we all strive for.
-
-Thank you for using **@santi020k/eslint-config-basic**. Together, let's write cleaner, more maintainable code!
+For full usage instructions, installation guides, and documentation, please see the [Main Repository README](https://github.com/santi020k/eslint-config-basic/blob/main/README.md).

package/dist/index.d.ts

@@ -0,0 +1,21 @@
+import { EslintConfigOptions, FlatConfigArray } from '@santi020k/eslint-config-core';
+export { ConfigOption, EslintConfigOptions, FlatConfigArray, OptionalOption, ReactConfigs, SettingOption, applyConfigIfOptionPresent, coreConfig, gitignore, hasReactConfig, jsConfig } from '@santi020k/eslint-config-core';
+export { tsConfig, typescriptConfig } from '@santi020k/eslint-config-typescript';
+export { reactConfig } from '@santi020k/eslint-config-react';
+export { nextConfig } from '@santi020k/eslint-config-next';
+export { astroConfig } from '@santi020k/eslint-config-astro';
+export { expoConfig } from '@santi020k/eslint-config-expo';
+export { nestConfig } from '@santi020k/eslint-config-nest';
+export { vueConfig } from '@santi020k/eslint-config-vue';
+export { cspell, i18next, markdown, mdx, prettier, regexp, stencil, tailwind, unicorn, vitest } from '@santi020k/eslint-config-optionals';
+
+/**
+ * Generates the ESLint configuration array, applying configurations
+ * and optional settings based on the input configuration.
+ *
+ * @param {EslintConfigOptions} options - Configuration and optional settings
+ * @returns {FlatConfigArray} The final ESLint configuration array
+ */
+declare const eslintConfig: ({ config, optionals, settings }?: EslintConfigOptions) => FlatConfigArray;
+
+export { eslintConfig };

package/dist/index.js

@@ -0,0 +1,127 @@
+// src/index.ts
+import {
+  ConfigOption,
+  OptionalOption,
+  SettingOption,
+  ReactConfigs,
+  applyConfigIfOptionPresent,
+  hasReactConfig,
+  coreConfig,
+  jsConfig,
+  gitignore
+} from "@santi020k/eslint-config-core";
+import { typescriptConfig, tsConfig } from "@santi020k/eslint-config-typescript";
+import { reactConfig } from "@santi020k/eslint-config-react";
+import { nextConfig } from "@santi020k/eslint-config-next";
+import { astroConfig } from "@santi020k/eslint-config-astro";
+import { expoConfig } from "@santi020k/eslint-config-expo";
+import { nestConfig } from "@santi020k/eslint-config-nest";
+import { vueConfig } from "@santi020k/eslint-config-vue";
+import {
+  cspell,
+  i18next,
+  markdown,
+  mdx,
+  prettier,
+  regexp,
+  stencil,
+  tailwind,
+  unicorn,
+  vitest
+} from "@santi020k/eslint-config-optionals";
+import { astroConfig as astroConfig2 } from "@santi020k/eslint-config-astro";
+import {
+  applyConfigIfOptionPresent as applyConfigIfOptionPresent2,
+  ConfigOption as ConfigOption2,
+  coreConfig as coreConfig2,
+  gitignore as gitignore2,
+  hasReactConfig as hasReactConfig2,
+  OptionalOption as OptionalOption2,
+  SettingOption as SettingOption2
+} from "@santi020k/eslint-config-core";
+import { expoConfig as expoConfig2 } from "@santi020k/eslint-config-expo";
+import { nestConfig as nestConfig2 } from "@santi020k/eslint-config-nest";
+import { nextConfig as nextConfig2 } from "@santi020k/eslint-config-next";
+import {
+  cspell as cspell2,
+  i18next as i18next2,
+  markdown as markdown2,
+  mdx as mdx2,
+  prettier as prettier2,
+  regexp as regexp2,
+  stencil as stencil2,
+  tailwind as tailwind2,
+  unicorn as unicorn2,
+  vitest as vitest2
+} from "@santi020k/eslint-config-optionals";
+import { reactConfig as reactConfig2 } from "@santi020k/eslint-config-react";
+import { typescriptConfig as typescriptConfig2 } from "@santi020k/eslint-config-typescript";
+import { vueConfig as vueConfig2 } from "@santi020k/eslint-config-vue";
+var eslintConfig = ({
+  config = [],
+  optionals = [],
+  settings = []
+} = {}) => {
+  const uniqueConfig = [...new Set(config)];
+  const uniqueOptionals = [...new Set(optionals)];
+  const uniqueSettings = [...new Set(settings)];
+  const hasReact = hasReactConfig2(uniqueConfig);
+  const useGitignore = !uniqueSettings.includes(SettingOption2.NoGitignore);
+  return [
+    // Settings
+    ...useGitignore ? gitignore2 : [],
+    // Core JS config (always included)
+    ...coreConfig2,
+    // React config (included if any React-based framework is used)
+    ...hasReact ? reactConfig2 : [],
+    // Framework-specific configs
+    ...applyConfigIfOptionPresent2(uniqueConfig, ConfigOption2.Ts, typescriptConfig2),
+    ...applyConfigIfOptionPresent2(uniqueConfig, ConfigOption2.Next, nextConfig2),
+    ...applyConfigIfOptionPresent2(uniqueConfig, ConfigOption2.Astro, astroConfig2),
+    ...applyConfigIfOptionPresent2(uniqueConfig, ConfigOption2.Expo, expoConfig2),
+    ...applyConfigIfOptionPresent2(uniqueConfig, ConfigOption2.Nest, nestConfig2),
+    ...applyConfigIfOptionPresent2(uniqueConfig, ConfigOption2.Vue, vueConfig2),
+    // Optionals
+    ...uniqueOptionals.includes(OptionalOption2.Cspell) ? cspell2 : [],
+    ...uniqueOptionals.includes(OptionalOption2.Tailwind) ? tailwind2 : [],
+    ...uniqueOptionals.includes(OptionalOption2.Vitest) ? vitest2 : [],
+    ...uniqueOptionals.includes(OptionalOption2.I18next) ? i18next2 : [],
+    ...uniqueOptionals.includes(OptionalOption2.Stencil) ? stencil2 : [],
+    ...uniqueOptionals.includes(OptionalOption2.Regexp) ? regexp2 : [],
+    ...uniqueOptionals.includes(OptionalOption2.Mdx) ? mdx2 : [],
+    ...uniqueOptionals.includes(OptionalOption2.Markdown) ? markdown2 : [],
+    ...uniqueOptionals.includes(OptionalOption2.Unicorn) ? unicorn2 : [],
+    // Prettier must be last to override stylistic rules
+    ...uniqueOptionals.includes(OptionalOption2.Prettier) ? prettier2 : []
+  ];
+};
+export {
+  ConfigOption,
+  OptionalOption,
+  ReactConfigs,
+  SettingOption,
+  applyConfigIfOptionPresent,
+  astroConfig,
+  coreConfig,
+  cspell,
+  eslintConfig,
+  expoConfig,
+  gitignore,
+  hasReactConfig,
+  i18next,
+  jsConfig,
+  markdown,
+  mdx,
+  nestConfig,
+  nextConfig,
+  prettier,
+  reactConfig,
+  regexp,
+  stencil,
+  tailwind,
+  tsConfig,
+  typescriptConfig,
+  unicorn,
+  vitest,
+  vueConfig
+};

package/package.json

@@ -1,61 +1,58 @@
 {
   "name": "@santi020k/eslint-config-basic",
-  "private": false,
-  "publishConfig": {
-    "access": "public"
-  },
-  "homepage": "https://santi020k.github.io/eslint-config-basic/",
-  "version": "0.1.0",
+  "version": "0.3.0",
+  "description": "A comprehensive ESLint configuration package for JavaScript, TypeScript, and React projects.",
   "type": "module",
-  "packageManager": "npm@10.8.3",
-  "workspaces": [
-    "packages/*"
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
   ],
   "scripts": {
-    "dev": "turbo run dev",
-    "build": "turbo run build",
-    "lint": "turbo run lint",
-    "lint:fix": "turbo run lint:fix",
-    "test": "vitest run packages/tests",
-    "clean": "turbo run clean && rm -rf node_modules",
-    "prepare": "husky config/.husky",
-    "pre-commit": "lint-staged",
-    "pre-push": "npm run test && npm run lint && npm run build",
-    "docs": "typedoc",
-    "docs:md": "typedoc --options typedoc.markdown.mjs",
-    "docs:clean": "rm -rf docs docs-md"
+    "build": "tsup",
+    "build:pack": "npm pack",
+    "dev": "tsup --watch",
+    "clean": "rm -rf dist",
+    "check:exports": "publint"
   },
-  "devDependencies": {
-    "commitizen": "^4.3.1",
-    "cz-conventional-changelog": "^3.3.0",
-    "eslint": "^9.39.2",
-    "eslint-config-standard": "^17.1.0",
-    "eslint-plugin-n": "^17.23.2",
-    "eslint-plugin-promise": "^7.2.1",
-    "husky": "^9.1.7",
-    "lint-staged": "^16.2.7",
-    "turbo": "^2.5.3",
-    "typedoc": "^0.28.16",
-    "typedoc-plugin-markdown": "^4.10.0",
-    "vitest": "^4.0.18"
+  "dependencies": {
+    "@santi020k/eslint-config-astro": "*",
+    "@santi020k/eslint-config-core": "*",
+    "@santi020k/eslint-config-expo": "*",
+    "@santi020k/eslint-config-nest": "*",
+    "@santi020k/eslint-config-next": "*",
+    "@santi020k/eslint-config-optionals": "*",
+    "@santi020k/eslint-config-react": "*",
+    "@santi020k/eslint-config-typescript": "*",
+    "@santi020k/eslint-config-vue": "*",
+    "@eslint/compat": "^2.0.3",
+    "@eslint/js": "^10.0.1",
+    "@typescript-eslint/eslint-plugin": "^8.57.0",
+    "@typescript-eslint/type-utils": "^8.57.0",
+    "cross-dirname": "^0.1.0",
+    "eslint": "^10.0.3",
+    "typescript-eslint": "^8.57.0"
   },
-  "lint-staged": {
-    "*.{js,jsx,ts,tsx,md}": [
-      "eslint --fix"
-    ]
+  "devDependencies": {
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3",
+    "@typescript-eslint/utils": "^8.57.0"
   },
-  "config": {
-    "commitizen": {
-      "path": "./node_modules/cz-conventional-changelog"
-    }
+  "publishConfig": {
+    "access": "public"
   },
-  "overrides": {
-    "eslint": "$eslint",
-    "eslint-config-standard": "$eslint-config-standard",
-    "eslint-plugin-promise": "$eslint-plugin-promise",
-    "eslint-plugin-n": "$eslint-plugin-n",
-    "lodash": "^4.17.23",
-    "minimist": "^1.2.6",
-    "tmp": "^0.2.3"
+  "license": "MIT",
+  "author": "santi020k",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/santi020k/eslint-config-basic.git",
+    "directory": "packages/basic"
   }
 }

package/.agent/rules/context.md

@@ -1,78 +0,0 @@
----
-trigger: always_on
----
-
-# Context
-
-## Priority Reading Order
-
-1. **`llms.txt`** - Project overview and architecture
-2. **`../../src/index.ts`** - Main entry point with enums and config function
-3. **`./guidelines.md`** - Detailed coding guidelines
-
-## Project Summary
-
-This is `@santi020k/eslint-config`, a composable ESLint 9 Flat Config package supporting:
-- JavaScript, TypeScript, React, Next.js, Astro, Expo
-- Optional integrations: Tailwind, Vitest, cspell, i18next, MDX, Markdown, Stencil
-
-## Monorepo Architecture
-
-This project uses **Turborepo** with **npm Workspaces** for modular package management.
-
-### Package Structure
-| Package | Location | Purpose |
-|---------|----------|---------|
-| `@santi020k/eslint-config-core` | `packages/core` | Base JS config, utilities, types |
-| `@santi020k/eslint-config-typescript` | `packages/typescript` | TypeScript rules |
-| `@santi020k/eslint-config-react` | `packages/react` | React + Hooks |
-| `@santi020k/eslint-config-next` | `packages/next` | Next.js core-web-vitals |
-
-### Dependency Graph
-```
-core → typescript → react → next
-```
-
-## Key Architecture Decisions
-
-### Flat Config Only
-This package only supports ESLint 9+ flat config format. No legacy `.eslintrc` support.
-
-### Composable Design
-Users select configs via enums rather than extending named configs:
-```js
-eslintConfig({ config: [ConfigOption.React, ConfigOption.Ts] })
-```
-
-### Dependency Alignment
-Uses npm `overrides` with `$` references to align peer dependency versions across the plugin ecosystem.
-
-## Validation Workflow
-
-Always validate changes with:
-```bash
-npm run build && npm run lint && npm run test
-```
-
-All commands must pass before considering work complete.
-
-## Known Issues / Gotchas
-
-1. **FlatCompat issues**: Some legacy plugins don't resolve correctly. Use direct plugin object imports.
-2. **TS2742 errors**: Export explicit types when inferred types reference internal modules.
-3. **Plugin version conflicts**: Check `overrides` in package.json when adding new ESLint plugins.
-4. **Workspace lint**: Lint runs from root only, not from individual packages.
-
-## File Modification Patterns
-
-### When adding a new framework config (as a package):
-1. Create `packages/{name}/` with `package.json`, `tsconfig.json`, `tsup.config.ts`
-2. Create `packages/{name}/src/index.ts` exporting the config
-3. Add to `ConfigOption` enum in `packages/core/src/types.ts`
-4. Wire into `eslintConfig()` function in `src/index.ts`
-
-### When adding a new optional:
-1. Create `src/optionals/{name}.ts`
-2. Export from `src/optionals/index.ts`
-3. Add to `OptionalOption` enum in `packages/core/src/types.ts`
-4. Wire into `eslintConfig()` function