@maneko/eslint-config 0.1.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Maneko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,204 @@
+# @maneko/eslint-config
+
+[![Stars](https://img.shields.io/github/stars/maneko-org/eslint-config?style=flat-square&logoColor=white)](https://github.com/maneko-org/eslint-config/stargazers)
+[![Forks](https://img.shields.io/github/forks/maneko-org/eslint-config?style=flat-square&logoColor=white)](https://github.com/maneko-org/eslint-config/network/members)
+[![Pull Requests](https://img.shields.io/github/issues-pr/maneko-org/eslint-config?style=flat-square&logoColor=white)](https://github.com/maneko-org/eslint-config/pulls)
+[![Issues](https://img.shields.io/github/issues/maneko-org/eslint-config?style=flat-square&logoColor=white)](https://github.com/maneko-org/eslint-config/issues)
+[![Contributors](https://img.shields.io/github/contributors/maneko-org/eslint-config?style=flat-square&logoColor=white)](https://github.com/maneko-org/eslint-config/graphs/contributors)
+[![License](https://img.shields.io/github/license/maneko-org/eslint-config?style=flat-square&logoColor=white)](https://github.com/maneko-org/eslint-config/blob/main/LICENSE)
+
+A shared, ESLint config four our projects - simple, consistent and modern. Inspired by `@antfu/eslint-config`, tailored for real-world apps and libraries.
+
+## Why use this
+
+- **One-line setup** for a sensible, opinionated ESLint Flat config.
+- Works with JavaScript and TypeScript (TS support is opt-in).
+- Opt-in integrations: React, NextJS, Vue, Svelte, Astro, Solid.
+- Fixable stylistic rules that play nicely with `eslint --fix`, CI and `lint-staged`.
+- ESM-first and composable - easy to extend or override.
+
+> **Note:** This preset is opinionated. It aims to reduce bikeshedding and keep diffs small. If you need different choices - override rules locally or fork.
+
+## Quick start
+
+Install preset + eslint in your project:
+
+```bash
+# pnpm (recommended)
+pnpm add -D eslint @maneko/eslint-config
+
+# yarn
+yarn add -D eslint @maneko/eslint-config
+
+# npm
+npm install -D eslint @maneko/eslint-config
+```
+
+> **Why install `eslint` in the project?**
+> The VS Code ESLint extension resolves `eslint` from the project root `node_modules`. Install it in the host project so the editor finds the binary and plugins.
+
+Create `eslint.config.mjs` in your project root:
+
+```js
+import { eslint } from '@maneko/eslint-config';
+
+export default eslint({
+  // A simple example
+  jsx: { a11y: true },
+  react: true
+});
+```
+
+Minimal preset:
+
+```js
+import { eslint } from '@maneko/eslint-config';
+
+export default eslint();
+```
+
+## Usage & recipes
+
+### JavaScript
+
+```js
+import { eslint } from '@maneko/eslint-config';
+
+export default eslint();
+```
+
+### TypeScript + React
+
+```js
+import { eslint } from '@maneko/eslint-config';
+
+export default eslint({
+  typescript: true,
+  react: { a11y: true }
+});
+```
+
+### Combine with legacy `.eslintrc` (FlatCompat)
+
+If you need to migrate legacy configs, use `@eslint/eslintrc` + `FlatCompat`:
+
+```js
+import { FlatCompat } from '@eslint/eslintrc';
+import { eslint } from '@maneko/eslint-config';
+
+const compat = new FlatCompat();
+export default eslint({}, ...compat.config({ extends: ['eslint:recommended'] }));
+```
+
+## Scripts (recommended)
+
+Add scripts to `package.json`:
+
+```json
+{
+  "scripts": {
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix"
+  }
+}
+```
+
+Example `lint-staged` + `husky`:
+
+```json
+{
+  "lint-staged": {
+    "**/*.{js,ts,jsx,tsx,mjs}": ["pnpm lint:fix"]
+  }
+}
+```
+
+## IDEs and code editors
+
+### VS Code (recommended)
+
+Install the ESLint extension and use:
+
+```jsonc
+// .vscode/settings.json
+{
+  "prettier.enable": false,
+  "editor.formatOnSave": false,
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "explicit",
+    "source.organizeImports": "never"
+  }
+}
+```
+
+> Ensure `eslint` exists in the project root `node_modules` - the extension does not resolve nested copies reliably.
+
+### Neovim
+
+Use `nvim-lspconfig` or your favorite tooling. To run auto-fix on save:
+
+```lua
+-- call EslintFixAll on BufWritePre
+vim.api.nvim_create_autocmd("BufWritePre", {
+  pattern = {"*.js","*.ts","*.jsx","*.tsx"},
+  callback = function() vim.cmd("EslintFixAll") end
+})
+```
+
+Or use `null-ls` / `conform.nvim` as an alternative.
+
+## Features
+
+- JavaScript & TypeScript support (TS opt-in via factory option).
+- React/Next/Vue/Svelte/Astro/Solid integrations (opt-in).
+- Accessibility rules (a11y) for React/Vue when enabled.
+- Opinionated stylistic rules (using `style/*`) that are auto-fixable.
+- Composer API: `.prepend()`, `.override()`, `.renamePlugins()` for advanced composition.
+
+## Customization
+
+Pass options or extra flat-configs to the factory:
+
+```js
+import { eslint } from '@maneko/eslint-config';
+
+export default eslint(
+  { typescript: true, react: true },
+  {
+    files: ['**/*.ts'],
+    rules: {
+      'no-console': 'warn'
+    }
+  }
+);
+```
+
+Advanced composer example:
+
+```js
+export default eslint()
+  .prepend(/* config */)
+  .override('maneko/stylistic/rules', {
+    rules: { 'style/semi': ['error', 'never'] }
+  })
+  .renamePlugins({ ts: '@typescript-eslint' });
+```
+
+## Common problems & fixes (quick)
+
+- **VS Code not linting** - make sure `eslint` is installed in the project root (not only globally).
+- **Missing parser/plugin errors** - install peer deps in the host project (e.g. `eslint-plugin-react`).
+- **Rules auto-fixed unexpectedly in the editor** - check `.vscode/settings.json` - some stylistic rules may be turned off in the editor and still be fixable on CLI runs.
+- **Legacy `.eslintrc`** - convert using `FlatCompat` or maintain a small adapter file.
+
+## Contributing
+
+PRs welcome. Keep changes small and document any new opinionated rules.
+
+## Acknowledgements
+
+Inspired by `@antfu/eslint-config` - thanks for the design & DX philosophy.
+
+## License
+
+`@maneko/eslint-config` is licensed under the MIT License. See the `LICENSE` file in the repository.

package/index.d.ts

@@ -0,0 +1,19 @@
+declare module '@maneko/eslint-config' {
+  import type {
+    Awaitable,
+    ConfigNames,
+    OptionsConfig,
+    TypedFlatConfigItem
+  } from '@antfu/eslint-config';
+  import type { Linter } from 'eslint';
+  import type { FlatConfigComposer } from 'eslint-flat-config-utils';
+
+  export type Eslint = (
+    options?: OptionsConfig & TypedFlatConfigItem,
+    ...userConfigs: Awaitable<
+      FlatConfigComposer<any, any> | Linter.Config[] | TypedFlatConfigItem | TypedFlatConfigItem[]
+    >[]
+  ) => FlatConfigComposer<TypedFlatConfigItem, ConfigNames>;
+
+  export const eslint: Eslint;
+}

package/index.js

@@ -0,0 +1,156 @@
+import antfu from '@antfu/eslint-config';
+import pluginReact from 'eslint-plugin-react';
+
+/** @type {import('@maneko/eslint-config').Eslint} */
+export const eslint = ({ ...options }, ...userConfigs) => {
+  const stylistic = options.stylistic ?? false;
+
+  if (options.react) {
+    userConfigs.unshift({
+      name: 'maneko/react',
+      plugins: {
+        'maneko-react': pluginReact
+      },
+      rules: {
+        'maneko-react/function-component-definition': [
+          'error',
+          {
+            namedComponents: ['arrow-function'],
+            unnamedComponents: 'arrow-function'
+          }
+        ],
+        'maneko-react/prop-types': 'off',
+        'maneko-react/react-in-jsx-scope': 'off'
+      },
+      settings: {
+        react: {
+          version: 'detect'
+        }
+      }
+    });
+  }
+
+  if (stylistic) {
+    userConfigs.unshift({
+      name: 'maneko/stylistic',
+      rules: {
+        'style/arrow-parens': ['error', 'always'],
+        'style/brace-style': 'off',
+        'style/comma-dangle': ['error', 'never'],
+        'style/indent': ['error', 2, { SwitchCase: 1 }],
+        'style/jsx-curly-newline': 'off',
+        'style/jsx-one-expression-per-line': 'off',
+        'style/jsx-quotes': ['error', 'prefer-single'],
+        'style/linebreak-style': ['error', 'unix'],
+        'style/max-len': [
+          'error',
+          100,
+          2,
+          {
+            ignoreComments: true,
+            ignoreStrings: true,
+            ignoreTemplateLiterals: true
+          }
+        ],
+        'style/member-delimiter-style': 'off',
+        'style/multiline-ternary': 'off',
+        'style/no-tabs': 'error',
+        'style/operator-linebreak': 'off',
+        'style/quote-props': 'off',
+        'style/quotes': ['error', 'single', { avoidEscape: true, allowTemplateLiterals: 'always' }],
+        'style/semi': ['error', 'always']
+      }
+    });
+  }
+
+  userConfigs.push(
+    {
+      name: 'maneko/rewrite',
+      rules: {
+        'antfu/curly': 'off',
+        'antfu/if-newline': 'off',
+        'antfu/top-level-function': 'off',
+        'no-console': 'warn',
+        'react-hooks/exhaustive-deps': 'off',
+        'test/prefer-lowercase-title': 'off'
+      }
+    },
+    {
+      name: 'maneko/sort',
+      rules: {
+        'perfectionist/sort-array-includes': [
+          'error',
+          {
+            order: 'asc',
+            type: 'alphabetical'
+          }
+        ],
+        'perfectionist/sort-imports': [
+          'error',
+          {
+            groups: [
+              'type',
+              ['builtin', 'external'],
+              'internal-type',
+              ['internal'],
+              ['parent-type', 'sibling-type', 'index-type'],
+              ['parent', 'sibling', 'index'],
+              'object',
+              'style',
+              'side-effect-style',
+              'unknown'
+            ],
+            internalPattern: ['^~/.*', '^@/.*'],
+            newlinesBetween: 'always',
+            order: 'asc',
+            type: 'natural'
+          }
+        ],
+        'perfectionist/sort-interfaces': [
+          'error',
+          {
+            groups: ['unknown', 'method', 'multiline'],
+            order: 'asc',
+            type: 'alphabetical'
+          }
+        ],
+        'perfectionist/sort-jsx-props': [
+          'error',
+          {
+            customGroups: {
+              callback: 'on*',
+              reserved: ['key', 'ref']
+            },
+            groups: ['shorthand', 'reserved', 'multiline', 'unknown', 'callback'],
+            order: 'asc',
+            type: 'alphabetical'
+          }
+        ],
+        'perfectionist/sort-union-types': [
+          'error',
+          {
+            groups: [
+              'conditional',
+              'function',
+              'import',
+              'intersection',
+              'keyword',
+              'literal',
+              'named',
+              'object',
+              'operator',
+              'tuple',
+              'union',
+              'nullish'
+            ],
+            order: 'asc',
+            specialCharacters: 'keep',
+            type: 'alphabetical'
+          }
+        ]
+      }
+    }
+  );
+
+  return antfu({ ...options, stylistic }, ...userConfigs);
+};

package/package.json

@@ -0,0 +1,75 @@
+{
+  "name": "@maneko/eslint-config",
+  "type": "module",
+  "version": "0.1.3",
+  "description": "Shared ESLint config for our projects",
+  "author": "Maneko <contact@maneko.moe>",
+  "license": "MIT",
+  "homepage": "https://github.com/maneko-org/eslint-config",
+  "repository": {
+    "url": "https://github.com/maneko-org/eslint-config"
+  },
+  "bugs": {
+    "url": "https://github.com/maneko-org/eslint-config/issues"
+  },
+  "keywords": [
+    "javascript",
+    "typescript",
+    "jsx",
+    "vue",
+    "astro",
+    "stylistic",
+    "react",
+    "nextjs",
+    "solid",
+    "svelte"
+  ],
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "index.js",
+  "types": "index.d.ts",
+  "files": [
+    "index.d.ts",
+    "index.js"
+  ],
+  "peerDependencies": {
+    "eslint": "^9.38.0"
+  },
+  "dependencies": {
+    "@antfu/eslint-config": "^6.2.0",
+    "@eslint-react/eslint-plugin": "^2.3.9",
+    "@next/eslint-plugin-next": "^16.0.4",
+    "eslint-plugin-jsx-a11y": "^6.10.2",
+    "eslint-plugin-react": "^7.37.5",
+    "eslint-plugin-react-hooks": "^7.0.1",
+    "eslint-plugin-react-refresh": "^0.4.24"
+  },
+  "devDependencies": {
+    "@maneko/prettier-config": "^0.1.1",
+    "bumpp": "^10.3.1",
+    "eslint": "^9.38.0",
+    "eslint-flat-config-utils": "^2.1.4",
+    "husky": "^9.1.7",
+    "lint-staged": "^16.2.4",
+    "prettier": "^3.6.2",
+    "typescript": "^5.9.3"
+  },
+  "lint-staged": {
+    "*.{js,ts}": [
+      "prettier --write",
+      "eslint --fix"
+    ]
+  },
+  "scripts": {
+    "format": "prettier --write \"*.js\"",
+    "lint": "eslint . --fix",
+    "lint-inspector": "npx @eslint/config-inspector"
+  }
+}