@santi020k/eslint-config-basic 0.1.0

package/packages/basic/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@santi020k/eslint-config-basic",
+  "version": "0.0.0",
+  "description": "A comprehensive ESLint configuration package for JavaScript, TypeScript, and React projects.",
+  "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"
+  },
+  "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": "*",
+    "@eslint/compat": "^2.0.2",
+    "@eslint/js": "^9.39.2",
+    "@typescript-eslint/eslint-plugin": "^8.54.0",
+    "@typescript-eslint/type-utils": "^8.54.0",
+    "cross-dirname": "^0.1.0",
+    "eslint": "^9.39.2",
+    "typescript-eslint": "^8.54.0"
+  },
+  "devDependencies": {
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3",
+    "@typescript-eslint/utils": "^8.54.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "MIT",
+  "author": "santi020k",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/santi020k/eslint-config.git",
+    "directory": "packages/basic"
+  }
+}

package/packages/basic/src/index.ts

@@ -0,0 +1,110 @@
+// Re-export types and utilities from core
+export {
+  ConfigOption,
+  OptionalOption,
+  SettingOption,
+  ReactConfigs,
+  applyConfigIfOptionPresent,
+  hasReactConfig,
+  coreConfig,
+  jsConfig,
+  gitignore
+} from '@santi020k/eslint-config-core'
+
+export type {
+  EslintConfigOptions,
+  FlatConfigArray
+} from '@santi020k/eslint-config-core'
+
+// Re-export framework configs
+export { typescriptConfig, tsConfig } 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'
+
+// Re-export optionals
+export {
+  cspell,
+  i18next,
+  markdown,
+  mdx,
+  stencil,
+  tailwind,
+  vitest
+} from '@santi020k/eslint-config-optionals'
+
+// Import for composition
+import { astroConfig } from '@santi020k/eslint-config-astro'
+import type { EslintConfigOptions, FlatConfigArray } from '@santi020k/eslint-config-core'
+import {
+  applyConfigIfOptionPresent,
+  ConfigOption,
+  coreConfig,
+  gitignore,
+  hasReactConfig,
+  OptionalOption,
+  SettingOption
+} from '@santi020k/eslint-config-core'
+import { expoConfig } from '@santi020k/eslint-config-expo'
+import { nestConfig } from '@santi020k/eslint-config-nest'
+import { nextConfig } from '@santi020k/eslint-config-next'
+import {
+  cspell,
+  i18next,
+  markdown,
+  mdx,
+  stencil,
+  tailwind,
+  vitest
+} from '@santi020k/eslint-config-optionals'
+import { reactConfig } from '@santi020k/eslint-config-react'
+import { typescriptConfig } from '@santi020k/eslint-config-typescript'
+
+/**
+ * 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
+ */
+export const eslintConfig = ({
+  config = [],
+  optionals = [],
+  settings = []
+}: EslintConfigOptions = {}): FlatConfigArray => {
+  const hasReact = hasReactConfig(config)
+
+  return [
+    // Settings
+    ...(settings.includes(SettingOption.Gitignore) ? gitignore : []),
+
+    // Core JS config (always included)
+    ...coreConfig,
+
+    // React config (included if any React-based framework is used)
+    ...(hasReact ? reactConfig : []),
+
+    // Framework-specific configs
+    ...applyConfigIfOptionPresent(config, ConfigOption.Ts, typescriptConfig),
+    ...applyConfigIfOptionPresent(config, ConfigOption.Next, nextConfig),
+    ...applyConfigIfOptionPresent(config, ConfigOption.Astro, astroConfig),
+    ...applyConfigIfOptionPresent(config, ConfigOption.Expo, expoConfig),
+    ...applyConfigIfOptionPresent(config, ConfigOption.Nest, nestConfig),
+
+    // Optionals
+    ...(optionals.includes(OptionalOption.Cspell) ? cspell : []),
+    ...(optionals.includes(OptionalOption.Tailwind) ? tailwind : []),
+    ...(optionals.includes(OptionalOption.Vitest) ? vitest : []),
+    ...(optionals.includes(OptionalOption.I18next) ? i18next : []),
+    ...(optionals.includes(OptionalOption.Stencil) ? stencil : []),
+    ...(optionals.includes(OptionalOption.Mdx) ? mdx : []),
+    ...(optionals.includes(OptionalOption.Markdown) ? markdown : [])
+  ]
+}

package/packages/basic/tsconfig.json

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

package/packages/basic/tsup.config.ts

@@ -0,0 +1,18 @@
+import type { Options } from 'tsup'
+
+const env = process.env.NODE_ENV
+
+export const tsup: Options = {
+  splitting: true,
+  clean: true, // clean up the dist folder
+  dts: true, // generate dts files
+  format: ['esm'], // generate esm files
+  minify: false,
+  // bundle: env === 'production',
+  skipNodeModulesBundle: true,
+  entryPoints: ['src/index.ts'],
+  watch: env === 'development',
+  target: 'es2020',
+  outDir: 'dist',
+  entry: ['src/**/*.ts'] // include all files under src
+}

package/packages/core/README.md

@@ -0,0 +1,14 @@
+# @santi020k/eslint-config-core
+
+Core ESLint configuration and utilities for the `@santi020k/eslint-config` monorepo.
+
+## Description
+
+This package contains:
+- Base JavaScript rules.
+- Types and Enums (`ConfigOption`, `OptionalOption`, etc.).
+- Utility functions for composing configurations.
+
+## Installation
+
+This package is an internal dependency of `@santi020k/eslint-config` and is not intended to be installed directly.

package/packages/core/index.ts

@@ -0,0 +1,14 @@
+import tseslint from 'typescript-eslint'
+
+import js from '@eslint/js'
+
+export default [
+  js.configs.recommended,
+  ...tseslint.configs.recommended,
+  {
+    rules: {
+      'no-unused-vars': 'warn',
+      'no-console': 'warn'
+    }
+  }
+]

package/packages/core/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@santi020k/eslint-config-core",
+  "version": "0.0.0",
+  "description": "Core ESLint configuration with base JavaScript rules and shared utilities",
+  "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"
+    },
+    "./utils": {
+      "import": "./dist/utils/index.js",
+      "types": "./dist/utils/index.d.ts"
+    },
+    "./types": {
+      "import": "./dist/types.js",
+      "types": "./dist/types.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "clean": "rm -rf dist"
+  },
+  "peerDependencies": {
+    "eslint": "^9.0.0"
+  },
+  "dependencies": {
+    "@eslint/js": "^9.39.2",
+    "@stylistic/eslint-plugin": "^5.7.1",
+    "eslint-config-standard": "^17.1.0",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-jsx-a11y": "^6.10.2",
+    "eslint-plugin-n": "^17.23.2",
+    "eslint-plugin-promise": "^7.2.1",
+    "eslint-plugin-simple-import-sort": "^12.1.1",
+    "eslint-plugin-unused-imports": "^4.3.0",
+    "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/core"
+  }
+}

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

@@ -0,0 +1,61 @@
+// Type declarations for ESLint plugins that don't ship their own types
+
+declare module 'eslint-config-standard' {
+  import type { TSESLint } from '@typescript-eslint/utils'
+
+  const config: {
+    rules: TSESLint.Linter.RulesRecord
+  }
+
+  export default config
+}
+
+declare module 'eslint-plugin-import' {
+  import type { TSESLint } from '@typescript-eslint/utils'
+
+  const plugin: {
+    rules: Record<string, TSESLint.RuleModule<string, unknown[]>>
+  }
+
+  export default plugin
+}
+
+declare module 'eslint-plugin-jsx-a11y' {
+  import type { TSESLint } from '@typescript-eslint/utils'
+
+  const plugin: TSESLint.FlatConfig.Plugin
+
+  export default plugin
+}
+
+declare module 'eslint-plugin-n' {
+  import type { TSESLint } from '@typescript-eslint/utils'
+
+  const plugin: TSESLint.FlatConfig.Plugin
+
+  export default plugin
+}
+
+declare module 'eslint-plugin-promise' {
+  import type { TSESLint } from '@typescript-eslint/utils'
+
+  const plugin: TSESLint.FlatConfig.Plugin
+
+  export default plugin
+}
+
+declare module 'eslint-plugin-simple-import-sort' {
+  import type { TSESLint } from '@typescript-eslint/utils'
+
+  const plugin: TSESLint.FlatConfig.Plugin
+
+  export default plugin
+}
+
+declare module 'eslint-plugin-unused-imports' {
+  import type { TSESLint } from '@typescript-eslint/utils'
+
+  const plugin: TSESLint.FlatConfig.Plugin
+
+  export default plugin
+}

package/packages/core/src/index.ts

@@ -0,0 +1,75 @@
+// @ts-check
+import configStandard from 'eslint-config-standard'
+import pluginImport from 'eslint-plugin-import'
+import pluginJsxA11y from 'eslint-plugin-jsx-a11y'
+import pluginN from 'eslint-plugin-n'
+import pluginPromise from 'eslint-plugin-promise'
+import pluginSimpleImport from 'eslint-plugin-simple-import-sort'
+import pluginUnusedImport from 'eslint-plugin-unused-imports'
+import globals from 'globals'
+
+import { rules } from './rules.js'
+
+import eslint from '@eslint/js'
+import pluginStylistic from '@stylistic/eslint-plugin'
+import type { TSESLint } from '@typescript-eslint/utils'
+
+// Re-export types and utilities
+export * from './types.js'
+
+export * from './utils/index.js'
+
+const languageOptions: TSESLint.FlatConfig.LanguageOptions = {
+  ecmaVersion: 'latest',
+  sourceType: 'module',
+  globals: {
+    ...globals.browser,
+    ...globals.node
+  }
+}
+
+/**
+ * Core JavaScript ESLint configuration
+ * This is included by default in all configurations
+ */
+export const coreConfig: TSESLint.FlatConfig.ConfigArray = [
+  {
+    name: 'eslint-config/recommended',
+    ...eslint.configs.recommended
+  },
+  {
+    name: 'eslint-config/plugins',
+    plugins: {
+      n: pluginN,
+      promise: pluginPromise,
+      import: { rules: pluginImport.rules },
+      'simple-import-sort': pluginSimpleImport,
+      'jsx-a11y': pluginJsxA11y,
+      'unused-imports': pluginUnusedImport
+    },
+    languageOptions,
+    rules: {
+      ...configStandard.rules,
+      'import/first': 'off'
+    }
+  },
+  {
+    name: 'eslint-config/stylistic',
+    ...pluginStylistic.configs.recommended
+  },
+  {
+    name: 'eslint-config/custom-js',
+    languageOptions,
+    files: ['**/*.{js,jsx,mjs,cjs}'],
+    rules
+  }
+]
+
+// Legacy export for backwards compatibility
+export { coreConfig as jsConfig }
+
+// Export rules and groups for use by other packages
+export { rules, groups } from './rules.js'
+
+// Export settings
+export { gitignore } from './settings/index.js'

package/packages/core/src/rules.ts

@@ -0,0 +1,157 @@
+import type { TSESLint } from '@typescript-eslint/utils'
+
+const groups = [
+  // Internal packages.
+  // Atomic Design and components
+  ['^(components|@/components|@components)(/.*|$)'],
+  ['^(ui|@/ui|@ui)(/.*|$)'],
+  ['^(atoms|@/atoms|@atoms)(/.*|$)'],
+  ['^(molecules|@/molecules|@molecules)(/.*|$)'],
+  ['^(organisms|@/organisms|@organisms)(/.*|$)'],
+  ['^(templates|@/templates|@templates)(/.*|$)'],
+  ['^(pages|@/pages|@pages)(/.*|$)'],
+  // Other posible folders
+  ['^(store|@/store|@store)(/.*|$)'],
+  ['^(api|@/api|@api)(/.*|$)'],
+  ['^(contexts|@/contexts|@contexts)(/.*|$)'],
+  ['^(hooks|@/hooks|@hooks)(/.*|$)'],
+  ['^(lib|@/lib|@lib)(/.*|$)'],
+  ['^(services|@/services|@services)(/.*|$)'],
+  ['^(models|@/models|@models)(/.*|$)'],
+  ['^(utils|@/utils|@utils)(/.*|$)'],
+  ['^(ws|@/ws|@ws)(/.*|$)'],
+  // npm packages
+  ['^\\w'],
+  // Side effect imports.
+  ['^\\u0000'],
+  // Other relative imports. Put same-folder imports and `.` last.
+  ['^\\./(?=.*/)(?!/?$)', '^\\.(?!/?$)', '^\\./?$'],
+  // Parent imports. Put `..` last.
+  ['^\\.\\.(?!/?$)', '^\\.\\./?$'],
+  // Style imports.
+  ['^.+\\.?(css|scss)$']
+]
+
+export const rules: TSESLint.Linter.RulesRecord = {
+  'unused-imports/no-unused-imports': 'warn',
+  indent: 'off',
+  'brace-style': 'off',
+  '@stylistic/brace-style': ['warn', '1tbs'],
+  '@stylistic/indent': ['warn', 2],
+  '@stylistic/quote-props': ['warn', 'as-needed'],
+  quotes: 'off',
+  '@stylistic/quotes': ['warn', 'single'],
+  '@stylistic/semi': ['warn', 'never'],
+  'quote-props': 'off',
+  'comma-dangle': 'off',
+  '@stylistic/comma-dangle': ['warn', 'never'],
+  '@stylistic/object-curly-spacing': ['warn', 'always'],
+  '@stylistic/padded-blocks': ['warn', 'never'],
+  '@stylistic/arrow-parens': ['warn', 'as-needed'],
+  '@stylistic/dot-location': ['warn', 'property'],
+  '@stylistic/function-call-argument-newline': ['warn', 'never'],
+  '@stylistic/object-property-newline': [
+    'warn',
+    { allowAllPropertiesOnSameLine: true }
+  ],
+  '@stylistic/multiline-ternary': ['warn', 'always-multiline'],
+  '@stylistic/member-delimiter-style': ['error', {
+    multiline: {
+      delimiter: 'none',
+      requireLast: false
+    },
+    singleline: {
+      delimiter: 'comma',
+      requireLast: false
+    },
+    overrides: {
+      interface: {
+        multiline: {
+          delimiter: 'none',
+          requireLast: false
+        }
+      }
+    }
+  }],
+  '@stylistic/no-extra-parens': 'off',
+  '@stylistic/max-len': [
+    'warn',
+    {
+      code: 120,
+      tabWidth: 2,
+      comments: 200,
+      ignoreStrings: true
+    }
+  ],
+  '@stylistic/max-statements-per-line': ['warn', { max: 1 }],
+  '@stylistic/array-element-newline': ['warn', 'consistent'],
+  '@stylistic/no-extra-semi': 'off',
+  '@stylistic/no-multi-spaces': 'off',
+  '@stylistic/padding-line-between-statements': [
+    'warn',
+    { blankLine: 'always', prev: '*', next: '*' },
+    { blankLine: 'any', prev: 'import', next: 'import' },
+    {
+      blankLine: 'always',
+      prev: ['const', 'let', 'var'],
+      next: ['const', 'let', 'var']
+    },
+    {
+      blankLine: 'never',
+      prev: ['singleline-const', 'singleline-let', 'singleline-var'],
+      next: ['singleline-const', 'singleline-let', 'singleline-var']
+    },
+    { blankLine: 'always', prev: 'block-like', next: 'const' },
+    { blankLine: 'always', prev: 'const', next: 'block-like' }
+  ],
+  '@stylistic/function-paren-newline': ['warn', 'consistent'],
+  'arrow-body-style': ['warn', 'as-needed'],
+  'prefer-arrow-callback': ['warn', { allowNamedFunctions: true }],
+  'func-style': ['warn', 'expression', { allowArrowFunctions: true }],
+  'simple-import-sort/imports': [
+    'warn',
+    {
+      groups
+    }
+  ],
+  'jsx-a11y/alt-text': 'warn',
+  'no-empty': 'warn',
+  'no-nested-ternary': 'warn',
+  'no-undef': 'warn',
+  'unused-imports/no-unused-vars': [
+    'warn',
+    {
+      vars: 'all',
+      varsIgnorePattern: '^_',
+      args: 'after-used',
+      argsIgnorePattern: '^_',
+      destructuredArrayIgnorePattern: '^_',
+      ignoreRestSiblings: true
+    }
+  ],
+  'no-void': 'warn',
+  camelcase: 'warn',
+  'array-callback-return': 'warn',
+  'no-fallthrough': 'warn',
+  eqeqeq: 'warn',
+  'no-constant-binary-expression': 'warn',
+  '@stylistic/lines-around-comment': ['error', { allowClassStart: true, beforeLineComment: false, allowBlockStart: true }],
+  'import/no-duplicates': 'warn',
+  'valid-typeof': 'warn',
+  'no-constant-condition': 'warn',
+  'no-use-before-define': 'warn',
+  '@stylistic/implicit-arrow-linebreak': 'warn',
+  'import/export': 'warn',
+  'no-useless-escape': 'warn',
+  'no-useless-return': 'warn',
+  'prefer-promise-reject-errors': 'warn',
+  'no-useless-constructor': 'warn',
+  'no-new': 'warn',
+  'prefer-regex-literals': 'warn',
+  '@stylistic/multiline-comment-style': 'off',
+  'space-before-function-paren': 'off',
+  'operator-linebreak': 'off',
+  '@stylistic/operator-linebreak': ['error', 'after']
+}
+
+export { groups }

package/packages/core/src/settings/gitignore.ts

@@ -0,0 +1,10 @@
+import { includeIgnoreFile } from '@eslint/compat'
+import type { TSESLint } from '@typescript-eslint/utils'
+
+/**
+ * Gitignore ESLint configuration
+ * Automatically ignores files from .gitignore
+ */
+export const gitignore: TSESLint.FlatConfig.ConfigArray = [
+  includeIgnoreFile(`${process.cwd()}/.gitignore`) as TSESLint.FlatConfig.Config
+]

package/packages/core/src/settings/index.ts

@@ -0,0 +1 @@
+export { gitignore } from './gitignore.js'

package/packages/core/src/types.ts

@@ -0,0 +1,57 @@
+import type { TSESLint } from '@typescript-eslint/utils'
+
+/**
+ * Enum for configuration options in ESLint
+ */
+export enum ConfigOption {
+  Ts = 'ts',
+  React = 'react',
+  Next = 'next',
+  Expo = 'expo',
+  Astro = 'astro',
+  Nest = 'nest'
+}
+
+/**
+ * Enum for optional features that can be included in ESLint
+ */
+export enum OptionalOption {
+  Cspell = 'cspell',
+  Tailwind = 'tailwind',
+  Vitest = 'vitest',
+  I18next = 'i18next',
+  Mdx = 'mdx',
+  Markdown = 'markdown',
+  Stencil = 'stencil'
+}
+
+/**
+ * Enum for settings options in ESLint
+ */
+export enum SettingOption {
+  Gitignore = 'gitignore'
+}
+
+/**
+ * Array of configurations that require React
+ */
+export const ReactConfigs: ConfigOption[] = [
+  ConfigOption.React,
+  ConfigOption.Astro,
+  ConfigOption.Next,
+  ConfigOption.Expo
+]
+
+/**
+ * ESLint configuration interface
+ */
+export interface EslintConfigOptions {
+  config?: ConfigOption[]
+  optionals?: OptionalOption[]
+  settings?: SettingOption[]
+}
+
+/**
+ * Type alias for ESLint flat config array
+ */
+export type FlatConfigArray = TSESLint.FlatConfig.ConfigArray

package/packages/core/src/utils/index.ts

@@ -0,0 +1,28 @@
+import type { FlatConfigArray } from '../types.js'
+import { ConfigOption, ReactConfigs } from '../types.js'
+
+/**
+ * Adds a specific configuration if the given option is present in the configs array.
+ *
+ * @param configs - An array of configuration options.
+ * @param option - The option to check for.
+ * @param configToAdd - The configuration to add if the option is present.
+ * @returns The configuration to add if the option is present, otherwise an empty array.
+ */
+export const applyConfigIfOptionPresent = (
+  configs: ConfigOption[],
+  option: ConfigOption,
+  configToAdd: FlatConfigArray
+): FlatConfigArray => configs.includes(option) ? configToAdd : []
+
+/**
+ * Checks if the provided configs array includes any React-specific configurations.
+ *
+ * @param configs - An optional array of configuration options.
+ * @returns True if any React configuration is found, false otherwise.
+ */
+export const hasReactConfig = (configs?: ConfigOption[]): boolean => {
+  if (!configs) return false
+
+  return ReactConfigs.some(reactConfig => configs.includes(reactConfig))
+}