@santi020k/eslint-config-basic 0.1.0 → 0.4.0

package/packages/optionals/README.md

@@ -1,18 +0,0 @@
-# @santi020k/eslint-config-optionals
-
-Optional ESLint configurations for various tools and libraries.
-
-## Description
-
-This package provides optional configurations for:
-- Tailwind CSS
-- Vitest
-- CSpell
-- i18next
-- MDX
-- Markdown
-- Stencil.js
-
-## Usage
-
-These configurations are activated via the `optionals` array in the main `eslintConfig` function.

package/packages/optionals/package.json

@@ -1,55 +0,0 @@
-{
-  "name": "@santi020k/eslint-config-optionals",
-  "version": "0.0.0",
-  "description": "Optional ESLint configurations for various tools and frameworks",
-  "type": "module",
-  "main": "./dist/index.js",
-  "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "exports": {
-    ".": {
-      "import": "./dist/index.js",
-      "types": "./dist/index.d.ts"
-    }
-  },
-  "files": [
-    "dist"
-  ],
-  "scripts": {
-    "build": "tsup",
-    "dev": "tsup --watch",
-    "clean": "rm -rf dist"
-  },
-  "peerDependencies": {
-    "eslint": "^9.0.0"
-  },
-  "dependencies": {
-    "@cspell/eslint-plugin": "^9.6.4",
-    "@eslint/compat": "^2.0.2",
-    "@eslint/eslintrc": "^3.3.1",
-    "@eslint/markdown": "^7.5.1",
-    "@stencil-community/eslint-plugin": "^0.10.0",
-    "cross-dirname": "^0.1.0",
-    "eslint-plugin-i18next": "^6.1.3",
-    "eslint-plugin-mdx": "^3.6.2",
-    "eslint-plugin-tailwindcss": "^3.18.2",
-    "eslint-plugin-testing-library": "^7.15.4",
-    "eslint-plugin-vitest": "^0.5.4",
-    "globals": "^17.3.0"
-  },
-  "devDependencies": {
-    "@typescript-eslint/utils": "^8.54.0",
-    "tsup": "^8.5.1",
-    "typescript": "^5.9.3"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "license": "MIT",
-  "author": "santi020k",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/santi020k/eslint-config.git",
-    "directory": "packages/optionals"
-  }
-}

package/packages/optionals/src/ambient.d.ts

@@ -1,25 +0,0 @@
-declare module 'cross-dirname' {
-  export function getDirname(): string
-}
-
-declare module '@stencil-community/eslint-plugin' {
-  const plugin: {
-    rules: Record<string, unknown>
-  }
-  export default plugin
-}
-
-declare module 'eslint-plugin-tailwindcss' {
-  import type { TSESLint } from '@typescript-eslint/utils'
-  const plugin: {
-    configs: {
-      'flat/recommended': TSESLint.FlatConfig.ConfigArray
-    }
-  }
-  export default plugin
-}
-
-declare module 'eslint-plugin-i18next' {
-  const plugin: unknown
-  export default plugin
-}

package/packages/optionals/src/cspell.ts

@@ -1,14 +0,0 @@
-import pluginCspell from '@cspell/eslint-plugin'
-
-import type { TSESLint } from '@typescript-eslint/utils'
-
-/**
- * CSpell ESLint configuration
- * Enables spell checking in your codebase
- */
-export const cspell: TSESLint.FlatConfig.ConfigArray = [
-  {
-    name: 'optionals/cspell',
-    plugins: { '@cspell': pluginCspell }
-  }
-]

package/packages/optionals/src/i18next.ts

@@ -1,19 +0,0 @@
-import { getDirname } from 'cross-dirname'
-
-import { FlatCompat } from '@eslint/eslintrc'
-import { fixupConfigRules } from '@eslint/compat'
-import type { TSESLint } from '@typescript-eslint/utils'
-
-// Initialize FlatCompat with the base directory
-const flatCompat = new FlatCompat({
-  baseDirectory: getDirname(),
-  recommendedConfig: {}
-})
-
-/**
- * i18next ESLint configuration
- * Enables i18next plugin for internationalization
- */
-export const i18next: TSESLint.FlatConfig.ConfigArray = [
-  ...(fixupConfigRules(flatCompat.plugins('i18next')) as unknown as TSESLint.FlatConfig.ConfigArray)
-]

package/packages/optionals/src/index.ts

@@ -1,8 +0,0 @@
-// Re-export all optional configurations
-export { cspell } from './cspell.js'
-export { i18next } from './i18next.js'
-export { markdown } from './markdown.js'
-export { mdx } from './mdx.js'
-export { stencil } from './stencil.js'
-export { tailwind } from './tailwind.js'
-export { vitest } from './vitest.js'

package/packages/optionals/src/markdown.ts

@@ -1,66 +0,0 @@
-import pluginMarkdown from '@eslint/markdown'
-import type { TSESLint } from '@typescript-eslint/utils'
-
-/**
- * Markdown ESLint configuration
- * Lints markdown files for common issues
- */
-export const markdown: TSESLint.FlatConfig.ConfigArray = [
-  ...(pluginMarkdown.configs.recommended as TSESLint.FlatConfig.ConfigArray),
-  {
-    name: 'optionals/markdown',
-    files: ['**/*.md'],
-    language: 'markdown/commonmark',
-    rules: {
-      'markdown/fenced-code-language': 'error',
-      'markdown/heading-increment': 'error',
-      'markdown/no-duplicate-headings': 'off',
-      'markdown/no-empty-links': 'error',
-      'markdown/no-html': 'off',
-      'markdown/no-invalid-label-refs': 'error',
-      'markdown/no-missing-label-refs': 'off',
-      // Disable js/ts Eslint rules that conflict with markdown
-      indent: 'off',
-      'no-irregular-whitespace': 'off',
-      '@stylistic/indent': 'off',
-      'no-unused-vars': 'off',
-      '@stylistic/jsx-closing-bracket-location': 'off',
-      'no-multi-spaces': 'off',
-      '@stylistic/no-multi-spaces': 'off',
-      'comma-dangle': 'off',
-      '@stylistic/jsx-tag-spacing': 'off'
-    }
-  },
-  {
-    name: 'optionals/markdown-code-blocks',
-    files: ['**/*.md/*.ts', '**/*.md/*.tsx', '**/*.md/*.js', '**/*.md/*.jsx'],
-    rules: {
-      // Disable type-aware rules — code blocks in markdown have no tsconfig
-      '@typescript-eslint/no-unsafe-assignment': 'off',
-      '@typescript-eslint/no-unsafe-call': 'off',
-      '@typescript-eslint/no-unsafe-member-access': 'off',
-      '@typescript-eslint/no-unsafe-return': 'off',
-      '@typescript-eslint/no-unsafe-argument': 'off',
-      '@typescript-eslint/no-floating-promises': 'off',
-      '@typescript-eslint/no-misused-promises': 'off',
-      '@typescript-eslint/await-thenable': 'off',
-      '@typescript-eslint/require-await': 'off',
-      '@typescript-eslint/restrict-template-expressions': 'off',
-      '@typescript-eslint/no-unnecessary-type-assertion': 'off',
-      '@typescript-eslint/unbound-method': 'off',
-      // Disable other rules that don't make sense for code snippets
-      'import/no-unresolved': 'off',
-      'no-unused-vars': 'off',
-      '@typescript-eslint/no-unused-vars': 'off',
-      'no-undef': 'off',
-      '@typescript-eslint/consistent-type-imports': 'off',
-      '@typescript-eslint/no-explicit-any': 'off'
-    },
-    languageOptions: {
-      parserOptions: {
-        project: null,
-        program: null
-      }
-    }
-  }
-]

package/packages/optionals/src/mdx.ts

@@ -1,40 +0,0 @@
-import * as pluginMdx from 'eslint-plugin-mdx'
-
-import type { TSESLint } from '@typescript-eslint/utils'
-
-const rules: TSESLint.Linter.RulesRecord = {
-  ...pluginMdx.flatCodeBlocks.rules,
-  'no-var': 'error',
-  'prefer-const': 'error',
-  'react/react-in-jsx-scope': 0,
-  'no-unused-vars': 'off',
-  '@stylistic/indent': 'off',
-  '@stylistic/jsx-closing-bracket-location': 'off',
-  'indent': 'off',
-  'no-multi-spaces': 'off',
-  '@stylistic/no-multi-spaces': 'off',
-  'comma-dangle': 'off',
-  '@stylistic/jsx-tag-spacing': 'off',
-  'import/export': 'off'
-}
-
-/**
- * MDX ESLint configuration
- * Lints MDX files with proper code block handling
- */
-export const mdx: TSESLint.FlatConfig.ConfigArray = [
-  {
-    files: ['**/*.mdx'],
-    ...pluginMdx.flat,
-    processor: pluginMdx.createRemarkProcessor({
-      lintCodeBlocks: true,
-      languageMapper: {}
-    }),
-    rules
-  } as TSESLint.FlatConfig.Config,
-  {
-    files: ['**/*.mdx'],
-    ...pluginMdx.flatCodeBlocks,
-    rules
-  } as TSESLint.FlatConfig.Config
-]

package/packages/optionals/src/stencil.ts

@@ -1,48 +0,0 @@
-import { fixupPluginRules } from '@eslint/compat'
-import stencilPlugin from '@stencil-community/eslint-plugin'
-import type { TSESLint } from '@typescript-eslint/utils'
-
-/**
- * Stencil ESLint configuration
- * Enforces best practices for Stencil.js components
- */
-export const stencil: TSESLint.FlatConfig.ConfigArray = [
-  {
-    name: 'optionals/stencil',
-    files: ['**/*.{tsx,ts}'],
-    plugins: {
-      '@stencil-community': fixupPluginRules({
-        rules: stencilPlugin.rules as Record<string, unknown>
-      } as Parameters<typeof fixupPluginRules>[0]) as unknown as TSESLint.FlatConfig.Plugin
-    },
-    rules: {
-      '@stencil-community/async-methods': 'error',
-      '@stencil-community/ban-prefix': ['error', ['stencil', 'stnl', 'st']],
-      '@stencil-community/decorators-context': 'error',
-      '@stencil-community/decorators-style': [
-        'error', {
-          prop: 'inline',
-          state: 'inline',
-          element: 'inline',
-          event: 'inline',
-          method: 'multiline',
-          watch: 'multiline',
-          listen: 'multiline'
-        }],
-      '@stencil-community/element-type': 'error',
-      '@stencil-community/host-data-deprecated': 'error',
-      '@stencil-community/methods-must-be-public': 'error',
-      '@stencil-community/no-unused-watch': 'error',
-      '@stencil-community/own-methods-must-be-private': 'error',
-      '@stencil-community/own-props-must-be-private': 'error',
-      '@stencil-community/prefer-vdom-listener': 'error',
-      '@stencil-community/props-must-be-public': 'error',
-      '@stencil-community/props-must-be-readonly': 'error',
-      '@stencil-community/render-returns-host': 'error',
-      '@stencil-community/required-jsdoc': 'error',
-      '@stencil-community/reserved-member-names': 'error',
-      '@stencil-community/single-export': 'error',
-      '@stencil-community/strict-mutable': 'error'
-    }
-  }
-]

package/packages/optionals/src/tailwind.ts

@@ -1,11 +0,0 @@
-import pluginTailwind from 'eslint-plugin-tailwindcss'
-
-import type { TSESLint } from '@typescript-eslint/utils'
-
-/**
- * Tailwind CSS ESLint configuration
- * Enforces Tailwind CSS best practices
- */
-export const tailwind: TSESLint.FlatConfig.ConfigArray = [
-  ...(pluginTailwind.configs['flat/recommended'] as TSESLint.FlatConfig.ConfigArray)
-]

package/packages/optionals/src/vitest.ts

@@ -1,61 +0,0 @@
-import testingLibrary from 'eslint-plugin-testing-library'
-import pluginVitest from 'eslint-plugin-vitest'
-import globals from 'globals'
-
-import { fixupPluginRules } from '@eslint/compat'
-import type { TSESLint } from '@typescript-eslint/utils'
-
-/**
- * Vitest ESLint configuration
- * Provides linting rules for Vitest test files with best practices
- */
-export const vitest: TSESLint.FlatConfig.ConfigArray = [
-  {
-    name: 'optionals/vitest',
-    files: [
-      'tests/**/*.{js,ts,jsx,tsx}',
-      '**/__tests__/**/*.{js,ts,jsx,tsx}',
-      '**/__mocks__/**/*.{js,ts,jsx,tsx}',
-      '**/test/**/*.{js,ts,jsx,tsx}',
-      '**/spec/**/*.{js,ts,jsx,tsx}',
-      '**/__spec__/**/*.{js,ts,jsx,tsx}',
-      '**/*.test.{js,ts,jsx,tsx}',
-      '**/*.spec.{js,ts,jsx,tsx}',
-      'vitest.config.{js,ts}'
-    ],
-    languageOptions: {
-      globals: {
-        ...globals.node
-      }
-    },
-    plugins: {
-      vitest: pluginVitest,
-      'testing-library': fixupPluginRules({
-        rules: testingLibrary.rules
-      } as unknown as Parameters<typeof fixupPluginRules>[0]) as unknown as TSESLint.FlatConfig.Plugin
-    },
-    rules: {
-      // Vitest recommended rules
-      ...pluginVitest.configs.recommended.rules,
-
-      // Best practice rules for testing
-      'vitest/max-nested-describe': ['error', { max: 3 }],
-      'vitest/expect-expect': [
-        'error',
-        {
-          assertFunctionNames: ['expect', 'assert', 'should']
-        }
-      ],
-      'vitest/no-identical-title': 'error',
-      'vitest/no-focused-tests': 'error',
-      'vitest/no-disabled-tests': 'warn',
-      'vitest/prefer-to-be': 'warn',
-      'vitest/prefer-to-have-length': 'warn',
-      'vitest/valid-expect': 'error',
-
-      // Disable some rules that conflict with test patterns
-      '@typescript-eslint/no-explicit-any': 'off',
-      '@stylistic/padding-line-between-statements': 'off'
-    }
-  }
-]

package/packages/optionals/tsconfig.json

@@ -1,9 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "compilerOptions": {
-    "outDir": "./dist",
-    "rootDir": "./src"
-  },
-  "include": ["src/**/*.ts"],
-  "exclude": ["node_modules", "dist"]
-}

package/packages/optionals/tsup.config.ts

@@ -1,11 +0,0 @@
-import { defineConfig } from 'tsup'
-
-export default defineConfig({
-  entry: ['src/index.ts'],
-  format: ['esm'],
-  dts: true,
-  splitting: false,
-  sourcemap: true,
-  clean: true,
-  target: 'es2022'
-})

package/packages/playground/README.md

@@ -1,14 +0,0 @@
-# @santi020k/eslint-config-playground
-
-Internal playground package for testing ESLint configurations against real files.
-
-## Description
-
-This package contains various file types (React, Astro, MDX, TS) to verify that the ESLint rules are applied correctly in a real-world project structure.
-
-## Usage
-
-Run linting on this package:
-```bash
-npm run lint -w @santi020k/eslint-config-playground
-```

package/packages/playground/package.json

@@ -1,17 +0,0 @@
-{
-  "name": "@santi020k/eslint-config-playground",
-  "private": false,
-  "version": "0.0.0",
-  "type": "module",
-  "scripts": {
-    "lint": "eslint .",
-    "lint:fix": "eslint . --fix"
-  },
-  "dependencies": {
-    "@santi020k/eslint-config-basic": "*",
-    "eslint": "^9.39.2",
-    "react": "^19.2.4",
-    "react-dom": "^19.2.4",
-    "typescript": "^5.9.3"
-  }
-}

package/packages/playground/src/astro/eslint.config.js

@@ -1,4 +0,0 @@
-// @ts-check
-import { ConfigOption, eslintConfig } from '../../dist/index.js'
-
-export default eslintConfig({ config: [ConfigOption.Ts, ConfigOption.Astro] })

package/packages/playground/src/js/eslint.config.js

@@ -1,4 +0,0 @@
-// @ts-check
-import { eslintConfig } from '../../dist/index.js'
-
-export default eslintConfig()

package/packages/playground/src/js/index.test.js

@@ -1,63 +0,0 @@
-// test.js
-
-// Function definitions to test various stylistic rules
-const myFunction1 = () => {
-  const value = 10
-
-  if (value > 5) {
-    console.log('Value is greater than 5')
-  } else {
-    console.log('Value is 5 or less')
-  }
-
-  const result = value > 5 ? 'High' : 'Low'
-  const array = [1, 2, 3]
-
-  array.forEach(item => {
-    console.log(item)
-  })
-
-  return result
-}
-
-// Testing object and array formatting rules
-const myObject = { a: 1, b: 2, c: 3 }
-const myArray = [1, 2, 3, 4, 5]
-
-// Testing padding and spacing rules
-if (myArray.length > 0) {
-  console.log('Array is not empty')
-}
-
-const myFunction2 = param => !!param
-// Testing invalid typeof comparison
-const count = 0
-
-if (typeof count === 'number') {
-  console.log('Count is a number')
-}
-
-// Testing unused variables
-// eslint-disable-next-line no-unused-vars, unused-imports/no-unused-vars
-const unusedVar = 'This is unused'
-
-// Function with multiple return statements
-// eslint-disable-next-line no-unused-vars, unused-imports/no-unused-vars
-const complexFunction = () => {
-  if (count > 10) return 'High'
-
-  if (count < 0) return 'Low'
-
-  return 'Medium'
-}
-
-// Testing no-use-before-define
-myDefinedFunction()
-
-// eslint-disable-next-line func-style
-function myDefinedFunction() {
-  console.log('Function called before definition')
-}
-
-// Export statement to test sorting
-export { myFunction1, myFunction2, myObject, myArray }

package/packages/playground/src/mdx/eslint.config.js

@@ -1,4 +0,0 @@
-// @ts-check
-import { eslintConfig, OptionalOption } from '../../dist/index.js'
-
-export default eslintConfig({ optionals: [OptionalOption.Mdx] })

package/packages/playground/src/mdx/index.mdx

@@ -1,115 +0,0 @@
----
-title: "The Ultimate MDX Example"
-description: "A complete overview of MDX capabilities with lorem ipsum content"
-author: "Santiago Ipsum"
-tags: ["mdx", "example", "components"]
-date: "2025-04-21"
----
-
-import { Button, Alert, FancyBox } from '../components/UI'
-import Note from '../components/Note'
-import Chart from '../components/Chart'
-
-## 🎢 Welcome to the MDX Playground
-
-# Welcome to the MDX Playground 🎢
-
-This is an **MDX** file. It's like Markdown, but on _steroids_ — powered by **JSX**. Let's explore all the features using some _Lorem Ipsum_.
-
-## 🧩 Embedded JSX Components
-
-You can embed React components directly:
-
-<Alert type="success">This is a success alert using a custom component!</Alert>
-
-## 📦 Importing Components
-
-You can import components like `Note`, `FancyBox`, or even charts.
-
-<Note>
-  Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque feugiat.
-</Note>
-
-<FancyBox>
-  <h3>Fancy Box Title</h3>
-  <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p>
-</FancyBox>
-
-## 🖼️ Images
-
-![Placeholder](https://via.placeholder.com/300x200.png?text=Lorem+Ipsum)
-
-## 🧮 Code Blocks
-
-### JavaScript
-
-```js
-const greet = name => `Hello, ${name}!`
-
-greet('santi020k')
-```
-
-### Bash
-
-```bash
-npm install @mdx-js/react
-```
-
-## 📊 Embedded Dynamic Chart
-
-<Chart
-  title="Sample Chart"
-  data={[{ label: 'A', value: 10 }, { label: 'B', value: 20 }]}
-/>
-
-## 🔗 Links
-
-Check out the [official MDX docs](https://mdxjs.com).
-
-## 🗒️ Lists and Tables
-
-### Bullet List
-
-- Lorem ipsum
-- Dolor sit amet
-- Consectetur adipiscing
-
-### Numbered List
-
-1. First item
-2. Second item
-3. Third item
-
-### Table
-
-| Feature        | Supported |
-|----------------|-----------|
-| Markdown       | ✅        |
-| JSX            | ✅        |
-| Components     | ✅        |
-| Frontmatter    | ✅        |
-
-## 🎉 Inline JSX
-
-Here’s some inline JSX: `<span style={{ color: 'tomato' }}>Hello inline JSX!</span>`
-
-## 📌 Export Metadata
-
-You can also export metadata if needed:
-
-```js
-export const meta = {
-  layout: 'docs',
-  requiresAuth: false
-}
-```
-
----
-
-## 🧠 Conclusion
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque in odio vitae nunc luctus aliquet. MDX is powerful, flexible, and fun. Try it out in your next documentation or blog project!
-
-```
-
----

package/packages/playground/src/react/eslint.config.js

@@ -1,4 +0,0 @@
-// @ts-check
-import { ConfigOption, eslintConfig } from '../../dist/index.js'
-
-export default eslintConfig({ config: [ConfigOption.React] })