@ethberry/eslint-config 5.0.1

package/.github/workflows/manual.yml

@@ -0,0 +1,72 @@
+
+name: Manual release Publish
+on:
+  workflow_dispatch:
+
+jobs:
+  user-publish:
+    if: github.event_name == 'workflow_dispatch'
+    runs-on: ubuntu-latest
+    steps:
+      # BEGIN INSTALL
+      - uses: actions/checkout@v4
+
+      - name: Install Packages npm i
+        run: npm i
+
+      - name: Build Packages
+        run: npm run build
+
+      - name: Authenticate Registry & Configure Git User
+        run: |
+          echo "@ethberry:registry=https://npm.pkg.github.com/" >> .npmrc
+          echo "//npm.pkg.github.com/:_authToken=$GITHUBTOKEN" >> .npmrc
+          git update-index --assume-unchanged .npmrc
+          npx npm-cli-login -u $GITHUBUSER -p $GITHUBTOKEN -e $GITHUBEMAIL -r https://npm.pkg.github.com -s @ethberry --config-path="./"
+          git config --global user.name '@ethberry'
+          git config --global user.email $GITHUBEMAIL
+        env:
+          GITHUBTOKEN: ${{ secrets.GITHUBTOKEN }}
+          GITHUBUSER: ${{ secrets.GITHUBUSER }}
+          GITHUBEMAIL: ${{ secrets.GITHUBEMAIL }}
+
+      - name: Authenticate check via npm GIT
+        run: npm whoami --registry=https://npm.pkg.github.com/
+
+      - name: Version by NPM
+        run: npm version patch -m "[Manual release] [skip ci] %s"
+
+      - uses: JS-DevTools/npm-publish@v3
+        with:
+          token: ${{ secrets.GITHUBTOKEN }}
+          registry: "https://npm.pkg.github.com"
+          ignore-scripts: true
+
+      - name: Authenticate Registry & Configure Git User
+        run: |
+          echo "@ethberry:registry=https://registry.npmjs.org/" >> .npmrc
+          echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" >> .npmrc
+          echo "//registry.npmjs.org/:username=${NPM_USER}" >> .npmrc
+          echo "//registry.npmjs.org/:email=${NPM_EMAIL}" >> .npmrc         
+          git update-index --assume-unchanged .npmrc
+          git config --global user.name '@ethberry'
+          git config --global user.email $GITHUBEMAIL
+        env:
+          NPM_EMAIL: ${{ secrets.NPM_EMAIL }}
+          NPM_USER: ${{ secrets.NPM_USER }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Authenticate check via npm NPM
+        run: npm whoami --registry=https://registry.npmjs.org/
+
+      - uses: JS-DevTools/npm-publish@v3
+        with:
+          registry: "https://registry.npmjs.org"
+          token: ${{ secrets.NPM_TOKEN }}
+          ignore-scripts: true
+
+      - name: Git push
+        run: git push --no-verify && git push --tags --no-verify
+        env:
+          GITHUBTOKEN: ${{ secrets.GITHUBTOKEN }}
+

package/.idea/eslint-config.iml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="WEB_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <excludeFolder url="file://$MODULE_DIR$/temp" />
+      <excludeFolder url="file://$MODULE_DIR$/.tmp" />
+      <excludeFolder url="file://$MODULE_DIR$/tmp" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

package/.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,6 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Project Default" />
+    <inspection_tool class="Eslint" enabled="true" level="WARNING" enabled_by_default="true" />
+  </profile>
+</component>

package/.idea/jsLibraryMappings.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="JavaScriptLibraryMappings">
+    <includedPredefinedLibrary name="Node.js Core" />
+  </component>
+</project>

package/.idea/markdown.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="MarkdownSettings">
+    <enabledExtensions>
+      <entry key="MermaidLanguageExtension" value="false" />
+      <entry key="PlantUMLLanguageExtension" value="false" />
+    </enabledExtensions>
+  </component>
+</project>

package/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/eslint-config.iml" filepath="$PROJECT_DIR$/.idea/eslint-config.iml" />
+    </modules>
+  </component>
+</project>

package/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

package/LICENSE.md

@@ -0,0 +1,16 @@
+MIT License
+
+Copyright (c) 2021 EthBerry Studio
+
+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,15 @@
+# ESLint config
+
+This is sharable ESLint config which we use across of all our repositories. It is amazing.
+
+### Usage
+
+eslint.config.mjs
+
+```js
+import typescriptRules from "./presets/tsx.mjs";
+
+export default [
+  ...typescriptRules,
+];
+```

package/index.mjs

@@ -0,0 +1 @@
+export * from "./presets/tsx.mjs";

package/package.json

@@ -0,0 +1,51 @@
+{
+  "author": {
+    "email": "trejgun@gmail.com",
+    "name": "TrejGun",
+    "url": "https://trejgun.github.io/"
+  },
+  "bugs": {
+    "url": "https://github.com/ethberry/eslint-config/issues"
+  },
+  "dependencies": {
+    "@eslint/js": "9.11.0",
+    "@stylistic/eslint-plugin-js": "2.8.0",
+    "@stylistic/eslint-plugin-jsx": "2.8.0",
+    "@stylistic/eslint-plugin-ts": "2.8.0",
+    "eslint": "9.11.0",
+    "eslint-config-prettier": "9.1.0",
+    "eslint-plugin-import": "2.30.0",
+    "eslint-plugin-jest": "28.8.3",
+    "eslint-plugin-mocha": "10.5.0",
+    "eslint-plugin-n": "17.10.3",
+    "eslint-plugin-prettier": "5.2.1",
+    "eslint-plugin-promise": "7.1.0",
+    "eslint-plugin-react": "7.36.1",
+    "eslint-plugin-testing-library": "6.3.0",
+    "globals": "15.9.0",
+    "prettier": "3.3.3",
+    "typescript": "5.6.2",
+    "typescript-eslint": "8.6.0"
+  },
+  "engines": {
+    "node": ">=22"
+  },
+  "keywords": [],
+  "license": "MIT",
+  "main": "./index.mjs",
+  "name": "@ethberry/eslint-config",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ethberry/eslint-config.git"
+  },
+  "scripts": {
+    "build": "exit 0",
+    "lint": "eslint . --fix"
+  },
+  "sideEffects": false,
+  "title": "EthBerry ESLint config",
+  "version": "5.0.1"
+}

package/presets/js.mjs

@@ -0,0 +1,11 @@
+import commonRules from "../rules/common.mjs";
+import promiseRules from "../rules/promise.mjs";
+import nodeRules from "../rules/node.mjs";
+import prettierRules from "../rules/prettier.mjs";
+
+export default [
+  ...commonRules,
+  ...promiseRules,
+  ...nodeRules,
+  ...prettierRules,
+]

package/presets/jsx.mjs

@@ -0,0 +1,13 @@
+import commonRules from "../rules/common.mjs";
+import promiseRules from "../rules/promise.mjs";
+import nodeRules from "../rules/node.mjs";
+import reactRules from "../rules/react.mjs";
+import prettierRules from "../rules/prettier.mjs";
+
+export default [
+  ...commonRules,
+  ...promiseRules,
+  ...nodeRules,
+  ...reactRules,
+  ...prettierRules,
+]

package/presets/ts.mjs

@@ -0,0 +1,13 @@
+import typescriptRules from "../rules/typescript.mjs";
+import commonRules from "../rules/common.mjs";
+import promiseRules from "../rules/promise.mjs";
+import nodeRules from "../rules/node.mjs";
+import prettierRules from "../rules/prettier.mjs";
+
+export default [
+  ...commonRules,
+  ...typescriptRules,
+  ...promiseRules,
+  ...nodeRules,
+  ...prettierRules,
+]

package/presets/tsx.mjs

@@ -0,0 +1,16 @@
+import typescriptRules from "../rules/typescript.mjs";
+import commonRules from "../rules/common.mjs";
+import promiseRules from "../rules/promise.mjs";
+import nodeRules from "../rules/node.mjs";
+import reactRules from "../rules/react.mjs";
+import prettierRules from "../rules/prettier.mjs";
+
+export default [
+  ...commonRules,
+  ...typescriptRules,
+  ...promiseRules,
+  ...nodeRules,
+  ...reactRules,
+  ...prettierRules,
+];
+

package/rules/common.mjs

@@ -0,0 +1,70 @@
+import js from "@eslint/js";
+import stylisticJs from "@stylistic/eslint-plugin-js";
+
+export default [
+  // base
+  js.configs.recommended,
+
+  // overrides
+  {
+    rules: {
+      "no-console": [
+        "error",
+        {
+          allow: ["error", "warn", "info"],
+        },
+      ],
+      "no-unused-vars": [
+        "error",
+        {
+          varsIgnorePattern: "^_",
+          argsIgnorePattern: "^_",
+          args: "after-used",
+          vars: "all",
+        },
+      ],
+      "no-void": "off",
+    }
+  },
+
+  // stylistic
+  {
+    plugins: {
+      "@stylistic/js": stylisticJs,
+    },
+    rules: {
+      "max-len": [
+        "error",
+        {
+          code: 120,
+          ignoreRegExpLiterals: true,
+          ignoreTemplateLiterals: true,
+          ignorePattern: "^\\s+d=\"", // ignore path in svg icons
+        },
+      ],
+      "arrow-parens": ["error", "as-needed"],
+      "comma-dangle": ["error", "always-multiline"],
+      indent: [
+        "error",
+        2,
+        {
+          MemberExpression: 1,
+          SwitchCase: 1,
+        },
+      ],
+      "linebreak-style": ["error", "unix"],
+      "multiline-ternary": ["error", "always-multiline"],
+      "no-multiple-empty-lines": [
+        "error",
+        {
+          max: 2,
+          maxEOF: 1,
+        },
+      ],
+      "object-curly-spacing": ["error", "never"],
+      "operator-linebreak": ["error", "before"],
+      quotes: ["error", "double"],
+      semi: ["error", "always"],
+    },
+  },
+]

package/rules/import.mjs

@@ -0,0 +1,5 @@
+// eslint plugin import is not supporting eslint9 yet
+
+export default [
+
+]

package/rules/node.mjs

@@ -0,0 +1,23 @@
+import nodePlugin from "eslint-plugin-n";
+
+export default [
+  // base
+  {
+    files: ["**/*.{js,mjs,ts,mts}"],
+    ...nodePlugin.configs["flat/recommended-module"],
+  },
+
+  // overrides
+  {
+    files: ["**/*.{js,mjs,ts,mts}"],
+    rules: {
+      "n/exports-style": ["error", "exports"],
+    },
+  },
+  {
+    rules: {
+      // https://github.com/eslint-community/eslint-plugin-n/issues/314
+      "n/no-missing-import": "off",
+    },
+  },
+];

package/rules/prettier.mjs

@@ -0,0 +1,5 @@
+import eslintConfigPrettier from "eslint-config-prettier";
+
+export default [
+  eslintConfigPrettier
+]

package/rules/promise.mjs

@@ -0,0 +1,10 @@
+import pluginPromise from "eslint-plugin-promise";
+
+export default [
+  pluginPromise.configs["flat/recommended"],
+  {
+    rules: {
+      "promise/always-return": "off",
+    },
+  },
+];

package/rules/react.mjs

@@ -0,0 +1,47 @@
+import reactPlugin from "eslint-plugin-react";
+import globals from "globals";
+import stylisticJsx from "@stylistic/eslint-plugin-jsx";
+
+export default [
+  // config
+  {
+    files: ["**/*.{jsx,mjsx,tsx,mtsx}"],
+    languageOptions: {
+      globals: {
+        ...globals.browser,
+        ...globals.serviceworker,
+      },
+    },
+    settings: {
+      react: {
+        version: "detect",
+      },
+    },
+  },
+
+  // base
+  {
+    files: ["**/*.{jsx,mjsx,tsx,mtsx}"],
+    ...reactPlugin.configs.flat.recommended,
+  },
+
+  // overrides
+  {
+    files: ["**/*.{jsx,mjsx,tsx,mtsx}"],
+    rules: {
+      "react/react-in-jsx-scope": "off",
+      "react/display-name": "off",
+      "react/prop-types": "off",
+    },
+  },
+
+  // stylistic
+  {
+    plugins: {
+      "@stylistic/jsx": stylisticJsx,
+    },
+    rules: {
+      "@stylistic/jsx/jsx-indent": ["error", 2],
+    },
+  },
+]

package/rules/typescript.mjs

@@ -0,0 +1,60 @@
+import tsEslint from "typescript-eslint";
+import stylisticTs from "@stylistic/eslint-plugin-ts";
+
+export default [
+  // base
+  ...tsEslint.configs.recommendedTypeChecked,
+  ...tsEslint.configs.stylisticTypeChecked,
+
+  {
+    files: ["**/*.{js,mjs,cjs,jsx}"],
+    ...tsEslint.configs.disableTypeChecked,
+  },
+
+  // overrides
+  {
+    files: ["**/*.{ts,tsx,mtsx}"],
+    rules: {
+      "@typescript-eslint/no-unsafe-return": "warn",
+      "@typescript-eslint/no-unsafe-call": "warn",
+      "@typescript-eslint/no-misused-promises": "warn",
+      "@typescript-eslint/ban-ts-comment": "off",
+      "@typescript-eslint/array-type": "off",
+      "@typescript-eslint/prefer-nullish-coalescing": "off",
+      "@typescript-eslint/unbound-method": "off",
+      "@typescript-eslint/no-empty-object-type": "off",
+      "@typescript-eslint/no-explicit-any": "off",
+      "@typescript-eslint/no-unsafe-argument": "off",
+      "@typescript-eslint/no-unsafe-assignment": "off",
+      "@typescript-eslint/no-unsafe-member-access": "off",
+      "@typescript-eslint/no-unused-vars": [
+        "error",
+        {
+          varsIgnorePattern: "^_|NodeJS|ProcessEnv",
+          argsIgnorePattern: "^_",
+          args: "after-used",
+          vars: "all",
+        },
+      ],
+      "@typescript-eslint/naming-convention": [
+        "error",
+        {
+          selector: "interface",
+          format: ["PascalCase"],
+          prefix: ["I"],
+          filter: {
+            match: false,
+            regex: "^(ProcessEnv|Window)$",
+          },
+        },
+      ],
+    },
+  },
+
+  // stylistic
+  {
+    plugins: {
+      "@stylistic/ts": stylisticTs,
+    },
+  },
+]

package/tests/jest.mjs

@@ -0,0 +1,19 @@
+import globals from "globals";
+import jestPlugin from "eslint-plugin-jest";
+
+export default [
+  {
+    files: ["**/*.spec.ts", "**/*.spec.js"],
+    ...jestPlugin.configs["flat/recommended"],
+    rules: {
+      ...jestPlugin.configs["flat/recommended"].rules,
+      "jest/no-focused-tests": "error",
+      "jest/valid-expect": "error",
+    },
+    languageOptions: {
+      globals: {
+        ...globals.jest,
+      },
+    },
+  },
+];

package/tests/mocha.mjs

@@ -0,0 +1,22 @@
+import globals from "globals";
+import mochaPlugin from "eslint-plugin-mocha";
+
+export default [
+  {
+    files: ["**/*.spec.ts", "**/*.spec.js"],
+    ...mochaPlugin.configs.flat.recommended,
+    rules: {
+      ...mochaPlugin.configs.flat.recommended.rules,
+      "mocha/no-exports": "off",
+      "mocha/no-hooks-for-single-case": "off",
+      "mocha/no-skipped-tests": "off",
+      "mocha/no-setup-in-describe": "off",
+      "mocha/no-exclusive-tests": "error",
+    },
+    languageOptions: {
+      globals: {
+        ...globals.mocha,
+      },
+    },
+  },
+];

package/tests/testing-library.mjs

@@ -0,0 +1,17 @@
+import testingLibraryPlugin from "eslint-plugin-testing-library";
+
+export default [
+  {
+    files: ["**/*.spec.tsx", "**/*.spec.jsx"],
+    ...testingLibraryPlugin.configs["flat/dom"],
+    ...testingLibraryPlugin.configs['flat/react'],
+    rules: {
+      ...testingLibraryPlugin.configs["flat/dom"].rules,
+      ...testingLibraryPlugin.configs['flat/react'].rules,
+      "testing-library/await-async-queries": "error",
+      "testing-library/no-await-sync-queries": "error",
+      "testing-library/no-debugging-utils": "warn",
+      "testing-library/no-dom-import": "off",
+    },
+  },
+];