@msobiecki/eslint-config 8.9.7

package/.eslintrc.json

@@ -0,0 +1,6 @@
+{
+  "extends": [
+    "./index.js",
+    "./best-practice.js"
+  ]
+}

package/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "npm" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

package/.github/workflows/dependabot-auto-merge.yml

@@ -0,0 +1,26 @@
+name: Dependabot auto-merge
+on:
+  pull_request:
+    branches:
+      - master
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  dependabot:
+    runs-on: ubuntu-latest
+    if: github.actor == 'dependabot[bot]'
+    steps:
+      - name: Dependabot metadata
+        id: metadata
+        uses: dependabot/fetch-metadata@v2
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+      - name: Enable auto-merge for Dependabot PRs
+        if: steps.metadata.outputs.update-type == 'version-update:semver-minor' || steps.metadata.outputs.update-type == 'version-update:semver-patch'
+        run: gh pr merge --auto --squash "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GH_TOKEN: ${{secrets.GITHUB_TOKEN}}

package/.github/workflows/release-publish.yml

@@ -0,0 +1,63 @@
+name: Release publish
+
+on:
+  push:
+    branches: [ master ]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    permissions:
+      packages: write
+      contents: write
+
+    strategy:
+      matrix:
+        node-version: [18.x]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          node-version: ${{ matrix.node-version }}
+          registry-url: https://npm.pkg.github.com
+          scope: "@msobiecki"
+
+      - name: Run version bump
+        id: changelog
+        uses: TriPSs/conventional-changelog-action@v5.2.1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          skip-on-empty: false
+
+      - name: Run release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ steps.changelog.outputs.tag }}
+          release_name: ${{ steps.changelog.outputs.tag }}
+          body: ${{ steps.changelog.outputs.clean_changelog }}
+
+      - name: Install dependencies
+        run: npm ci
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Run publish
+        uses: JS-DevTools/npm-publish@v3
+        with:
+          registry: https://npm.pkg.github.com/
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Run publish to NPMjs
+        uses: JS-DevTools/npm-publish@v3
+        with:
+          registry: https://registry.npmjs.org/
+          token: ${{ secrets.NPM_TOKEN }}
+          access: public

package/.husky/commit-msg

@@ -0,0 +1 @@
+npx commitlint --edit "$1"

package/.husky/pre-commit

@@ -0,0 +1 @@
+npx lint-staged

package/.lintstagedrc

@@ -0,0 +1,8 @@
+{
+  "*.{yml,json,md}": [
+    "prettier --write"
+  ],
+  "*.js": [
+    "eslint --fix"
+  ]
+}

package/CHANGELOG.md

@@ -0,0 +1,20 @@
+## [8.9.7](https://github.com/msobiecki/eslint-config/compare/v8.9.6...v8.9.7) (2024-11-24)
+
+
+
+## [8.9.6](https://github.com/msobiecki/eslint-config/compare/v8.9.5...v8.9.6) (2024-11-24)
+
+
+
+## [8.9.5](https://github.com/msobiecki/eslint-config/compare/v8.9.4...v8.9.5) (2024-11-22)
+
+
+
+## [8.9.4](https://github.com/msobiecki/eslint-config/compare/v8.9.3...v8.9.4) (2024-11-11)
+
+
+
+## [8.9.3](https://github.com/msobiecki/eslint-config/compare/v8.9.2...v8.9.3) (2024-11-11)
+
+
+

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Michał Sobiecki
+
+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,118 @@
+# eslint-config
+
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/msobiecki/eslint-config/blob/master/LICENSE)
+
+Custom ESLint configuration for projects. It extends popular Airbnb ESLint config and other popular configs in one place.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [License](#license)
+
+## Installation
+
+```bash
+npm install --save-dev @msobiecki/eslint-config
+```
+
+Make sure to install the necessary peer dependencies as well:
+
+```bash
+npm install --save-dev eslint prettier
+```
+
+## Usage
+
+To use this ESLint configuration, you need to extend it in your project's `.eslintrc` file:
+
+### base javascript/typescript configuration
+
+```json
+{
+  "extends": "@msobiecki/eslint-config"
+}
+```
+
+### react javascript/typescript configuration
+
+```json
+{
+  "extends": [
+    "@msobiecki/eslint-config/react",
+    "@msobiecki/eslint-config/react-jsx"
+  ]
+}
+```
+
+### next configuration
+
+```json
+{
+  "extends": ["@msobiecki/eslint-config/next"]
+}
+```
+
+### node configuration
+
+```json
+{
+  "extends": ["@msobiecki/eslint-config/node"]
+}
+```
+
+### jest configuration
+
+#### base
+
+```json
+{
+  "extends": ["@msobiecki/eslint-config/jest"]
+}
+```
+
+#### dom
+
+```json
+{
+  "extends": [
+    "@msobiecki/eslint-config/jest",
+    "@msobiecki/eslint-config/jest-dom"
+  ]
+}
+```
+
+#### react
+
+```json
+{
+  "extends": [
+    "@msobiecki/eslint-config/jest",
+    "@msobiecki/eslint-config/jest-react"
+  ]
+}
+```
+
+### best practice configuration
+
+```json
+{
+  "extends": ["@msobiecki/eslint-config/best-practice"]
+}
+```
+
+If you have an existing ESLint configuration, you can merge it with this configuration using the `extends` property:
+
+```json
+{
+  "extends": ["@msobiecki/eslint-config", "your-existing-config"]
+}
+```
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
+
+---
+
+Feel free to contribute to this repository by opening issues or submitting pull requests. Happy coding!

package/best-practice.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ["./presets/best-practice/best-practice.js"],
+};

package/commitlint.config.js

@@ -0,0 +1 @@
+module.exports = { extends: ["@commitlint/config-conventional"] };

package/index.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ["./presets/base/base.js"],
+};

package/jest-dom.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ["./presets/jest/jest-dom.js"],
+};

package/jest-react.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ["./presets/jest/jest-react.js"],
+};

package/jest.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ["./presets/jest/jest-base.js"],
+};

package/next.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ["./presets/next/next.js"],
+};

package/node.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ["./presets/node/node.js"],
+};

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@msobiecki/eslint-config",
+  "version": "8.9.7",
+  "private": false,
+  "description": "An ESLint shareable config for JavaScript/TypeScript ecosystem's.",
+  "keywords": [
+    "eslint",
+    "eslint-config"
+  ],
+  "homepage": "https://github.com/msobiecki/eslint-config/",
+  "bugs": {
+    "url": "https://github.com/msobiecki/eslint-config/issues"
+  },
+  "repository": {
+    "url": "git://git@github.com:msobiecki/eslint-config.git"
+  },
+  "license": "MIT",
+  "author": "Michał Sobiecki <kontakt@codeshaker.pl>",
+  "main": "index.js",
+  "scripts": {
+    "prepare": "husky install"
+  },
+  "dependencies": {
+    "eslint-config-airbnb": "^19.0.4",
+    "eslint-config-airbnb-typescript": "^18.0.0",
+    "eslint-config-next": "^15.0.3",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-compat": "^6.0.1",
+    "eslint-plugin-deprecation": "^3.0.0",
+    "eslint-plugin-eslint-comments": "^3.2.0",
+    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-jest": "^28.9.0",
+    "eslint-plugin-jest-dom": "^5.5.0",
+    "eslint-plugin-jsdoc": "^50.5.0",
+    "eslint-plugin-jsx-a11y": "^6.10.2",
+    "eslint-plugin-n": "^17.13.2",
+    "eslint-plugin-prettier": "^5.2.1",
+    "eslint-plugin-promise": "^7.1.0",
+    "eslint-plugin-react": "^7.37.2",
+    "eslint-plugin-react-hooks": "^4.6.2",
+    "eslint-plugin-security": "^3.0.1",
+    "eslint-plugin-storybook": "^0.11.0",
+    "eslint-plugin-testing-library": "^6.4.0",
+    "eslint-plugin-unicorn": "^56.0.0"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^19.5.0",
+    "@commitlint/config-conventional": "^19.5.0",
+    "eslint": "^8.57.1",
+    "husky": "^9.1.6",
+    "lint-staged": "^15.2.10",
+    "prettier": "^3.3.3"
+  },
+  "peerDependencies": {
+    "eslint": "^8.0.0",
+    "prettier": "^3.0.0"
+  },
+  "overrides": {
+    "eslint-config-next": {
+      "@typescript-eslint/eslint-plugin": "^7.0.0",
+      "@typescript-eslint/parser": "^7.0.0"
+    }
+  }
+}

package/presets/base/base.js

@@ -0,0 +1,18 @@
+const getTsConfig = require("../../utils/get-ts-config");
+
+module.exports = {
+  extends: ["airbnb-base"],
+  overrides: [
+    {
+      files: ["**/*.ts"],
+      extends: [
+        "airbnb-typescript/base",
+        "plugin:@typescript-eslint/recommended",
+        "plugin:@typescript-eslint/recommended-requiring-type-checking",
+      ],
+      parserOptions: {
+        project: getTsConfig(),
+      },
+    },
+  ],
+};

package/presets/best-practice/best-practice.js

@@ -0,0 +1,23 @@
+module.exports = {
+  extends: [
+    "plugin:promise/recommended",
+    "plugin:unicorn/recommended",
+    "plugin:security/recommended-legacy",
+    "plugin:jsdoc/recommended",
+    "plugin:eslint-comments/recommended",
+    "plugin:compat/recommended",
+    "plugin:prettier/recommended",
+  ],
+  rules: {
+    "unicorn/prefer-module": ["off"],
+  },
+  overrides: [
+    {
+      files: ["**/*.ts?(x)"],
+      extends: [
+        "plugin:jsdoc/recommended-typescript",
+        "plugin:deprecation/recommended",
+      ],
+    },
+  ],
+};

package/presets/jest/jest-base.js

@@ -0,0 +1,8 @@
+module.exports = {
+  overrides: [
+    {
+      files: ["**/__tests__/**/*.[jt]s?(x)", "**/?(*.)+(spec|test).[jt]s?(x)"],
+      extends: ["plugin:jest/recommended", "plugin:jest/style"],
+    },
+  ],
+};

package/presets/jest/jest-dom.js

@@ -0,0 +1,9 @@
+module.exports = {
+  extends: ["plugin:jest-dom/recommended"],
+  overrides: [
+    {
+      files: ["**/__tests__/**/*.[jt]s?(x)", "**/?(*.)+(spec|test).[jt]s?(x)"],
+      extends: ["plugin:testing-library/dom"],
+    },
+  ],
+};

package/presets/jest/jest-react.js

@@ -0,0 +1,8 @@
+module.exports = {
+  overrides: [
+    {
+      files: ["**/__tests__/**/*.[jt]s?(x)", "**/?(*.)+(spec|test).[jt]s?(x)"],
+      extends: ["plugin:testing-library/react"],
+    },
+  ],
+};

package/presets/next/next.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ["next"],
+};

package/presets/node/node.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ["plugin:n/recommended"],
+};

package/presets/react/react-jsx.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ["plugin:react/jsx-runtime"],
+};

package/presets/react/react.js

@@ -0,0 +1,27 @@
+const getTsConfig = require("../../utils/get-ts-config");
+
+module.exports = {
+  extends: ["airbnb", "airbnb/hooks"],
+  rules: {
+    "react/function-component-definition": [
+      "error",
+      {
+        namedComponents: ["arrow-function"],
+        unnamedComponents: ["arrow-function"],
+      },
+    ],
+  },
+  overrides: [
+    {
+      files: ["**/*.ts?(x)"],
+      extends: [
+        "airbnb-typescript",
+        "plugin:@typescript-eslint/recommended",
+        "plugin:@typescript-eslint/recommended-requiring-type-checking",
+      ],
+      parserOptions: {
+        project: getTsConfig(),
+      },
+    },
+  ],
+};

package/react-jsx.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ["./presets/react/react-jsx.js"],
+};

package/react.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ["./presets/react/react.js"],
+};

package/utils/get-ts-config.js

@@ -0,0 +1,11 @@
+const fs = require("node:fs");
+const path = require("node:path");
+
+const geTsConfig = () => {
+  if (fs.existsSync("tsconfig.json")) return path.resolve("tsconfig.json");
+  return fs.existsSync("../tsconfig.json")
+    ? path.resolve("../tsconfig.json")
+    : undefined;
+};
+
+module.exports = geTsConfig;