@santi020k/eslint-config-basic 0.1.0

package/.agent/rules/context.md

@@ -0,0 +1,78 @@
+---
+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

package/.agent/rules/guidelines.md

@@ -0,0 +1,124 @@
+---
+trigger: always_on
+---
+
+# AI Coding Assistant Guidelines
+
+This document provides guidance for AI coding assistants working on @santi020k/eslint-config.
+
+## Project Overview
+
+This is an ESLint configuration package using **ESLint 9 Flat Config** format. It exports a composable `eslintConfig()` function.
+
+The project is a **monorepo** using Turborepo and npm Workspaces.
+
+## Key Files to Understand
+
+### Root Level
+- `src/index.ts` - Main entry point, re-exports from packages + composes configs
+- `turbo.json` - Turborepo build configuration
+- `eslint.config.js` - ESLint config for this repo
+- `vitest.config.ts` - Test configuration
+
+### Packages
+- `packages/core/src/index.ts` - Core config, types, utilities
+- `packages/typescript/src/index.ts` - TypeScript config
+- `packages/react/src/index.ts` - React + Hooks config
+- `packages/next/src/index.ts` - Next.js config
+
+### Tests
+- `tests/configs.test.ts` - Config export tests
+- `tests/rules.test.ts` - Rule validation tests
+- `tests/composition.test.ts` - eslintConfig() composition tests
+
+## Code Conventions
+
+### TypeScript
+- Use explicit type annotations for exports
+- Explicit return types on exported functions
+- Use `type` imports when importing only types (`import type { X } from 'y'`)
+- Follow the existing enum patterns (`ConfigOption`, `OptionalOption`, `SettingOption`)
+- Prefer `const` assertions where appropriate
+
+### Imports
+- Use `.js` extension for relative imports (ESM compatibility)
+- Sort imports: external first, then internal with blank line
+
+### Naming Conventions
+- Config arrays: `camelCaseConfig` (e.g., `reactConfig`, `tsConfig`)
+- Enums: `PascalCase` (e.g., `ConfigOption`, `OptionalOption`)
+- Files: `kebab-case.ts` or `index.ts` for main exports
+
+### ESLint Configs
+- All configs return `TSESLint.FlatConfig.ConfigArray`
+- Each package exports a main config array
+- Rules are organized into separate files when complex
+- Preferred flat config pattern:
+  ```typescript
+  export const myConfig: TSESLint.FlatConfig.ConfigArray = [
+    {
+      name: 'my-config/rules',
+      rules: {
+        'rule-name': 'error'
+      }
+    }
+  ]
+  ```
+
+### Package Structure
+Each package under `packages/` follows this structure:
+```
+packages/{name}/
+├── package.json
+├── tsconfig.json
+├── tsup.config.ts
+└── src/
+    ├── index.ts      # Main export
+    ├── rules.ts      # Rule definitions (optional)
+    └── ambient.d.ts  # Type declarations for plugins (if needed)
+```
+
+## Adding New Features
+
+### New Framework Config (as package)
+```bash
+# 1. Create package directory
+mkdir -p packages/myframework/src
+
+# 2. Create package.json with dependencies
+# 3. Create tsconfig.json extending base
+# 4. Create tsup.config.ts
+# 5. Create src/index.ts with config
+# 6. Add enum value to packages/core/src/types.ts
+# 7. Wire into src/index.ts eslintConfig()
+```
+
+### New Optional
+```typescript
+// src/optionals/myoptional.ts
+import type { TSESLint } from '@typescript-eslint/utils'
+
+export const myoptional: TSESLint.FlatConfig.ConfigArray = [
+  // optional rules
+]
+
+// Add to src/optionals/index.ts
+// Add enum value to packages/core/src/types.ts
+```
+
+## Verification Commands
+
+```bash
+npm run build      # Turborepo builds all packages
+npm run lint       # Lints entire monorepo from root
+npm run test       # Runs Vitest (30 tests)
+npm run inspector  # Visual config inspection
+```
+
+## Common Pitfalls
+
+1. **Peer dependencies**: Use `$` references in overrides for version alignment
+2. **Plugin loading**: Use direct plugin object references, not string-based resolution
+3. **Type exports**: May need explicit type annotations to avoid TS2742 errors
+4. **Ambient declarations**: Create `.d.ts` files for plugins without TypeScript types
+5. **Workspace lint**: Don't add lint scripts to individual packages - lint runs from root only

package/.editorconfig

@@ -0,0 +1,13 @@
+# Editor configuration, see http://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+max_line_length = off
+trim_trailing_whitespace = false

package/.env.example

@@ -0,0 +1,8 @@
+# GitHub Personal Access Token — used by the release workflow to create
+# GitHub Releases and push changelog commits. Requires `repo` scope.
+PA_TOKEN=
+
+# npm Access Token — used by the publish workflow to publish the
+# @santi020k/eslint-config-basic package to the npm registry.
+# Generate at https://www.npmjs.com/settings/<user>/tokens
+NPM_TOKEN=

package/.github/CODEOWNERS

@@ -0,0 +1,2 @@
+# Users who can approve a pr of any part of the project
+* @santi020k

package/.github/DISCUSSION_TEMPLATE/rfcs.yml

@@ -0,0 +1,21 @@
+body:
+  - attributes:
+      label: RFC
+      value: |
+        Suggested changes...
+    id: rfc
+    type: textarea
+  - attributes:
+      label: Additional Info
+      value: |
+        Any additional info...
+    id: additional
+    type: textarea
+  - attributes:
+      label: Before you submit your RFC, please confirm the following. If any of these required steps are not taken, we may not be able to review your RFC. Help us to help you!
+      options:
+        - label: I have searched for related discussions and issues.
+          required: true
+    id: required-checks
+    type: checkboxes
+title: Your Title Here

package/.github/DISCUSSION_TEMPLATE/technical-discussions.yml

@@ -0,0 +1,21 @@
+body:
+  - attributes:
+      label: Body
+      value: |
+        Body of the technical discussion...
+    id: body
+    type: textarea
+  - attributes:
+      label: Additional Info
+      value: |
+        Any additional info...
+    id: additional
+    type: textarea
+  - attributes:
+      label: Before you submit your discussion, please confirm the following. If any of these required steps are not taken, we may not be able to review your RFC. Help us to help you!
+      options:
+        - label: I have searched for related discussions and issues.
+          required: true
+    id: required-checks
+    type: checkboxes
+title: Your Title Here

package/.github/FUNDING.yml

@@ -0,0 +1,2 @@
+ko_fi: santi020k
+github: santi020k

package/.github/ISSUE_TEMPLATE/README.md

@@ -0,0 +1,13 @@
+# Issue Templates
+
+## Documentation
+
+[Syntax for issue forms (the top level properties)](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms)
+
+[Syntax for GitHub's form schema (the form body)](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema)
+
+[Configuring the template chooser (config.yml)](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser)
+
+## Template Chooser Sorting
+
+The templates are sorted in the template chooser based on the filename, not on the form name. This is why we have prefixed the filenames with numbers.

package/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,69 @@
+name: 🐛 Bug Report
+description: Create a report to help us improve
+title: "[Bug]: "
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: A clear and concise description of what the bug is.
+      placeholder: When I run eslint, it crashes with error...
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Reproduction
+      description: |
+        Please provide a link to a reproduction repository or a minimal code snippet.
+        This is critical for us to understand and fix the issue.
+      placeholder: |
+        1. create a new project with...
+        2. install @santi020k/eslint-config-basic
+        3. run eslint .
+    validations:
+      required: true
+
+  - type: checkboxes
+    id: packages
+    attributes:
+      label: Packages Affected
+      description: Select the packages that seem to be causing the issue.
+      options:
+        - label: "@santi020k/eslint-config-basic"
+        - label: "@santi020k/eslint-config-core"
+        - label: "@santi020k/eslint-config-typescript"
+        - label: "@santi020k/eslint-config-react"
+        - label: "@santi020k/eslint-config-next"
+        - label: "@santi020k/eslint-config-astro"
+        - label: "@santi020k/eslint-config-expo"
+
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: Expected Behavior
+      description: A clear and concise description of what you expected to happen.
+    validations:
+      required: true
+
+  - type: input
+    id: environment
+    attributes:
+      label: Environment Info
+      description: |
+        Create a report using `npx envinfo --system --binaries --browsers --npmPackages "{eslint,@santi020k/*,typescript}"`
+      placeholder: |
+        System:
+          OS: macOS 14.0
+        Binaries:
+          Node: 20.10.0
+          npm: 10.2.3
+    validations:
+      required: false

package/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Global ESLint Config Docs
+    url: https://eslint.org/docs/latest/use/configure/configuration-files
+    about: Official ESLint configuration documentation
+  - name: GitHub Discussions
+    url: https://github.com/santi020k/eslint-config/discussions
+    about: Ask questions and discuss ideas

package/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,43 @@
+name: ✨ Feature Request
+description: Suggest an idea for this project
+title: "[Feature]: "
+labels: ["enhancement"]
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Is your feature request related to a problem? Please describe.
+      description: A clear and concise description of what the problem is.
+      placeholder: I'm always frustrated when...
+    validations:
+      required: true
+
+  - type: checkboxes
+    id: packages
+    attributes:
+      label: Packages Affected
+      description: Select the packages relevant to this feature.
+      options:
+        - label: "@santi020k/eslint-config-basic"
+        - label: "@santi020k/eslint-config-core"
+        - label: "@santi020k/eslint-config-typescript"
+        - label: "@santi020k/eslint-config-react"
+        - label: "@santi020k/eslint-config-next"
+        - label: "@santi020k/eslint-config-astro"
+        - label: "@santi020k/eslint-config-expo"
+
+  - type: textarea
+    id: solution
+    attributes:
+      label: Describe the solution you'd like
+      description: A clear and concise description of what you want to happen.
+    validations:
+      required: true
+
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Describe alternatives you've considered
+      description: A clear and concise description of any alternative solutions or features you've considered.
+    validations:
+      required: false

package/.github/ISSUE_TEMPLATE/question.yml

@@ -0,0 +1,22 @@
+name: ❓ Question / Support
+description: Ask a question about using this configuration
+title: "[Question]: "
+labels: ["question"]
+body:
+  - type: textarea
+    id: question
+    attributes:
+      label: Question
+      description: What would you like to know?
+      placeholder: How do I configure...
+    validations:
+      required: true
+
+  - type: textarea
+    id: context
+    attributes:
+      label: Relevant Code / Context
+      description: Please provide any relevant code snippets or configuration details.
+      render: typescript
+    validations:
+      required: false

package/.github/SECURITY.md

@@ -0,0 +1,12 @@
+# Security Policy
+
+I take all security vulnerabilities seriously.
+If you have a vulnerability or other security issues to disclose:
+
+- Thank you very much, please do!
+- Please send them to us by emailing `info@santi020k.me`
+
+We appreciate your efforts and responsible disclosure and will make every effort to acknowledge your contributions.
+
+> We also adhere to the [Tidelift security process](https://support.tidelift.com/hc/en-us/articles/4406287910036-Security-process).
+> See [https://tidelift.com/security](https://tidelift.com/security).

package/.github/SPONSORSHIPS.md

@@ -0,0 +1,27 @@
+# Sponsorship
+
+`@santi020k/eslint-config-basic` is an entirely volunteer-run project.
+I am not associated with any company or organization; development is funded solely from community donations.
+
+## Why Sponsor `@santi020k/eslint-config-basic`?
+
+This ESLint configuration is designed to help developers maintain clean and consistent codebases. Sponsoring this project helps ensure continued development and support for the broader JavaScript and TypeScript ecosystems. By supporting `@santi020k/eslint-config-basic`, you help:
+
+- Support updates and improvements to the ESLint configuration
+- Continue enhancing documentation and user experience
+- Fix bugs and add new features to the ESLint rules and configurations
+- Develop more advanced rules to ensure code correctness and maintainability
+
+### Sponsorship Benefits
+
+In addition to supporting the development of this library, sponsoring on Open Collective helps promote your company and development brand.
+Top sponsors may have their link, logo, and/or name featured on the project's GitHub page.
+
+> Got an idea for how to make sponsorship work for you?
+> Let me know at `info@santi020k.me`!
+
+## Sponsorship Limitations
+
+### Project Direction
+
+While sponsorship is greatly appreciated, it does not influence issue prioritization or pull request reviews. If you need to push forward specific work in `@santi020k/eslint-config-basic` more urgently than a general donation can provide, consider contributing engineering time as well.

package/.github/dependabot.yml

@@ -0,0 +1,45 @@
+version: 2
+
+updates:
+  # npm dependencies
+  - package-ecosystem: npm
+    directory: /
+    schedule:
+      interval: weekly
+      day: monday
+    open-pull-requests-limit: 10
+    groups:
+      eslint-plugins:
+        patterns:
+          - 'eslint-*'
+          - '@eslint/*'
+          - '@typescript-eslint/*'
+          - 'typescript-eslint'
+          - '@stylistic/*'
+          - '@cspell/*'
+      build-tools:
+        patterns:
+          - 'tsup'
+          - 'typescript'
+          - 'turbo'
+      testing:
+        patterns:
+          - 'vitest'
+      linting-tools:
+        patterns:
+          - 'husky'
+          - 'lint-staged'
+          - 'commitizen'
+          - 'cz-*'
+
+  # GitHub Actions
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly
+      day: monday
+    open-pull-requests-limit: 5
+    groups:
+      actions:
+        patterns:
+          - '*'

package/.github/labeler.yml

@@ -0,0 +1,46 @@
+core:
+  - changed-files:
+      - any-glob-to-any-file: 'packages/core/**'
+
+typescript:
+  - changed-files:
+      - any-glob-to-any-file: 'packages/typescript/**'
+
+react:
+  - changed-files:
+      - any-glob-to-any-file: 'packages/react/**'
+
+next:
+  - changed-files:
+      - any-glob-to-any-file: 'packages/next/**'
+
+astro:
+  - changed-files:
+      - any-glob-to-any-file: 'packages/astro/**'
+
+expo:
+  - changed-files:
+      - any-glob-to-any-file: 'packages/expo/**'
+
+optionals:
+  - changed-files:
+      - any-glob-to-any-file: 'packages/optionals/**'
+
+basic:
+  - changed-files:
+      - any-glob-to-any-file: 'packages/basic/**'
+
+tests:
+  - changed-files:
+      - any-glob-to-any-file: 'packages/tests/**'
+
+ci:
+  - changed-files:
+      - any-glob-to-any-file: '.github/**'
+
+docs:
+  - changed-files:
+      - any-glob-to-any-file:
+          - '*.md'
+          - 'packages/*/README.md'
+          - 'llms.txt'

package/.github/pull_request_template.md

@@ -0,0 +1,56 @@
+
+# � Pull Request
+
+## Description
+
+<!--
+Please include a summary of the change and which issue is fixed.
+Please also include relevant motivation and context.
+-->
+
+## Related Issue
+
+<!--
+Link to the issue this PR resolves, e.g. "Resolves #123"
+-->
+
+## Type of Change
+
+<!-- Please delete options that are not relevant. -->
+
+- [ ] ✨ New feature (non-breaking change which adds functionality)
+- [ ] 🛠️ Bug fix (non-breaking change which fixes an issue)
+- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to change)
+- [ ] 🧹 Refactor (no functional changes, no api changes)
+- [ ] 🧪 Tests (adding missing tests or correcting existing tests)
+- [ ] 📚 Documentation (updating documentation)
+- [ ] ⚙️ CI/CD (updates to workflows or build scripts)
+
+## Packages Affected
+
+<!-- Check all that apply -->
+
+- [ ] `basic` (@santi020k/eslint-config-basic)
+- [ ] `core` (@santi020k/eslint-config-core)
+- [ ] `typescript` (@santi020k/eslint-config-typescript)
+- [ ] `react` (@santi020k/eslint-config-react)
+- [ ] `next` (@santi020k/eslint-config-next)
+- [ ] `astro` (@santi020k/eslint-config-astro)
+- [ ] `expo` (@santi020k/eslint-config-expo)
+- [ ] `optionals` (@santi020k/eslint-config-optionals)
+- [ ] `tests` (internal tests)
+
+## Checklist
+
+- [ ] I have read the [CONTRIBUTING](../CONTRIBUTING.md) guide
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes (`npm test`)
+- [ ] I have run the build script and it passes (`npm run build`)
+
+## Screenshots (if applicable)
+
+<!-- Add screenshots here if your changes affect the UI or documentation output. -->

package/.github/workflows/assign-issues.yml

@@ -0,0 +1,18 @@
+name: Issue assignment
+
+on:
+  issues:
+    types: [opened]
+
+jobs:
+  auto-assign:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+    steps:
+      - name: 'Auto-assign issue'
+        uses: pozil/auto-assign-issue@v2
+        with:
+          assignees: santi020k
+          numOfAssignee: 1
+          allowSelfAssign: true

package/.github/workflows/audit.yml

@@ -0,0 +1,22 @@
+name: Security Audit
+
+on:
+  pull_request:
+    branches: [main]
+  schedule:
+    - cron: '0 9 * * 1' # Every Monday at 9am UTC
+
+jobs:
+  audit:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v6
+      - name: Setup Node
+        uses: actions/setup-node@v6
+        with:
+          node-version: '22'
+          cache: 'npm'
+      - run: npm ci
+      - name: Run npm audit
+        run: npm audit --audit-level=moderate