@widergy/eslint-config 1.0.0

package/.circleci/config.yml

@@ -0,0 +1,28 @@
+version: 2
+
+aliases:
+  - &widergy-context
+    context:
+      - widergy-aws-github
+
+jobs:
+  release:
+    docker:
+      - image: cimg/node:22.18.0
+    steps:
+      - checkout
+      - run: yarn install
+
+      - run: npx semantic-release
+
+
+workflows:
+  version: 2
+  test_and_release:
+    jobs:
+      - release:
+          <<: *widergy-context
+          filters:
+            branches:
+              only:
+                - master

package/README.md

@@ -0,0 +1 @@
+# eslint-config

package/eslint.config.js

@@ -0,0 +1,41 @@
+import { defineConfig } from "eslint/config";
+import js from "@eslint/js";
+import importPlugin from "eslint-plugin-import";
+import prettierPlugin from "eslint-plugin-prettier";
+import babelParser from "@babel/eslint-parser";
+
+export default defineConfig([
+  js.configs.recommended,
+  {
+    ignores: ["node_modules/**", "dist/**", "build/**"],
+    languageOptions: {
+      globals: {},
+      parser: babelParser,
+      parserOptions: {
+        ecmaVersion: "latest",
+        requireConfigFile: false,
+        sourceType: "module",
+      },
+    },
+    name: "internal-config",
+    plugins: {
+      import: importPlugin,
+      prettier: prettierPlugin,
+    },
+    rules: {
+      "sort-keys": [
+        "error",
+        "asc",
+        { allowLineSeparatedGroups: true, caseSensitive: false, natural: true },
+      ],
+    },
+    settings: {
+      "import/resolver": {
+        node: {
+          extensions: [".js", ".mjs", ".cjs", ".json"],
+          moduleDirectory: ["node_modules", "src/"],
+        },
+      },
+    },
+  },
+]);

package/package.json

@@ -0,0 +1,81 @@
+{
+  "name": "@widergy/eslint-config",
+  "version": "1.0.0",
+  "description": "Widergy ESLint configuration",
+  "type": "module",
+  "author": "widergy",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/widergy/eslint-config.git"
+  },
+  "main": "./src/index.js",
+  "exports": {
+    "./javascript": "./src/javascript.js",
+    "./react": "./src/react.js",
+    "./react-native": "./src/react-native.js"
+  },
+  "keywords": [
+    "eslint",
+    "config",
+    "widergy"
+  ],
+  "scripts": {
+    "lint": "eslint ."
+  },
+  "peerDependencies": {
+    "@babel/core": "^7.22.10",
+    "@babel/eslint-parser": "^7.22.10",
+    "@babel/preset-typescript": "^7.28.0",
+    "@eslint/compat": "^1.4.0",
+    "@eslint/eslintrc": "^3.3.0",
+    "@eslint/js": "^9.0.0",
+    "@react-native/babel-preset": "^0.80.0",
+    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@typescript-eslint/parser": "^6.21.0",
+    "eslint": "^9.0.0",
+    "eslint-config-airbnb": "^19.0.0",
+    "eslint-import-resolver-babel-module": "^5.3.0",
+    "eslint-import-resolver-typescript": "^4.4.4",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-jsx-a11y": "^6.10.0",
+    "eslint-plugin-prettier": "^5.0.0",
+    "eslint-plugin-react": "^7.37.0",
+    "eslint-plugin-react-hooks": "^5.2.0",
+    "eslint-plugin-react-native": "^5.0.0",
+    "globals": "^16.4.0",
+    "prettier": "^3.0.0",
+    "typescript": "^5.0.0",
+    "typescript-eslint": "^8.46.4"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.22.10",
+    "@babel/eslint-parser": "^7.22.10",
+    "@babel/preset-typescript": "^7.28.0",
+    "@eslint/compat": "^1.4.0",
+    "@eslint/eslintrc": "^3.3.0",
+    "@eslint/js": "^9.0.0",
+    "@react-native/babel-preset": "^0.80.0",
+    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@typescript-eslint/parser": "^6.21.0",
+    "eslint": "^9.0.0",
+    "eslint-config-airbnb": "^19.0.0",
+    "eslint-import-resolver-babel-module": "^5.3.0",
+    "eslint-import-resolver-typescript": "^4.4.4",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-jsx-a11y": "^6.10.2",
+    "eslint-plugin-prettier": "^5.0.0",
+    "eslint-plugin-react": "^7.37.0",
+    "eslint-plugin-react-hooks": "^5.2.0",
+    "eslint-plugin-react-native": "^5.0.0",
+    "globals": "^16.4.0",
+    "prettier": "^3.0.0",
+    "typescript": "^5.0.0",
+    "typescript-eslint": "^8.46.4",
+    "@widergy/semantic-release-package-config": "^1.0.0",
+    "semantic-release": "^15.13.31"
+  },
+  "release": {
+    "extends": "@widergy/semantic-release-package-config"
+  }
+}

package/src/javascript.js

@@ -0,0 +1,113 @@
+import js from "@eslint/js";
+import babelParser from "@babel/eslint-parser";
+import { defineConfig } from "eslint/config";
+import importPlugin from "eslint-plugin-import";
+import prettierPlugin from "eslint-plugin-prettier";
+import globals from "globals";
+import tseslint from "typescript-eslint";
+
+import { compat } from "./utils.js";
+import { baseRules, jsOnlyRules, tsOnlyRules } from "./rules/baseRules.js";
+import { prettierRules } from "./rules/prettierRules.js";
+import { fixupConfigRules, fixupPluginRules } from "@eslint/compat";
+import { importRules } from "./rules/importRules.js";
+
+const tsConfigs = tseslint.configs.recommendedTypeChecked.map((config) => ({
+  ...config,
+  files: ["**/*.{ts,tsx}"],
+}));
+
+export default defineConfig([
+  js.configs.recommended,
+
+  ...fixupConfigRules(
+    compat.extends("plugin:import/recommended", "plugin:prettier/recommended"),
+  ),
+
+  ...tsConfigs,
+
+  {
+    files: ["**/*.{js,jsx,ts,tsx}"],
+    ignores: ["node_modules/**", "dist/**", "build/**"],
+    languageOptions: {
+      ecmaVersion: "latest",
+      globals: {
+        ...globals.node,
+        ...globals.browser,
+        __DEV__: "readonly",
+      },
+      sourceType: "module",
+    },
+    linterOptions: {
+      reportUnusedDisableDirectives: "error",
+    },
+    name: "widergy/javascript",
+    plugins: {
+      import: fixupPluginRules(importPlugin),
+      prettier: fixupPluginRules(prettierPlugin),
+    },
+    rules: {
+      ...baseRules,
+      ...prettierRules,
+      ...importRules,
+    },
+    settings: {
+      "import/resolver": {
+        "babel-module": {},
+        node: {
+          extensions: [".js", ".jsx", ".ts", ".tsx", ".json"],
+          moduleDirectory: ["node_modules", "src/"],
+        },
+        typescript: {
+          project: "./tsconfig.json",
+        },
+      },
+    },
+  },
+
+  {
+    files: ["**/*.js", "**/*.jsx"],
+    languageOptions: {
+      parser: babelParser,
+      parserOptions: {
+        babelOptions: {
+          babelrc: false,
+          configFile: false,
+          plugins: [
+            "import-glob",
+            [
+              "module-resolver",
+              {
+                root: ["./src"],
+              },
+            ],
+          ],
+          presets: ["@babel/preset-env"],
+        },
+        ecmaFeatures: {
+          jsx: true,
+        },
+        requireConfigFile: false,
+      },
+    },
+    name: "widergy/javascript-js",
+    rules: {
+      ...jsOnlyRules,
+    },
+  },
+
+  {
+    files: ["**/*.ts", "**/*.tsx"],
+    languageOptions: {
+      parser: tseslint.parser,
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+    name: "widergy/javascript-ts",
+    rules: {
+      ...tsOnlyRules,
+    },
+  },
+]);

package/src/react-native.js

@@ -0,0 +1,136 @@
+import js from "@eslint/js";
+import importPlugin from "eslint-plugin-import";
+import prettierPlugin from "eslint-plugin-prettier";
+import reactPlugin from "eslint-plugin-react";
+import reactHooksPlugin from "eslint-plugin-react-hooks";
+import reactNativePlugin from "eslint-plugin-react-native";
+import babelParser from "@babel/eslint-parser";
+import { defineConfig } from "eslint/config";
+import { fixupConfigRules, fixupPluginRules } from "@eslint/compat";
+import globals from "globals";
+import tseslint from "typescript-eslint";
+
+import { compat } from "./utils.js";
+import { baseRules, jsOnlyRules, tsOnlyRules } from "./rules/baseRules.js";
+import { prettierRules } from "./rules/prettierRules.js";
+import { importRules } from "./rules/importRules.js";
+import { reactRules } from "./rules/reactRules.js";
+import { reactNativeRules } from "./rules/reactNativeRules.js";
+import { reactHooksRules } from "./rules/reactHooksRules.js";
+
+const tsConfigs = tseslint.configs.recommendedTypeChecked.map((config) => ({
+  ...config,
+  files: ["**/*.{ts,tsx}"],
+}));
+
+export default defineConfig([
+  js.configs.recommended,
+
+  ...fixupConfigRules(
+    compat.extends(
+      "airbnb",
+      "plugin:import/recommended",
+      "plugin:prettier/recommended",
+      "plugin:react/recommended",
+      "plugin:react-hooks/recommended",
+      "plugin:react-native/all",
+    ),
+  ),
+
+  ...tsConfigs,
+
+  {
+    files: ["**/*.{js,jsx,ts,tsx}"],
+    ignores: ["node_modules/**", "dist/**", "build/**", "ios/**", "android/**"],
+    languageOptions: {
+      ecmaVersion: "latest",
+      globals: {
+        ...globals.node,
+        ...globals.browser,
+        __DEV__: "readonly",
+      },
+      sourceType: "module",
+    },
+    linterOptions: {
+      reportUnusedDisableDirectives: "error",
+    },
+    name: "widergy/react-native",
+    plugins: {
+      import: fixupPluginRules(importPlugin),
+      prettier: fixupPluginRules(prettierPlugin),
+      react: fixupPluginRules(reactPlugin),
+      "react-hooks": fixupPluginRules(reactHooksPlugin),
+      "react-native": fixupPluginRules(reactNativePlugin),
+    },
+    rules: {
+      ...baseRules,
+      ...prettierRules,
+      ...importRules,
+      ...reactRules,
+      ...reactHooksRules,
+      ...reactNativeRules,
+    },
+    settings: {
+      "import/resolver": {
+        "babel-module": {},
+        node: {
+          extensions: [".js", ".jsx", ".ts", ".tsx", ".json"],
+          moduleDirectory: ["node_modules", "src"],
+        },
+        typescript: {
+          project: "./tsconfig.json",
+        },
+      },
+      react: {
+        version: "detect",
+      },
+    },
+  },
+
+  {
+    files: ["**/*.js", "**/*.jsx"],
+    languageOptions: {
+      parser: babelParser,
+      parserOptions: {
+        babelOptions: {
+          babelrc: false,
+          configFile: false,
+          plugins: [
+            "import-glob",
+            [
+              "module-resolver",
+              {
+                root: ["./src"],
+              },
+            ],
+            "react-native-worklets/plugin",
+          ],
+          presets: ["module:@react-native/babel-preset"],
+        },
+        ecmaFeatures: {
+          jsx: true,
+        },
+        requireConfigFile: false,
+      },
+    },
+    name: "widergy/react-native-js",
+    rules: {
+      ...jsOnlyRules,
+    },
+  },
+
+  {
+    files: ["**/*.{ts,tsx}"],
+    languageOptions: {
+      parser: tseslint.parser,
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+    name: "widergy/react-native-ts",
+    rules: {
+      ...tsOnlyRules,
+    },
+  },
+]);

package/src/react.js

@@ -0,0 +1,132 @@
+import js from "@eslint/js";
+import importPlugin from "eslint-plugin-import";
+import prettierPlugin from "eslint-plugin-prettier";
+import reactPlugin from "eslint-plugin-react";
+import reactHooksPlugin from "eslint-plugin-react-hooks";
+import babelParser from "@babel/eslint-parser";
+import globals from "globals";
+import tseslint from "typescript-eslint";
+
+import { baseRules, jsOnlyRules, tsOnlyRules } from "./rules/baseRules.js";
+import { importRules } from "./rules/importRules.js";
+import { prettierRules } from "./rules/prettierRules.js";
+import { reactRules } from "./rules/reactRules.js";
+import { reactHooksRules } from "./rules/reactHooksRules.js";
+import { jsxA11yRules } from "./rules/jsxA11yRules.js";
+import { compat } from "./utils.js";
+import { defineConfig } from "eslint/config";
+import { fixupConfigRules, fixupPluginRules } from "@eslint/compat";
+
+const tsConfigs = tseslint.configs.recommendedTypeChecked.map((config) => ({
+  ...config,
+  files: ["**/*.{ts,tsx}"],
+}));
+
+export default defineConfig([
+  js.configs.recommended,
+
+  ...fixupConfigRules(
+    compat.extends(
+      "airbnb",
+      "plugin:import/recommended",
+      "plugin:prettier/recommended",
+      "plugin:react/recommended",
+      "plugin:react-hooks/recommended",
+    ),
+  ),
+
+  ...tsConfigs,
+
+  {
+    files: ["**/*.{js,jsx,ts,tsx}"], // add support for scss files, possibly deprecating node-sass/sass-lint for sass/stylelint
+    ignores: ["node_modules/**", "dist/**", "build/**"],
+    languageOptions: {
+      ecmaVersion: "latest",
+      globals: {
+        ...globals.node,
+        ...globals.browser,
+        __DEV__: "readonly",
+      },
+      sourceType: "module",
+    },
+    linterOptions: {
+      reportUnusedDisableDirectives: "error",
+    },
+    name: "widergy/react-web",
+    plugins: {
+      import: fixupPluginRules(importPlugin),
+      prettier: fixupPluginRules(prettierPlugin),
+      react: fixupPluginRules(reactPlugin),
+      "react-hooks": fixupPluginRules(reactHooksPlugin),
+    },
+    rules: {
+      ...baseRules,
+      ...prettierRules,
+      ...importRules,
+      ...reactRules,
+      ...reactHooksRules,
+      ...jsxA11yRules,
+    },
+    settings: {
+      "import/resolver": {
+        "babel-module": {},
+        node: {
+          extensions: [".js", ".jsx", ".ts", ".tsx", ".json"],
+          moduleDirectory: ["node_modules", "src/"],
+        },
+        typescript: {
+          project: "./tsconfig.json",
+        },
+      },
+      react: {
+        version: "detect",
+      },
+    },
+  },
+
+  {
+    files: ["**/*.js", "**/*.jsx"],
+    languageOptions: {
+      parser: babelParser,
+      parserOptions: {
+        babelOptions: {
+          babelrc: false,
+          configFile: false,
+          plugins: [
+            "import-glob",
+            [
+              "module-resolver",
+              {
+                root: ["./src"],
+              },
+            ],
+          ],
+          presets: ["@babel/preset-react"],
+        },
+        ecmaFeatures: {
+          jsx: true,
+        },
+        requireConfigFile: false,
+      },
+    },
+    name: "widergy/react-web-js",
+    rules: {
+      ...jsOnlyRules,
+    },
+  },
+
+  {
+    files: ["**/*.{ts,tsx}"],
+    languageOptions: {
+      parser: tseslint.parser,
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+    name: "widergy/react-web-ts",
+    rules: {
+      ...tsOnlyRules,
+    },
+  },
+]);

package/src/rules/baseRules.js

@@ -0,0 +1,44 @@
+export const baseRules = {
+  camelcase: "off",
+  "class-methods-use-this": "off",
+  "consistent-return": "off",
+  "func-names": ["error", "always"],
+  "lines-between-class-members": "off",
+  "max-classes-per-file": "off",
+  "no-alert": "error",
+  "no-console": "error",
+  "no-else-return": "off",
+  "no-nested-ternary": "off",
+  "no-param-reassign": "off",
+  "no-plusplus": "off",
+  "no-restricted-exports": "off",
+  "no-restricted-globals": "off",
+  "no-underscore-dangle": "off",
+  "one-var": "off",
+};
+
+export const jsOnlyRules = {
+  "no-unused-vars": [
+    "error",
+    {
+      args: "all",
+      argsIgnorePattern: "^_",
+      caughtErrorsIgnorePattern: "^_",
+      destructuredArrayIgnorePattern: "^_",
+      varsIgnorePattern: "^_",
+    },
+  ],
+};
+
+export const tsOnlyRules = {
+  "@typescript-eslint/no-unused-vars": [
+    "error",
+    {
+      args: "all",
+      argsIgnorePattern: "^_",
+      caughtErrorsIgnorePattern: "^_",
+      destructuredArrayIgnorePattern: "^_",
+      varsIgnorePattern: "^_",
+    },
+  ],
+};

package/src/rules/importRules.js

@@ -0,0 +1,20 @@
+export const importRules = {
+  "import/extensions": "off",
+  "import/no-absolute-path": "error",
+  "import/no-cycle": "off",
+  "import/no-extraneous-dependencies": "off",
+  "import/order": [
+    "error",
+    {
+      groups: [
+        "external",
+        ["builtin", "internal"],
+        "parent",
+        "sibling",
+        "index",
+      ],
+      "newlines-between": "always",
+    },
+  ],
+  "import/prefer-default-export": "off",
+};

package/src/rules/jsxA11yRules.js

@@ -0,0 +1,13 @@
+export const jsxA11yRules = {
+  "jsx-a11y/anchor-is-valid": [
+    "error",
+    {
+      components: ["Link"],
+      specialLink: ["to"],
+    },
+  ],
+  "jsx-a11y/interactive-supports-focus": "off",
+  "jsx-a11y/media-has-caption": "off",
+  "jsx-a11y/no-noninteractive-element-interactions": "off",
+  "jsx-a11y/no-noninteractive-element-to-interactive-role": "off",
+};

package/src/rules/prettierRules.js

@@ -0,0 +1,16 @@
+export const prettierRules = {
+  "prettier/prettier": [
+    "error",
+    {
+      arrowParens: "avoid",
+      bracketSameLine: false,
+      bracketSpacing: true,
+      printWidth: 110,
+      singleQuote: true,
+      trailingComma: "none",
+    },
+    {
+      usePrettierrc: false,
+    },
+  ],
+};

package/src/rules/reactHooksRules.js

@@ -0,0 +1,4 @@
+export const reactHooksRules = {
+  "react-hooks/exhaustive-deps": "off", // TODO: validar
+  "react-hooks/rules-of-hooks": "error",
+};

package/src/rules/reactNativeRules.js

@@ -0,0 +1,5 @@
+export const reactNativeRules = {
+  // "react-native/no-color-literals": "off",         // TODO: validar
+  "react-native/no-raw-text": "off",
+  "react-native/split-platform-components": "off",
+};

package/src/rules/reactRules.js

@@ -0,0 +1,32 @@
+export const reactRules = {
+  "react/button-has-type": "off",
+  "react/destructuring-assignment": "off",
+  "react/forbid-foreign-prop-types": "off",
+  "react/function-component-definition": [
+    "error",
+    {
+      namedComponents: "arrow-function",
+      unnamedComponents: "arrow-function",
+    },
+  ],
+  "react/jsx-filename-extension": [
+    "error",
+    { extensions: [".js", ".jsx", ".ts", ".tsx"] },
+  ],
+  "react/jsx-indent": "off",
+  "react/jsx-one-expression-per-line": "off",
+  "react/jsx-props-no-spreading": "off",
+  "react/jsx-wrap-multilines": "off",
+  // "react/jsx-fragments": ["error", "syntax"],        // TODO: validar
+  // "react/no-access-state-in-setstate": "off",        // TODO: no salta
+  "react/no-typos": "off",
+  // "react/no-unstable-nested-components": "off",      // TODO: validar
+  // "react/prefer-stateless-function": "off",          // TODO: no salta
+  "react/prop-types": [
+    "error",
+    {
+      ignore: ["style", "children", "dispatch", "navigation", "route", "theme"],
+    },
+  ],
+  "react/require-default-props": "off",
+};

package/src/utils.js

@@ -0,0 +1,10 @@
+import { FlatCompat } from "@eslint/eslintrc";
+import { fileURLToPath } from "url";
+import path from "path";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+export const compat = new FlatCompat({
+  baseDirectory: __dirname,
+});