Refactor/configs directory (#21)

* refactor: create configs directory & add reco & tests

* fix: link to eslint-plugin README

* docs: update plugin README

* refactor: use requireIndex to import configs

* docs: update README

* docs: add config description and npm command to list peer deps

Author: P0labrD

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 plugin](./packages/eslint/README.md)
+- [Using ESLint plugin](./packages/eslint-plugin/README.md)
 
 ## Installing the project
 

packages/eslint-plugin/README.md

@@ -2,40 +2,46 @@
 
 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 the recommended config?
+## Shared config
 
-In your app, run
+The plugin exports multiple configs that can be used in your `.eslintrc` config file:
 
-```bash
-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
-```
+| Name                                  | Description                               |
+| ------------------------------------- | ----------------------------------------- |
+| `@bam.tech/eslint-plugin/recommended` | The recommended config for all projects   |
+| `@bam.tech/eslint-plugin/tests`       | The recommended config for all test files |
 
-In your `.eslintrc` config file, extend the exported recommended configuration:
+You should install the correct version for each package. You can see the list using:
 
-```json
-// .eslintrc
-{
-  "extends": "plugin:@bam.tech/eslint-plugin/recommended"
-}
+```bash
+npm info "@bam.tech/esling-plugin" peerDependencies
 ```
 
-## How to use the config for tests ?
+With **npm 5+** you can automatically install all the peer dependencies by running:
 
 ```bash
-yarn add --dev eslint-plugin-jest eslint-plugin-jest-formatting eslint-plugin-testing-library
+npx install-peerdeps @bam.tech/eslint-config -D
 ```
 
-In your `.eslintrc` config file, extend the exported recommended configuration (don't forget to add the overrides to check only the test files)
+## How to use?
+
+In your `.eslintrc` config file, extend the exported configurations:
 
 ```json
+// .eslintrc
+{
+  "extends": "plugin:@bam.tech/eslint-plugin/recommended",
   "overrides": [
     {
       "files": ["*.test.tsx"],
       "extends": "plugin:@bam.tech/tests"
     }
   ]
+}
 ```
 
+Don't forget to add the overrides to check only the test files.
+
 ## Rules implemented in this plugin
 
 <!-- begin auto-generated rules list -->

packages/eslint-plugin/lib/recommended.js …eslint-plugin/lib/configs/recommended.jspackages/eslint-plugin/lib/recommended.js renamed to packages/eslint-plugin/lib/configs/recommended.js packages/eslint-plugin/lib/recommended.js renamed to packages/eslint-plugin/lib/configs/recommended.js

@@ -1,13 +1,8 @@
 "use strict";
 
 const requireIndex = require("requireindex");
-const recommended = require("./recommended");
-const tests = require("./tests");
 
 module.exports = {
-  configs: {
-    recommended,
-    tests,
-  },
+  configs: requireIndex(__dirname + "/configs"),
   rules: requireIndex(__dirname + "/rules"),
 };