feat: config is now a plugin (#18)

* feat: config is now a plugin

* docs: update README

* refactor: export recommendedConfig in other file

* chore: rename eslint to eslint-plugin

* fix: fix CI with new eslint-plugin directory

* docs: rewind plugin README

* fix: lint in eslint-plugin package

* chore: add ts-check

Author: P0labrD

.github/labeler.yml

@@ -1,2 +1,2 @@
 "no examples 📝":
-  - all: ["packages/eslint/**/*", "!packages/example-app/**/*"]
+  - all: ["packages/eslint-plugin/**/*", "!packages/example-app/**/*"]

.github/workflows/quality-eslint.yml

@@ -1,17 +1,17 @@
-name: Eslint-Config Quality
+name: Eslint-Plugin Quality
 
 on: workflow_call
 
 jobs:
   quality-job:
-    name: Eslint-Config Quality
+    name: Eslint-Plugin Quality
     runs-on: ubuntu-latest
     timeout-minutes: 10
 
     defaults:
       run:
         # default directory for 'run' actions only in steps
-        working-directory: packages/eslint
+        working-directory: packages/eslint-plugin
 
     steps:
       - name: Checkout
@@ -21,12 +21,12 @@ jobs:
         id: setup-node
         uses: actions/setup-node@v3
         with:
-          node-version-file: packages/eslint/.nvmrc
+          node-version-file: packages/eslint-plugin/.nvmrc
 
       - name: Load dependency cache
         uses: actions/cache@v3
         with:
-          path: packages/eslint/node_modules
+          path: packages/eslint-plugin/node_modules
           # add `-patches-${{ hashFiles('patches/**/*') }}` if you use patch-package
           key: eslint-${{ runner.os }}-node-${{ steps.setup-node.outputs.node-version }}-modules-${{ hashFiles('yarn.lock') }}
           restore-keys: |

.github/workflows/quality.yml

@@ -20,11 +20,11 @@ jobs:
         with:
           filters: |
             eslint:
-              - 'packages/eslint/**'
+              - 'packages/eslint-plugin/**'
               - 'packages/example-app/**'
 
   eslint-quality:
-    name: Eslint-Config Quality
+    name: Eslint-Plugin Quality
     needs: changes
     if: ${{ needs.changes.outputs.eslint == 'true' }}
     uses: ./.github/workflows/quality-eslint.yml

README.md

@@ -12,7 +12,7 @@ There is also an example app under `packages/example-app` whose goal is to demon
 
 ## Using the configurations
 
-- [Using ESLint configuration](./packages/eslint/README.md)
+- [Using ESLint plugin](./packages/eslint/README.md)
 
 ## Installing the project
 

packages/eslint-plugin/.eslintrc.js

@@ -0,0 +1,13 @@
+"use strict";
+
+module.exports = {
+  root: true,
+  extends: [
+    "eslint:recommended",
+    "plugin:eslint-plugin/recommended",
+    "plugin:node/recommended",
+  ],
+  env: {
+    node: true,
+  },
+};

packages/eslint/.nvmrc packages/eslint-plugin/.nvmrcpackages/eslint/.nvmrc renamed to packages/eslint-plugin/.nvmrc

@@ -1,6 +1,6 @@
-# ESLint config for BAM
+# ESLint plugin for BAM
 
-This project is an ESLint config that gathers all the rules, plugins and parsers that should be used in any new BAM project.
+This project is an ESLint plugin that gathers all the rules, plugins and parsers that should be used in any new BAM project.
 
 ## How to use?
 
@@ -10,12 +10,12 @@ In your app, run
 yarn add --dev @bam.tech/eslint-config @typescript-eslint/eslint-plugin eslint eslint-plugin-prettier eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-react-native prettier
 ```
 
-In your `.eslintrc` config file, extend the exported configuration:
+In your `.eslintrc` config file, extend the exported recommended configuration:
 
 ```json
 // .eslintrc
 {
-  "extends": "@bam.tech/eslint-config"
+  "extends": "plugin:@bam.tech/eslint-plugin/recommended"
 }
 ```
 

packages/eslint/README.md packages/eslint-plugin/README.mdpackages/eslint/README.md renamed to packages/eslint-plugin/README.md

@@ -0,0 +1,10 @@
+// @ts-check
+"use strict";
+
+const recommended = require("./recommended");
+
+module.exports = {
+  configs: {
+    recommended,
+  },
+};

packages/eslint-plugin/lib/index.js

@@ -1,10 +1,17 @@
 {
-  "name": "@bam.tech/eslint-config",
+  "name": "@bam.tech/eslint-plugin",
   "version": "0.1.0",
-  "main": "index.js",
+  "description": "eslint plugin for bam projects",
+  "keywords": [
+    "eslint",
+    "eslintplugin",
+    "eslint-plugin"
+  ],
+  "main": "./lib/index.js",
   "license": "MIT",
   "scripts": {
-    "test": "echo 'No implemented tests... 😢'"
+    "test": "echo 'No implemented tests... 😢'",
+    "lint": "eslint ."
   },
   "peerDependencies": {
     "@typescript-eslint/eslint-plugin": ">= 5",
@@ -20,5 +27,9 @@
     "@typescript-eslint/parser": "^5.48.0",
     "eslint-config-prettier": "^8.8.0",
     "eslint-define-config": "^1.21.0"
+  },
+  "devDependencies": {
+    "eslint-plugin-eslint-plugin": "^5.1.0",
+    "eslint-plugin-node": "^11.1.0"
   }
 }