@vitnode/config 0.0.1-canary.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 aXenDev Maciej Balcerzak
+
+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,50 @@
+# (VitNode) ESLint Config
+
+This package provides a default ESLint configuration, TypeScript configuration, and Prettier configuration for VitNode projects.
+
+<p align="center">
+  <br>
+  <a href="https://vitnode.com/" target="_blank">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/VitNode/vitnode/canary/assets/logo/vitnode_logo_dark.svg">
+      <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/VitNode/vitnode/canary/assets/logo/vitnode_logo_light.svg">
+      <img alt="VitNode Logo" src="https://raw.githubusercontent.com/VitNode/vitnode/canary/assets/logo/vitnode_logo_light.svg" width="400">
+    </picture>
+  </a>
+  <br>
+  <br>
+</p>
+
+## Usage
+
+### ESLint (eslint.config.mjs)
+
+```js
+import eslintVitNode from "@vitnode/config/eslint";
+
+export default [...eslintVitNode];
+```
+
+### TypeScript (tsconfig.json)
+
+```json
+{
+  "extends": "@vitnode/config/tsconfig"
+}
+```
+
+### Prettier (.prettierrc.mjs)
+
+```js
+import vitnodePrettier from "@vitnode/config/prettierrc";
+
+/**
+ * @see https://prettier.io/docs/en/configuration.html
+ * @type {import("prettier").Config}
+ */
+const config = {
+  ...vitnodePrettier,
+};
+
+export default config;
+```

package/eslint.config.mjs

@@ -0,0 +1,124 @@
+// @ts-check
+
+import eslint from "@eslint/js";
+import perfectionist from "eslint-plugin-perfectionist";
+import eslintPluginPrettierRecommended from "eslint-plugin-prettier/recommended";
+import tsEslint from "typescript-eslint";
+
+export default [
+  {
+    ignores: [
+      "dist",
+      ".prettierrc.mjs",
+      "node_modules",
+      "eslint.config.mjs",
+      "postcss.config.mjs",
+      ".turbo",
+      "global.d.ts",
+      "tsup.config.ts",
+      "*.test.tsx",
+      "drizzle.config.ts",
+      "cli.mjs",
+    ],
+  },
+  eslint.configs.recommended,
+  ...tsEslint.configs.stylisticTypeChecked,
+  ...tsEslint.configs.strictTypeChecked,
+  eslintPluginPrettierRecommended,
+  perfectionist.configs["recommended-natural"],
+  { files: ["**/*.{js,mjs,cjs,jsx,mjsx,ts,tsx,mtsx}"] },
+  {
+    rules: {
+      "perfectionist/sort-array-includes": "warn",
+      "@typescript-eslint/consistent-type-imports": "error",
+      "@typescript-eslint/no-confusing-void-expression": "off",
+      "@typescript-eslint/no-unnecessary-type-parameters": "off",
+      "@typescript-eslint/no-misused-spread": "off",
+      "perfectionist/sort-decorators": "warn",
+      "perfectionist/sort-modules": "off",
+      "perfectionist/sort-switch-case": "warn",
+      "@typescript-eslint/no-unnecessary-condition": "off",
+      "perfectionist/sort-named-exports": "warn",
+      "perfectionist/sort-enums": "warn",
+      "perfectionist/sort-exports": "warn",
+      "@typescript-eslint/no-dynamic-delete": "off",
+      "perfectionist/sort-named-imports": "warn",
+      "perfectionist/sort-intersection-types": "warn",
+      "perfectionist/sort-interfaces": "warn",
+      "perfectionist/sort-union-types": "warn",
+      "perfectionist/sort-object-types": "warn",
+      "perfectionist/sort-jsx-props": "warn",
+      "perfectionist/sort-imports": "warn",
+      "@typescript-eslint/no-unsafe-call": "off",
+      "perfectionist/sort-objects": "off",
+      "perfectionist/sort-classes": [
+        "warn",
+        {
+          groups: [
+            "constructor",
+            "static-block",
+            "index-signature",
+            "static-property",
+            ["protected-property", "protected-accessor-property"],
+            ["private-property", "private-accessor-property"],
+            ["property", "accessor-property"],
+            "static-method",
+            "protected-method",
+            "private-method",
+            "method",
+            ["get-method", "set-method"],
+            "unknown",
+          ],
+        },
+      ],
+      "no-console": "error",
+      "consistent-return": "off",
+      "@typescript-eslint/no-unused-vars": [
+        "warn",
+        {
+          ignoreRestSiblings: false,
+          caughtErrorsIgnorePattern: "^_",
+        },
+      ],
+      "@typescript-eslint/no-empty-function": "off",
+      "@typescript-eslint/unbound-method": "off",
+      "@typescript-eslint/no-misused-promises": "off",
+      "@typescript-eslint/no-unsafe-return": "off",
+      "@typescript-eslint/no-unsafe-assignment": "off",
+      "@typescript-eslint/no-unsafe-member-access": "off",
+      "@typescript-eslint/no-useless-constructor": "off",
+      "@typescript-eslint/prefer-readonly": "warn",
+      "@typescript-eslint/require-array-sort-compare": "error",
+      "@typescript-eslint/promise-function-async": "error",
+      "@typescript-eslint/no-extraneous-class": "off",
+      "@typescript-eslint/restrict-template-expressions": "off",
+      "@typescript-eslint/consistent-type-exports": "error",
+      "@typescript-eslint/no-unnecessary-qualifier": "error",
+      "@typescript-eslint/no-useless-empty-export": "error",
+      "@typescript-eslint/method-signature-style": "warn",
+      "newline-before-return": "warn",
+      "no-restricted-imports": [
+        "error",
+        {
+          name: "drizzle-orm/mysql-core",
+          message: "Please import from `drizzle-orm/pg-core` instead.",
+        },
+      ],
+    },
+  },
+  {
+    // A plugin's route tree - and only that file - is one
+    // `lazy(() => import("./pages/my-page"))` per route, which is VitNode's
+    // documented API: the callback is *stored*, never called here, so
+    // `promise-function-async` would ask every plugin author to write
+    // `async () => await import(...)` for a promise nobody in the file awaits.
+    //
+    // `**/src/routes.ts` rather than `**/routes.ts`, because the parent
+    // directory is what makes it a route tree: a plugin's is `src/routes.ts`,
+    // which is what its `<plugin>/routes` export subpath resolves to. Any other
+    // `routes.ts` - `src/content/server/routes.ts`, an API module's - keeps the
+    // rule, and should.
+    files: ["**/src/routes.ts", "**/src/routes.tsx"],
+    rules: { "@typescript-eslint/promise-function-async": "off" },
+  },
+];

package/eslint.react.config.mjs

@@ -0,0 +1,68 @@
+// @ts-check
+
+import eslintReact from "@eslint-react/eslint-plugin";
+import hooksPlugin from "eslint-plugin-react-hooks";
+import reactYouMightNotNeedAnEffect from "eslint-plugin-react-you-might-not-need-an-effect";
+import jsxA11y from "eslint-plugin-jsx-a11y";
+
+export default [
+  reactYouMightNotNeedAnEffect.configs.recommended,
+  eslintReact.configs.recommended,
+  {
+    files: ["**/*.{js,mjs,cjs,ts,jsx,tsx}"],
+    settings: {
+      react: {
+        version: "detect",
+      },
+    },
+    languageOptions: {
+      parserOptions: {
+        ecmaFeatures: {
+          jsx: true,
+        },
+      },
+    },
+  },
+  {
+    plugins: {
+      "react-hooks": hooksPlugin,
+      "jsx-a11y": jsxA11y,
+    },
+    rules: {
+      "react/react-in-jsx-scope": "off",
+      ...hooksPlugin.configs.recommended.rules,
+    },
+  },
+  { files: ["**/*.{js,mjs,cjs,jsx,mjsx,ts,tsx,mtsx}"] },
+  {
+    rules: {
+      "@eslint-react/no-leaked-conditional-rendering": "error",
+      "react-hooks/exhaustive-deps": "off",
+      "@eslint-react/no-context-provider": "off",
+      "@eslint-react/no-unstable-default-props": "off",
+      "no-restricted-imports": [
+        "error",
+        {
+          patterns: [
+            {
+              // VitNode runs on TanStack Start. Next.js is not a dependency of
+              // any workspace package, so these resolve to nothing - the ban is
+              // here to fail the lint with an explanation rather than a
+              // "cannot find module".
+              group: ["next", "next/*", "next/**"],
+              message:
+                "VitNode no longer runs on Next.js. Use `@vitnode/core/tanstack/*` for routing and navigation.",
+            },
+            {
+              // `use-intl` is the framework-neutral half of next-intl and is a
+              // direct dependency of @vitnode/core. `next-intl` re-exports it
+              // plus Next server bindings that no longer have a runtime.
+              group: ["next-intl", "next-intl/*"],
+              message: "Import from `use-intl` instead of `next-intl`.",
+            },
+          ],
+        },
+      ],
+    },
+  },
+];

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@vitnode/config",
+  "version": "0.0.1-canary.0",
+  "description": "ESLint, Prettier, TypeScript (TSConfig) config for VitNode",
+  "author": "VitNode Team",
+  "license": "MIT",
+  "homepage": "https://vitnode.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/aXenDeveloper/vitnode.git",
+    "directory": "packages/config"
+  },
+  "keywords": [
+    "vitnode",
+    "typescript",
+    "tsconfig",
+    "eslint",
+    "prettier"
+  ],
+  "type": "module",
+  "exports": {
+    "./eslint": {
+      "import": "./eslint.config.mjs",
+      "default": "./eslint.config.mjs"
+    },
+    "./eslint.react": {
+      "import": "./eslint.react.config.mjs",
+      "default": "./eslint.react.config.mjs"
+    },
+    "./tsconfig": {
+      "import": "./tsconfig.json",
+      "default": "./tsconfig.json"
+    },
+    "./prettierrc": {
+      "import": "./prettierrc.mjs",
+      "default": "./prettierrc.mjs"
+    }
+  },
+  "peerDependencies": {
+    "eslint": "^10.0.0",
+    "prettier": "^3.x.x",
+    "typescript": "6.0.x"
+  },
+  "devDependencies": {
+    "eslint": "^10.7.0",
+    "typescript": "^6.0.3"
+  },
+  "dependencies": {
+    "@eslint-react/eslint-plugin": "^5.17.3",
+    "@eslint/js": "^10.0.1",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-jsx-a11y": "^6.10.2",
+    "eslint-plugin-perfectionist": "^5.10.0",
+    "eslint-plugin-prettier": "^5.5.6",
+    "eslint-plugin-react-hooks": "^7.1.1",
+    "eslint-plugin-react-you-might-not-need-an-effect": "^1.0.1",
+    "prettier-plugin-tailwindcss": "^0.8.1",
+    "typescript-eslint": "^8.65.0"
+  }
+}

package/prettierrc.mjs

@@ -0,0 +1,14 @@
+/**
+ * @see https://prettier.io/docs/en/configuration.html
+ * @type {import("prettier").Config}
+ */
+const config = {
+  singleQuote: false,
+  arrowParens: "avoid",
+  trailingComma: "all",
+  printWidth: 80,
+  plugins: ["prettier-plugin-tailwindcss"],
+  tailwindFunctions: ["cn"],
+};
+
+export default config;

package/tsconfig.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "compilerOptions": {
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "allowJs": false,
+    "skipLibCheck": true,
+    "resolveJsonModule": true,
+    "strict": true,
+    "esModuleInterop": true,
+    "isolatedModules": true,
+    "jsx": "preserve",
+    "incremental": true,
+    "composite": false,
+    "removeComments": true,
+    "noImplicitAny": false,
+    "strictNullChecks": true,
+    "strictPropertyInitialization": false,
+    "strictBindCallApply": false,
+    "allowSyntheticDefaultImports": true,
+    "forceConsistentCasingInFileNames": true,
+    "erasableSyntaxOnly": true,
+    "verbatimModuleSyntax": true
+  }
+}