@open-turo/eslint-config 1.0.4 → 1.0.5

package/.github/renovate.json

@@ -0,0 +1,6 @@
+{
+  "extends": [
+    "github>open-turo/renovate-config#v1",
+    "github>open-turo/renovate-config:npm-lib#v1"
+  ]
+}

package/.github/workflows/ci.yaml

@@ -8,7 +8,8 @@ jobs:
     name: Lint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - name: Checkout
+        uses: actions/checkout@v3
         with:
           fetch-depth: 0
       - name: Download actionlint
@@ -17,3 +18,11 @@ jobs:
           bash <(curl https://raw.githubusercontent.com/rhysd/actionlint/main/scripts/download-actionlint.bash) latest "$HOME/bin"
           echo "${HOME}/bin" >> "$GITHUB_PATH"
       - uses: open-turo/action-pre-commit@v1
+
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: open-turo/actions-node/test@v3
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}

package/.github/workflows/release.yaml

@@ -9,15 +9,17 @@ jobs:
   release:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - name: Checkout
+        uses: actions/checkout@v3
         with:
           fetch-depth: 0
-      - name: Semantic Release
+          persist-credentials: false
+      - name: Semantic release
         id: release
-        uses: cycjimmy/semantic-release-action@v2
+        uses: cycjimmy/semantic-release-action@v3
         with:
           extra_plugins: |
-            semantic-release-github-pullrequest
+            @open-turo/semantic-release-config
         env:
           GITHUB_TOKEN: ${{ secrets.OPEN_TURO_GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/update-dependencies.yaml

@@ -0,0 +1,23 @@
+name: Update dependencies
+concurrency: update-dependencies
+
+on:
+  schedule:
+    # Every day at midnight
+    - cron: "0 0 * * *"
+  workflow_dispatch:
+  issue_comment:
+    types:
+      - edited
+  pull_request:
+    types:
+      - edited
+
+jobs:
+  update-dependencies:
+    runs-on: ubuntu-latest
+    name: Update dependencies
+    steps:
+      - uses: open-turo/action-renovate@v1
+        with:
+          github-token: ${{ secrets.OPEN_TURO_GITHUB_TOKEN }}

package/.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.1.0
+    rev: v4.4.0
     hooks:
       - id: check-json
       - id: check-yaml
@@ -12,12 +12,12 @@ repos:
       - id: prettier
         stages: [commit]
   - repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
-    rev: v8.0.0
+    rev: v9.4.0
     hooks:
       - id: commitlint
         stages: [commit-msg]
         additional_dependencies: ["@open-turo/commitlint-config-conventional"]
   - repo: https://github.com/rhysd/actionlint
-    rev: v1.6.8
+    rev: v1.6.22
     hooks:
       - id: actionlint

package/.releaserc.json

@@ -1,26 +1,3 @@
 {
-  "branches": ["main", "next"],
-  "plugins": [
-    "@semantic-release/commit-analyzer",
-    "@semantic-release/release-notes-generator",
-    [
-      "@semantic-release/npm",
-      {
-        "tarballDir": "pack"
-      }
-    ],
-    [
-      "@semantic-release/github",
-      {
-        "assets": "pack/*.tgz"
-      }
-    ],
-    [
-      "semantic-release-github-pullrequest",
-      {
-        "assets": ["package.json", "README.md", "package-lock.json"],
-        "baseRef": "main"
-      }
-    ]
-  ]
+  "extends": "@open-turo/semantic-release-config/lib/npm"
 }

package/README.md

@@ -2,6 +2,15 @@
 
 Turo eslint configuration
 
+[![Release](https://img.shields.io/github/v/release/open-turo/eslint-config)](https://github.com/open-turo/eslint-config/releases/)
+[![Tests pass/fail](https://img.shields.io/github/workflow/status/open-turo/eslint-config/CI)](https://github.com/open-turo/eslint-config/actions/)
+[![License](https://img.shields.io/github/license/open-turo/eslint-config)](./LICENSE)
+[![Contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg)](https://github.com/dwyl/esta/issues)
+![CI](https://github.com/open-turo/eslint-config/actions/workflows/release.yaml/badge.svg)
+[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)
+[![Conventional commits](https://img.shields.io/badge/conventional%20commits-1.0.2-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)
+[![Join us!](https://img.shields.io/badge/Turo-Join%20us%21-593CFB.svg)](https://turo.com/jobs)
+
 ## Usage
 
 Install the package and all of its peer dependencies:

package/index.js

@@ -10,36 +10,33 @@ module.exports = {
     "plugin:unicorn/recommended",
     "plugin:node/recommended",
   ],
+  parserOptions: {
+    ecmaVersion: 2020,
+    sourceType: "module",
+    ecmaFeatures: {
+      modules: true,
+    },
+  },
   plugins: [
-    "import",
-    "json",
     "import",
     "jest",
+    "json",
+    "node",
     "prettier",
     "simple-import-sort",
     "sonarjs",
     "sort-destructure-keys",
     "unicorn",
-    "node",
   ],
   rules: {
-    parserOptions: {
-      ecmaVersion: 2020,
-      sourceType: "module",
-      ecmaFeatures: {
-        modules: true,
-      },
-    },
-    rules: {
-      "import/default": "off",
-      "import/named": "off",
-      "import/namespace": "off",
-      "import/no-default-export": "error",
-      "import/prefer-default-export": "off",
-      "prettier/prettier": "error",
-      "simple-import-sort/imports": "error",
-      "simple-import-sort/exports": "error",
-      "sort-destructure-keys/sort-destructure-keys": "error",
-    },
+    "import/default": "off",
+    "import/named": "off",
+    "import/namespace": "off",
+    "import/no-default-export": "error",
+    "import/prefer-default-export": "off",
+    "prettier/prettier": "error",
+    "simple-import-sort/imports": "error",
+    "simple-import-sort/exports": "error",
+    "sort-destructure-keys/sort-destructure-keys": "error",
   },
 };

package/package.json

@@ -2,25 +2,27 @@
   "author": "Turo engineering",
   "description": "Eslint configuration for Turo",
   "devDependencies": {
-    "@commitlint/cli": "^17.0.3",
-    "@open-turo/commitlint-config-conventional": "^1.0.2",
-    "@semantic-release/git": "^10.0.1",
-    "eslint": "^8.10.0",
-    "eslint-config-airbnb-base": "^15.0.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-import": "^2.25.4",
-    "eslint-plugin-jest": "^27.0.1",
-    "eslint-plugin-json": "^3.1.0",
-    "eslint-plugin-prettier": "^4.0.0",
-    "eslint-plugin-simple-import-sort": "^7.0.0",
-    "eslint-plugin-sonarjs": "^0.15.0",
-    "eslint-plugin-sort-destructure-keys": "^1.4.0",
-    "prettier": "^2.5.1",
-    "semantic-release": "^19.0.2",
-    "semantic-release-github-pullrequest": "^1.3.0"
+    "@commitlint/cli": "17.4.2",
+    "@open-turo/commitlint-config-conventional": "1.0.4",
+    "@open-turo/semantic-release-config": "1.0.1",
+    "eslint": "8.32.0",
+    "eslint-config-airbnb-base": "15.0.0",
+    "eslint-config-prettier": "8.6.0",
+    "eslint-plugin-import": "2.27.5",
+    "eslint-plugin-jest": "27.2.1",
+    "eslint-plugin-json": "3.1.0",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "4.2.1",
+    "eslint-plugin-simple-import-sort": "8.0.0",
+    "eslint-plugin-sonarjs": "0.18.0",
+    "eslint-plugin-sort-destructure-keys": "1.4.0",
+    "eslint-plugin-unicorn": "^45.0.2",
+    "jest": "^29.3.1",
+    "prettier": "2.8.3",
+    "semantic-release": "19.0.5"
   },
   "engines": {
-    "node": ">= 14"
+    "node": ">= 16"
   },
   "homepage": "https://github.com/open-turo/eslint-config#readme",
   "license": "MIT",
@@ -33,14 +35,19 @@
     "eslint-plugin-import": "^2.25.4",
     "eslint-plugin-jest": "^27.0.1",
     "eslint-plugin-json": "^3.1.0",
+    "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^4.0.0",
-    "eslint-plugin-simple-import-sort": "^7.0.0",
-    "eslint-plugin-sonarjs": "^0.15.0",
-    "eslint-plugin-sort-destructure-keys": "^1.4.0"
+    "eslint-plugin-simple-import-sort": "^8.0.0",
+    "eslint-plugin-sonarjs": "^0.17.0 || ^0.18.0",
+    "eslint-plugin-sort-destructure-keys": "^1.4.0",
+    "eslint-plugin-unicorn": "^45.0.2"
   },
   "publishConfig": {
     "access": "public"
   },
   "repository": "https://github.com/open-turo/eslint-config",
-  "version": "1.0.4"
+  "scripts": {
+    "test": "jest test.js"
+  },
+  "version": "1.0.5"
 }

package/test.js

@@ -0,0 +1,21 @@
+const fs = require("fs");
+const { ESLint } = require("eslint");
+
+describe("validate config", () => {
+  it(`load config file in ESLint to validate all rules are correct`, async () => {
+    const stringConfig = fs.readFileSync("./test.js", "utf8");
+
+    const cli = new ESLint({
+      overrideConfigFile: "./index.js",
+    });
+
+    const lintResult = await cli.lintText(stringConfig);
+
+    /**
+     * We just need to validate a value is returned.
+     * If there is an issue with the config, `cli.lintText` will error,
+     * and we will never hit this line so the test will fail.
+     */
+    expect(lintResult).toBeTruthy();
+  });
+});

package/.github/dependabot.yaml

@@ -1,12 +0,0 @@
-version: 2
-updates:
-  - package-ecosystem: npm
-    directory: /
-    reviewers:
-      - "open-turo/node"
-    schedule:
-      interval: weekly
-    commit-message:
-      prefix: build(deps)
-      prefix-development: build(dev-deps)
-      include: scope