stacks 0.56.24 → 0.58.18

package/core/src/eslint-config/package.json

@@ -0,0 +1,119 @@
+{
+  "name": "@stacksjs/eslint-config",
+  "type": "module",
+  "version": "0.58.18",
+  "description": "The Stacks.js ESLint config preset, heavily inspired by Anthony's ESLint config.",
+  "author": "Anthony Fu <anthonyfu117@hotmail.com> (https://github.com/antfu/)",
+  "license": "MIT",
+  "funding": "https://github.com/sponsors/antfu",
+  "homepage": "https://github.com/stacksjs/stacks/blob/main/storage/framework/core/src/eslint-config",
+  "keywords": [
+    "stacks",
+    "eslint-config"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/index.js"
+    }
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "bunx --bun tsup --format esm,cjs --clean",
+    "stub": "bunx --bun tsup --format esm",
+    "dev": "bunx --bun tsup --format esm,cjs --watch & eslint-flat-config-viewer",
+    "lint": "bun run stub && eslint .",
+    "prepack": "bun run build",
+    "test": "bunx vitest",
+    "typecheck": "bunx tsc --noEmit"
+  },
+  "peerDependencies": {
+    "@unocss/eslint-plugin": ">=0.58.3",
+    "eslint": "npm:eslint-ts-patch@^8.55.0-1",
+    "eslint-plugin-format": "^0.1.0",
+    "eslint-plugin-react": "^7.33.2",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-react-refresh": "^0.4.5",
+    "eslint-plugin-svelte": "^2.35.1",
+    "eslint-ts-patch": "^8.55.0-1",
+    "svelte-eslint-parser": "^0.33.1"
+  },
+  "peerDependenciesMeta": {
+    "@unocss/eslint-plugin": {
+      "optional": true
+    },
+    "eslint-plugin-format": {
+      "optional": true
+    },
+    "eslint-plugin-react": {
+      "optional": true
+    },
+    "eslint-plugin-react-hooks": {
+      "optional": true
+    },
+    "eslint-plugin-react-refresh": {
+      "optional": true
+    },
+    "eslint-plugin-svelte": {
+      "optional": true
+    },
+    "svelte-eslint-parser": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "@antfu/eslint-define-config": "^1.23.0-2",
+    "@eslint-types/jsdoc": "48.0.2",
+    "@eslint-types/typescript-eslint": "^6.18.1",
+    "@eslint-types/unicorn": "^50.0.1",
+    "@stacksjs/cli": "workspace:*",
+    "@stylistic/eslint-plugin": "^1.5.3",
+    "@typescript-eslint/eslint-plugin": "^6.18.1",
+    "@typescript-eslint/parser": "^6.18.1",
+    "eslint-config-flat-gitignore": "^0.1.2",
+    "eslint-merge-processors": "^0.1.0",
+    "eslint-parser-plain": "^0.1.0",
+    "eslint-plugin-antfu": "^2.1.1",
+    "eslint-plugin-eslint-comments": "^3.2.0",
+    "eslint-plugin-i": "^2.29.1",
+    "eslint-plugin-jsdoc": "^48.0.2",
+    "eslint-plugin-jsonc": "^2.11.2",
+    "eslint-plugin-markdown": "^3.0.1",
+    "eslint-plugin-n": "^16.6.2",
+    "eslint-plugin-no-only-tests": "^3.1.0",
+    "eslint-plugin-perfectionist": "^2.5.0",
+    "eslint-plugin-toml": "^0.8.0",
+    "eslint-plugin-unicorn": "^50.0.1",
+    "eslint-plugin-unused-imports": "^3.0.0",
+    "eslint-plugin-vitest": "^0.3.20",
+    "eslint-plugin-vue": "^9.20.0",
+    "eslint-plugin-yml": "^1.11.0",
+    "eslint-processor-vue-blocks": "^0.1.1",
+    "globals": "^13.24.0",
+    "jsonc-eslint-parser": "^2.4.0",
+    "local-pkg": "^0.5.0",
+    "parse-gitignore": "^2.0.0",
+    "toml-eslint-parser": "^0.9.3",
+    "vue-eslint-parser": "^9.4.0",
+    "yaml-eslint-parser": "^1.2.2"
+  },
+  "devDependencies": {
+    "@stacksjs/eslint-config": "workspace:*",
+    "@stacksjs/utils": "workspace:*",
+    "@stylistic/eslint-plugin-migrate": "^1.5.3",
+    "@types/eslint": "^8.56.2",
+    "@types/node": "^20.11.0",
+    "@unocss/eslint-plugin": "^0.58.3",
+    "eslint": "npm:eslint-ts-patch@^8.55.0-1",
+    "eslint-flat-config-viewer": "^0.1.8",
+    "eslint-plugin-format": "^0.1.0",
+    "eslint-ts-patch": "^8.55.0-1",
+    "lint-staged": "^15.2.0",
+    "rimraf": "^5.0.5",
+    "tsup": "^8.0.1",
+    "typescript": "^5.3.3"
+  }
+}

package/core/src/eslint-config/src/configs/comments.ts

@@ -0,0 +1,19 @@
+import type { FlatConfigItem } from '../types'
+import { pluginComments } from '../plugins'
+
+export async function comments(): Promise<FlatConfigItem[]> {
+  return [
+    {
+      name: 'antfu:eslint-comments',
+      plugins: {
+        'eslint-comments': pluginComments,
+      },
+      rules: {
+        'eslint-comments/no-aggregating-enable': 'error',
+        'eslint-comments/no-duplicate-disable': 'error',
+        // 'eslint-comments/no-unlimited-disable': 'error',
+        'eslint-comments/no-unused-enable': 'error',
+      },
+    },
+  ]
+}

package/core/src/eslint-config/src/configs/formatters.ts

@@ -0,0 +1,187 @@
+import { GLOB_CSS, GLOB_LESS, GLOB_MARKDOWN, GLOB_POSTCSS, GLOB_SCSS } from '../globs'
+import type { VendoredPrettierOptions } from '../vendor/prettier-types'
+import { ensurePackages, interopDefault, parserPlain } from '../utils'
+import type { FlatConfigItem, OptionsFormatters, StylisticConfig } from '../types'
+import { StylisticConfigDefaults } from './stylistic'
+
+export async function formatters(
+  options: OptionsFormatters | true = {},
+  stylistic: StylisticConfig = {},
+): Promise<FlatConfigItem[]> {
+  await ensurePackages([
+    'eslint-plugin-format',
+  ])
+
+  if (options === true) {
+    options = {
+      css: true,
+      graphql: true,
+      html: true,
+      markdown: true,
+    }
+  }
+
+  const {
+    indent,
+    quotes,
+    semi,
+  } = {
+    ...StylisticConfigDefaults,
+    ...stylistic,
+  }
+
+  const prettierOptions: VendoredPrettierOptions = Object.assign(
+    {
+      endOfLine: 'auto',
+      semi,
+      singleQuote: quotes === 'single',
+      tabWidth: typeof indent === 'number' ? indent : 2,
+      trailingComma: 'all',
+      useTabs: indent === 'tab',
+    } satisfies VendoredPrettierOptions,
+    options.prettierOptions || {},
+  )
+
+  const dprintOptions = Object.assign(
+    {
+      indentWidth: typeof indent === 'number' ? indent : 2,
+      quoteStyle: quotes === 'single' ? 'preferSingle' : 'preferDouble',
+      useTabs: indent === 'tab',
+    },
+    options.dprintOptions || {},
+  )
+
+  const pluginFormat = await interopDefault(import('eslint-plugin-format'))
+
+  const configs: FlatConfigItem[] = [
+    {
+      name: 'antfu:formatters:setup',
+      plugins: {
+        format: pluginFormat,
+      },
+    },
+  ]
+
+  if (options.css) {
+    configs.push(
+      {
+        files: [GLOB_CSS, GLOB_POSTCSS],
+        languageOptions: {
+          parser: parserPlain,
+        },
+        name: 'antfu:formatter:css',
+        rules: {
+          'format/prettier': [
+            'error',
+            {
+              ...prettierOptions,
+              parser: 'css',
+            },
+          ],
+        },
+      },
+      {
+        files: [GLOB_SCSS],
+        languageOptions: {
+          parser: parserPlain,
+        },
+        name: 'antfu:formatter:scss',
+        rules: {
+          'format/prettier': [
+            'error',
+            {
+              ...prettierOptions,
+              parser: 'scss',
+            },
+          ],
+        },
+      },
+      {
+        files: [GLOB_LESS],
+        languageOptions: {
+          parser: parserPlain,
+        },
+        name: 'antfu:formatter:less',
+        rules: {
+          'format/prettier': [
+            'error',
+            {
+              ...prettierOptions,
+              parser: 'less',
+            },
+          ],
+        },
+      },
+    )
+  }
+
+  if (options.html) {
+    configs.push({
+      files: ['**/*.html'],
+      languageOptions: {
+        parser: parserPlain,
+      },
+      name: 'antfu:formatter:html',
+      rules: {
+        'format/prettier': [
+          'error',
+          {
+            ...prettierOptions,
+            parser: 'html',
+          },
+        ],
+      },
+    })
+  }
+
+  if (options.markdown) {
+    const formater = options.markdown === true
+      ? 'prettier'
+      : options.markdown
+
+    configs.push({
+      files: [GLOB_MARKDOWN],
+      languageOptions: {
+        parser: parserPlain,
+      },
+      name: 'antfu:formatter:markdown',
+      rules: {
+        [`format/${formater}`]: [
+          'error',
+          formater === 'prettier'
+            ? {
+                printWidth: 120,
+                ...prettierOptions,
+                embeddedLanguageFormatting: 'off',
+                parser: 'markdown',
+              }
+            : {
+                ...dprintOptions,
+                language: 'markdown',
+              },
+        ],
+      },
+    })
+  }
+
+  if (options.graphql) {
+    configs.push({
+      files: ['**/*.graphql'],
+      languageOptions: {
+        parser: parserPlain,
+      },
+      name: 'antfu:formatter:graphql',
+      rules: {
+        'format/prettier': [
+          'error',
+          {
+            ...prettierOptions,
+            parser: 'graphql',
+          },
+        ],
+      },
+    })
+  }
+
+  return configs
+}

package/core/src/eslint-config/src/configs/ignores.ts

@@ -0,0 +1,10 @@
+import type { FlatConfigItem } from '../types'
+import { GLOB_EXCLUDE } from '../globs'
+
+export async function ignores(): Promise<FlatConfigItem[]> {
+  return [
+    {
+      ignores: GLOB_EXCLUDE,
+    },
+  ]
+}

package/core/src/eslint-config/src/configs/imports.ts

@@ -0,0 +1,37 @@
+import type { FlatConfigItem, OptionsStylistic } from '../types'
+import { pluginAntfu, pluginImport } from '../plugins'
+
+export async function imports(options: OptionsStylistic = {}): Promise<FlatConfigItem[]> {
+  const {
+    stylistic = true,
+  } = options
+
+  return [
+    {
+      name: 'antfu:imports',
+      plugins: {
+        antfu: pluginAntfu,
+        import: pluginImport,
+      },
+      rules: {
+        'antfu/import-dedupe': 'error',
+        'antfu/no-import-dist': 'error',
+        'antfu/no-import-node-modules-by-path': 'error',
+
+        'import/first': 'error',
+        'import/no-duplicates': 'error',
+        'import/no-mutable-exports': 'error',
+        'import/no-named-default': 'error',
+        'import/no-self-import': 'error',
+        'import/no-webpack-loader-syntax': 'error',
+        'import/order': 'error',
+
+        ...stylistic
+          ? {
+              'import/newline-after-import': ['error', { considerComments: true, count: 1 }],
+            }
+          : {},
+      },
+    },
+  ]
+}

package/core/src/eslint-config/src/configs/index.ts

@@ -0,0 +1,21 @@
+export * from './comments'
+export * from './ignores'
+export * from './imports'
+export * from './javascript'
+export * from './jsdoc'
+export * from './jsonc'
+export * from './markdown'
+export * from './node'
+export * from './perfectionist'
+export * from './formatters'
+export * from './react'
+export * from './sort'
+export * from './stylistic'
+export * from './svelte'
+export * from './test'
+export * from './typescript'
+export * from './unicorn'
+export * from './unocss'
+export * from './vue'
+export * from './yaml'
+export * from './toml'

package/core/src/eslint-config/src/configs/javascript.ts

@@ -0,0 +1,226 @@
+import globals from 'globals'
+import type { FlatConfigItem, OptionsIsInEditor, OptionsOverrides } from '../types'
+import { pluginAntfu, pluginUnusedImports } from '../plugins'
+import { GLOB_SRC, GLOB_SRC_EXT } from '../globs'
+
+export async function javascript(
+  options: OptionsIsInEditor & OptionsOverrides = {},
+): Promise<FlatConfigItem[]> {
+  const {
+    isInEditor = false,
+    overrides = {},
+  } = options
+
+  return [
+    {
+      languageOptions: {
+        ecmaVersion: 2022,
+        globals: {
+          ...globals.browser,
+          ...globals.es2021,
+          ...globals.node,
+          document: 'readonly',
+          navigator: 'readonly',
+          window: 'readonly',
+        },
+        parserOptions: {
+          ecmaFeatures: {
+            jsx: true,
+          },
+          ecmaVersion: 2022,
+          sourceType: 'module',
+        },
+        sourceType: 'module',
+      },
+      linterOptions: {
+        reportUnusedDisableDirectives: true,
+      },
+      name: 'antfu:javascript',
+      plugins: {
+        'antfu': pluginAntfu,
+        'unused-imports': pluginUnusedImports,
+      },
+      rules: {
+        'accessor-pairs': ['error', { enforceForClassMembers: true, setWithoutGet: true }],
+
+        'array-callback-return': 'error',
+        'block-scoped-var': 'error',
+        'constructor-super': 'error',
+        'default-case-last': 'error',
+        'dot-notation': ['error', { allowKeywords: true }],
+        'eqeqeq': ['error', 'smart'],
+        'new-cap': ['error', { capIsNew: false, newIsCap: true, properties: true }],
+        'no-alert': 'error',
+        'no-array-constructor': 'error',
+        'no-async-promise-executor': 'error',
+        'no-caller': 'error',
+        'no-case-declarations': 'error',
+        'no-class-assign': 'error',
+        'no-compare-neg-zero': 'error',
+        'no-cond-assign': ['error', 'always'],
+        'no-console': ['error', { allow: ['warn', 'error'] }],
+        'no-const-assign': 'error',
+        'no-control-regex': 'error',
+        'no-debugger': 'error',
+        'no-delete-var': 'error',
+        'no-dupe-args': 'error',
+        'no-dupe-class-members': 'error',
+        'no-dupe-keys': 'error',
+        'no-duplicate-case': 'error',
+        'no-empty': ['error', { allowEmptyCatch: true }],
+        'no-empty-character-class': 'error',
+        'no-empty-pattern': 'error',
+        'no-eval': 'error',
+        'no-ex-assign': 'error',
+        'no-extend-native': 'error',
+        'no-extra-bind': 'error',
+        'no-extra-boolean-cast': 'error',
+        'no-fallthrough': 'error',
+        'no-func-assign': 'error',
+        'no-global-assign': 'error',
+        'no-implied-eval': 'error',
+        'no-import-assign': 'error',
+        'no-invalid-regexp': 'error',
+        'no-irregular-whitespace': 'error',
+        'no-iterator': 'error',
+        'no-labels': ['error', { allowLoop: false, allowSwitch: false }],
+        'no-lone-blocks': 'error',
+        'no-loss-of-precision': 'error',
+        'no-misleading-character-class': 'error',
+        'no-multi-str': 'error',
+        'no-new': 'error',
+        'no-new-func': 'error',
+        'no-new-object': 'error',
+        'no-new-symbol': 'error',
+        'no-new-wrappers': 'error',
+        'no-obj-calls': 'error',
+        'no-octal': 'error',
+        'no-octal-escape': 'error',
+        'no-proto': 'error',
+        'no-prototype-builtins': 'error',
+        'no-redeclare': ['error', { builtinGlobals: false }],
+        'no-regex-spaces': 'error',
+        'no-restricted-globals': [
+          'error',
+          { message: 'Use `globalThis` instead.', name: 'global' },
+          { message: 'Use `globalThis` instead.', name: 'self' },
+        ],
+        'no-restricted-properties': [
+          'error',
+          { message: 'Use `Object.getPrototypeOf` or `Object.setPrototypeOf` instead.', property: '__proto__' },
+          { message: 'Use `Object.defineProperty` instead.', property: '__defineGetter__' },
+          { message: 'Use `Object.defineProperty` instead.', property: '__defineSetter__' },
+          { message: 'Use `Object.getOwnPropertyDescriptor` instead.', property: '__lookupGetter__' },
+          { message: 'Use `Object.getOwnPropertyDescriptor` instead.', property: '__lookupSetter__' },
+        ],
+        'no-restricted-syntax': [
+          'error',
+          'DebuggerStatement',
+          'LabeledStatement',
+          'WithStatement',
+          'TSEnumDeclaration[const=true]',
+          'TSExportAssignment',
+        ],
+        'no-self-assign': ['error', { props: true }],
+        'no-self-compare': 'error',
+        'no-sequences': 'error',
+        'no-shadow-restricted-names': 'error',
+        'no-sparse-arrays': 'error',
+        'no-template-curly-in-string': 'error',
+        'no-this-before-super': 'error',
+        'no-throw-literal': 'error',
+        'no-undef': 'error',
+        'no-undef-init': 'error',
+        'no-unexpected-multiline': 'error',
+        'no-unmodified-loop-condition': 'error',
+        'no-unneeded-ternary': ['error', { defaultAssignment: false }],
+        'no-unreachable': 'error',
+        'no-unreachable-loop': 'error',
+        'no-unsafe-finally': 'error',
+        'no-unsafe-negation': 'error',
+        'no-unused-expressions': ['error', {
+          allowShortCircuit: true,
+          allowTaggedTemplates: true,
+          allowTernary: true,
+        }],
+        'no-unused-vars': ['error', {
+          args: 'none',
+          caughtErrors: 'none',
+          ignoreRestSiblings: true,
+          vars: 'all',
+        }],
+        'no-use-before-define': ['error', { classes: false, functions: false, variables: true }],
+        'no-useless-backreference': 'error',
+        'no-useless-call': 'error',
+        'no-useless-catch': 'error',
+        'no-useless-computed-key': 'error',
+        'no-useless-constructor': 'error',
+        'no-useless-rename': 'error',
+        'no-useless-return': 'error',
+        'no-var': 'error',
+        'no-with': 'error',
+        'object-shorthand': [
+          'error',
+          'always',
+          {
+            avoidQuotes: true,
+            ignoreConstructors: false,
+          },
+        ],
+        'one-var': ['error', { initialized: 'never' }],
+        'prefer-arrow-callback': [
+          'error',
+          {
+            allowNamedFunctions: false,
+            allowUnboundThis: true,
+          },
+        ],
+        'prefer-const': [
+          'error',
+          {
+            destructuring: 'all',
+            ignoreReadBeforeAssign: true,
+          },
+        ],
+        'prefer-exponentiation-operator': 'error',
+        'prefer-promise-reject-errors': 'error',
+        'prefer-regex-literals': ['error', { disallowRedundantWrapping: true }],
+        'prefer-rest-params': 'error',
+        'prefer-spread': 'error',
+        'prefer-template': 'error',
+        'sort-imports': [
+          'error',
+          {
+            allowSeparatedGroups: false,
+            ignoreCase: false,
+            ignoreDeclarationSort: true,
+            ignoreMemberSort: false,
+            memberSyntaxSortOrder: ['none', 'all', 'multiple', 'single'],
+          },
+        ],
+
+        'symbol-description': 'error',
+        'unicode-bom': ['error', 'never'],
+        'unused-imports/no-unused-imports': isInEditor ? 'off' : 'error',
+
+        'unused-imports/no-unused-vars': [
+          'error',
+          { args: 'after-used', argsIgnorePattern: '^_', vars: 'all', varsIgnorePattern: '^_' },
+        ],
+        'use-isnan': ['error', { enforceForIndexOf: true, enforceForSwitchCase: true }],
+        'valid-typeof': ['error', { requireStringLiterals: true }],
+        'vars-on-top': 'error',
+        'yoda': ['error', 'never'],
+
+        ...overrides,
+      },
+    },
+    {
+      files: [`scripts/${GLOB_SRC}`, `cli.${GLOB_SRC_EXT}`],
+      name: 'antfu:scripts-overrides',
+      rules: {
+        'no-console': 'off',
+      },
+    },
+  ]
+}

package/core/src/eslint-config/src/configs/jsdoc.ts

@@ -0,0 +1,42 @@
+import { interopDefault } from '../utils'
+import type { FlatConfigItem, OptionsStylistic } from '../types'
+
+export async function jsdoc(options: OptionsStylistic = {}): Promise<FlatConfigItem[]> {
+  const {
+    stylistic = true,
+  } = options
+
+  return [
+    {
+      name: 'antfu:jsdoc',
+      plugins: {
+        // @ts-expect-error missing types
+        jsdoc: await interopDefault(import('eslint-plugin-jsdoc')),
+      },
+      rules: {
+        'jsdoc/check-access': 'warn',
+        'jsdoc/check-param-names': 'warn',
+        'jsdoc/check-property-names': 'warn',
+        'jsdoc/check-types': 'warn',
+        'jsdoc/empty-tags': 'warn',
+        'jsdoc/implements-on-classes': 'warn',
+        'jsdoc/no-defaults': 'warn',
+        'jsdoc/no-multi-asterisks': 'warn',
+        'jsdoc/require-param-name': 'warn',
+        'jsdoc/require-property': 'warn',
+        'jsdoc/require-property-description': 'warn',
+        'jsdoc/require-property-name': 'warn',
+        'jsdoc/require-returns-check': 'warn',
+        'jsdoc/require-returns-description': 'warn',
+        'jsdoc/require-yields-check': 'warn',
+
+        ...stylistic
+          ? {
+              'jsdoc/check-alignment': 'warn',
+              'jsdoc/multiline-blocks': 'warn',
+            }
+          : {},
+      },
+    },
+  ]
+}