@liberfi.io/eslint-config 0.1.6-main.0

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @liberfi.io/eslint-config
+
+## 0.1.6-main.0
+
+### Patch Changes
+
+- publish

package/index.mjs

@@ -0,0 +1,181 @@
+import stylistic from "@stylistic/eslint-plugin";
+import eslintConfigPrettier from "eslint-config-prettier/flat";
+// import importPlugin from "eslint-plugin-import";
+import monorepoCop from "eslint-plugin-monorepo-cop";
+import reactPlugin from "eslint-plugin-react";
+import * as reactHooks from "eslint-plugin-react-hooks";
+import reactRefresh from "eslint-plugin-react-refresh";
+// TODO tailwind v4 not supported yet
+// import tailwind from "eslint-plugin-tailwindcss";
+import { defineConfig, globalIgnores } from "eslint/config";
+import globals from "globals";
+// import path from "path";
+import ts from "typescript-eslint";
+
+// import { fileURLToPath } from "url";
+
+// const __filename = fileURLToPath(import.meta.url);
+// const __dirname = path.dirname(__filename);
+
+export default defineConfig([
+  globalIgnores([
+    "**/build/",
+    "**/dist/",
+    "**/node_modules/",
+    "**/public/",
+    "**/__test__/",
+    "**/storybook-static/",
+    // TODO: remove this when packages/component/ deleted
+    // "packages/component/",
+    // TODO: remove this when apps/docs/ deleted
+    // "apps/docs/",
+    "**/*.js",
+    "**/*.cjs",
+    "**/*.d.ts",
+  ]),
+  {
+    languageOptions: {
+      // parser: typescriptEslintParser,
+      parserOptions: {
+        ecmaFeatures: {
+          jsx: true,
+        },
+      },
+      globals: {
+        ...globals.browser,
+      },
+    },
+  },
+  // add eslint built-in
+  // https://github.com/eslint/eslint/blob/main/packages/js/src/configs/eslint-recommended.js
+  // js.configs.recommended,
+
+  // add `typescript-eslint` flat config simply
+  // if you would like use more another configuration,
+  // see the section: https://typescript-eslint.io/getting-started#details
+  // https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/eslintrc/recommended.ts
+  ...ts.configs.recommended,
+
+  // TODO tailwind v4 not supported yet
+  // https://github.com/francoismassart/eslint-plugin-tailwindcss
+  // https://github.com/francoismassart/eslint-plugin-tailwindcss/blob/master/lib/config/flat-recommended.js
+  // ...tailwind.configs["flat/recommended"],
+
+  // https://github.com/vercel/turborepo/blob/main/packages/eslint-config-turbo/src/flat/index.ts
+  // ...turboConfig,
+
+  // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/index.js#L108
+  reactPlugin.configs.flat.recommended,
+  // Add this if you are using React 17+
+  reactPlugin.configs.flat["jsx-runtime"],
+
+  // https://github.com/import-js/eslint-plugin-import
+  // importPlugin.flatConfigs.recommended,
+  // use custom config instead of importPlugin.flatConfigs.recommended, because it's too strict for our project
+  // {
+  //   plugins: {
+  //     import: importPlugin,
+  //   },
+  //   rules: {
+  //     "import/no-relative-packages": "error",
+  //     // analysis/correctness
+  //     "import/no-unresolved": "warn",
+  //     "import/named": "warn",
+  //     "import/namespace": "warn",
+  //     "import/default": "warn",
+  //     "import/export": "warn",
+
+  //     // red flags (thus, warnings)
+  //     "import/no-named-as-default": "warn",
+  //     "import/no-named-as-default-member": "warn",
+  //     "import/no-duplicates": "warn",
+  //   },
+  //   languageOptions: {
+  //     // need all these for parsing dependencies (even if _your_ code doesn't need
+  //     // all of them)
+  //     parserOptions: {
+  //       sourceType: "module",
+  //       ecmaVersion: 2018,
+  //     },
+  //   },
+  // },
+  {
+    files: ["**/*.{ts,tsx}"],
+    // ignores: ["dist/**", "build/**", "node_modules/**"],
+    plugins: {
+      // https://eslint.style/packages/default
+      "@stylistic": stylistic,
+      "monorepo-cop": monorepoCop,
+      "react-hooks": reactHooks,
+      "react-refresh": reactRefresh,
+    },
+    rules: {
+      "no-console": ["warn", { allow: ["warn", "error"] }],
+      // "@stylistic/semi": ["error", "never"],
+      "prefer-const": "warn",
+      "@typescript-eslint/no-unused-expressions": "warn",
+      "@typescript-eslint/no-explicit-any": "warn",
+      "@typescript-eslint/no-unused-vars": "warn",
+      "@typescript-eslint/ban-ts-comment": "warn",
+      "@typescript-eslint/no-empty-object-type": "warn",
+      "@typescript-eslint/no-unused-vars": "warn",
+      "@typescript-eslint/no-unnecessary-type-constraint": "warn",
+      "@typescript-eslint/no-empty-object-type": "warn",
+      "@typescript-eslint/no-non-null-asserted-optional-chain": "warn",
+      "@typescript-eslint/no-namespace": "off",
+      "@typescript-eslint/ban-ts-comment": "off",
+      "react/prop-types": "off",
+      "react/display-name": "off",
+      "react/no-children-prop": "warn",
+      "tailwindcss/no-custom-classname": "off",
+
+      // https://github.com/sterlingwes/eslint-plugin-monorepo-cop
+      // prevent relative imports outside of monorepo package
+      "monorepo-cop/no-relative-import-outside-package": "error",
+      "monorepo-cop/no-disable-monorepo-no-relative-rule": "error",
+
+      // https://github.com/facebook/react/tree/main/packages/eslint-plugin-react-hooks#flat-config-eslintconfigjsts-1
+      "react-hooks/rules-of-hooks": "warn",
+      // it cause too many false positives, use eslint-plugin-react-hooks-configurable won't solve the problem either
+      // "react-hooks/exhaustive-deps": "warn",
+
+      // https://github.com/ArnaudBarre/eslint-plugin-react-refresh?tab=readme-ov-file#without-config
+      "react-refresh/only-export-components": "off",
+      // "react-refresh/only-export-components": [
+      //   "warn",
+      //   { allowConstantExport: true },
+      // ],
+    },
+  },
+
+  eslintConfigPrettier,
+  {
+    settings: {
+      react: {
+        version: "detect",
+      },
+      // TODO tailwind v4 not supported yet
+      // https://github.com/francoismassart/eslint-plugin-tailwindcss/tree/master/docs/rules
+      // tailwindcss: {
+      //   callees: ["classnames", "cnBase", "cn"],
+      //   config: path.resolve(__dirname, "../ui/tailwind.config.js"),
+      //   // default
+      //   cssFiles: [
+      //     "**/*.css",
+      //     "!**/node_modules",
+      //     "!**/.*",
+      //     "!**/dist",
+      //     "!**/build",
+      //   ],
+      //   cssFilesRefreshRate: 5_000,
+      //   removeDuplicates: true,
+      //   skipClassAttribute: false,
+      //   whitelist: [],
+      //   // can be set to e.g. ['tw'] for use in tw`bg-blue`
+      //   tags: [],
+      //   // can be modified to support custom attributes. E.g. "^tw$" for `twin.macro`
+      //   classRegex: "^class(Name)?$",
+      // },
+    },
+  },
+]);

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@liberfi.io/eslint-config",
+  "version": "0.1.6-main.0",
+  "main": "index.mjs",
+  "module": "index.mjs",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@eslint/js": "^9.35.0",
+    "@stylistic/eslint-plugin": "^5.3.1",
+    "eslint-config-eslint": "^13.0.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-config-turbo": "^2.5.6",
+    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-monorepo-cop": "^1.0.2",
+    "eslint-plugin-react": "^7.37.5",
+    "eslint-plugin-react-hooks": "^5.2.0",
+    "eslint-plugin-react-refresh": "^0.4.20",
+    "globals": "^16.4.0",
+    "typescript-eslint": "^8.43.0"
+  }
+}