change prettier handling (#23)

* feat: change prettier handling

* chore: add prettier formatting to all supported file types

* feat: remove index.js with react-ts config

* chore: add info about peerDeps plugins

* chore: remove unneeded off rules in rn config

Co-authored-by: Mateusz Tkacz <mateusz.tkacz@mobilereality.pl>

Author: CatchMe2

.prettierignore

@@ -1,6 +1,3 @@
-.idea
 node_modules
 .husky
-package-lock.json
-README.md
-LICENSE.md
+.idea

.prettierrc

@@ -0,0 +1,8 @@
+module.exports = {
+    trailingComma: 'all',
+    jsxSingleQuote: false,
+    singleQuote: true,
+    bracketSameLine: false,
+    printWidth: 80,
+    tabWidth: 4,
+};

.prettierrc.js

@@ -1,4 +1,5 @@
 # @mobile-reality/eslint-config
+
 [![Version](https://img.shields.io/npm/v/@mobile-reality/eslint-config?style=for-the-badge)](https://www.npmjs.com/package/@mobile-reality/eslint-config)
 [![GitHub stars](https://img.shields.io/github/stars/MobileReality/eslint-config?style=for-the-badge)](https://github.com/MobileReality/react-native-select-pro/stargazers)
 [![npm total downloads](https://img.shields.io/npm/dt/@mobile-reality/eslint-config?style=for-the-badge)](https://www.npmjs.com/package/@mobile-reality/eslint-config)
@@ -13,86 +14,93 @@ ESLint's configuration of Mobile Reality Team
 ---
 
 ## Table of Contents
-- [Requirements](#requirements)
-- [Installation and usage for a new project](#installation-and-usage-for-a-new-project)
-- [Installation and usage for an existing project](#installation-and-usage-for-an-existing-project)
-- [Override](#override)
-- [Used packages](#used-packages)
-- [License](#license)
+
+-   [Requirements](#requirements)
+-   [Installation and usage for a new project](#installation-and-usage-for-a-new-project)
+-   [Installation and usage for an existing project](#installation-and-usage-for-an-existing-project)
+-   [Override](#override)
+-   [Used packages](#used-packages)
+-   [License](#license)
 
 ## Requirements
-* for web: `react`, for mobile: `react-native`
-* `node: ^16.13`
-* `eslint: ^8.13.0`
+
+-   `node: ^16.13`
+-   `eslint: ~8.20.0`
+-   `eslint-plugin-prettier: ^4.2.0`
 
 ## Installation and usage for a new project
-1. Install `@mobile-reality/eslint-config`, `eslint` and `prettier`:
+
+1. Install `@mobile-reality/eslint-config`, `eslint`, `prettier` and `eslint-plugin-prettier`:
+
     ```sh
-    yarn add -D @mobile-reality/eslint-config eslint@latest prettier@latest
+    yarn add -D @mobile-reality/eslint-config eslint@~8.20.0 prettier eslint-plugin-prettier
     ```
+
     or
+
     ```sh
-    npm i -D @mobile-reality/eslint-config eslint@latest prettier@latest
+    npm i -D @mobile-reality/eslint-config eslint@~8.20.0 prettier eslint-plugin-prettier
     ```
 
 2. Copy `.prettierrc` from `node_modules/@mobile-reality/eslint-config` to your root directory
-3. Add to your root `.eslintrc.js` file and:
-   * if you are using **React with TypeScript**:
-    ```typescript jsx
-    module.exports = {
-        extends: [
-            '@mobile-reality'
-        ]
-    };
-    ```
-   * if you are using **React without TypeScript**:
-    ```typescript jsx
-    module.exports = {
-        extends: [
-            '@mobile-reality/eslint-config/react-javascript'
-        ]
-    };
-    ```
-    * if you are using **React Native with TypeScript**:
-    ```typescript jsx
+3. Add to your root `.eslintrc.js` file:
+    ```javascript
     module.exports = {
+        root: true,
+        env: {}, // env config is based on project scope eg is it only node or node+browser
         extends: [
-            '@mobile-reality/eslint-config/react-native'
-        ]
+            '@mobile-reality/eslint-config/XXX', // base config based on project scope, XXX described below
+            'plugin:prettier/recommended', // to include prettier rules in eslint
+        ],
+        // if jest is used jest config should be added to overrides section
+        overrides: [
+            {
+                files: ['test/**/*.test.ts'], // glob pattern has to match test files
+                extends: ['@mobile-reality/eslint-config/configs/jest'],
+            },
+        ],
     };
     ```
-   
+    XXX is a preconfigured eslint config for MR projects. Supported configs with required peerDependencies (which must be installed in project):
+    - node-javascript
+    - node-typescript (@typescript-eslint/eslint-plugin@~5.31.0 @typescript-eslint/parser@~5.31.0)
+    - react-javascript (eslint-plugin-unicorn eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-jsx-a11y eslint-plugin-simple-import-sort)
+    - react-typescript (@typescript-eslint/eslint-plugin@~5.31.0 @typescript-eslint/parser@~5.31.0 eslint-plugin-unicorn eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-jsx-a11y eslint-plugin-simple-import-sort)
+    - react-native (@typescript-eslint/eslint-plugin@~5.31.0 @typescript-eslint/parser@~5.31.0 eslint-plugin-unicorn eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-jsx-a11y eslint-plugin-simple-import-sort eslint-plugin-react-native)
+
 ## Installation and usage for an existing project
+
 1. Remove all `ESLint` and `prettier` dependencies (e.g. `eslint`, `prettier`, `eslint-plugin-prettier`, `@typescript-eslint/eslint-plugin` etc.) from package.json
 2. Reinstall `node_modules` (so remove them and install with `npm i` or `yarn install`)
 3. Go to the [installation step](#installation-and-usage-for-a-new-project)
 
 ## Override
+
 You can override rules by adding a rule to the rules section e.g.:
-```typescript jsx
-    module.exports = {
-        extends: [
-            '@mobile-reality'
-        ],
-        rules: {
-            "no-console": "off"
-        }
-    };
+
+```javascript
+module.exports = {
+    root: true,
+    extends: ['@mobile-reality'],
+    rules: {
+        'no-console': 'off',
+    },
+};
 ```
 
 ## Used packages
-* [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint/tree/main/packages/eslint-plugin)
-* [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint/tree/main/packages/parser)
-* [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier)
-* [eslint-plugin-flowtype](https://github.com/gajus/eslint-plugin-flowtype)
-* [eslint-plugin-jest](https://github.com/jest-community/eslint-plugin-jest)
-* [eslint-plugin-jsx-a11y](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y)
-* [eslint-plugin-prettier](https://github.com/prettier/eslint-plugin-prettier)
-* [eslint-plugin-react](https://github.com/yannickcr/eslint-plugin-react)
-* [eslint-plugin-react-hooks](https://github.com/facebook/react/tree/main/packages/eslint-plugin-react-hooks)
-* [eslint-plugin-react-native](https://github.com/intellicode/eslint-plugin-react-native)
-* [eslint-plugin-simple-import-sort](https://github.com/lydell/eslint-plugin-simple-import-sort)
-* [eslint-plugin-unicorn](https://github.com/sindresorhus/eslint-plugin-unicorn)
+
+-   [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint/tree/main/packages/eslint-plugin)
+-   [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint/tree/main/packages/parser)
+-   [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier)
+-   [eslint-plugin-flowtype](https://github.com/gajus/eslint-plugin-flowtype)
+-   [eslint-plugin-jest](https://github.com/jest-community/eslint-plugin-jest)
+-   [eslint-plugin-jsx-a11y](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y)
+-   [eslint-plugin-react](https://github.com/yannickcr/eslint-plugin-react)
+-   [eslint-plugin-react-hooks](https://github.com/facebook/react/tree/main/packages/eslint-plugin-react-hooks)
+-   [eslint-plugin-react-native](https://github.com/intellicode/eslint-plugin-react-native)
+-   [eslint-plugin-simple-import-sort](https://github.com/lydell/eslint-plugin-simple-import-sort)
+-   [eslint-plugin-unicorn](https://github.com/sindresorhus/eslint-plugin-unicorn)
 
 ## License
 

README.md

@@ -5,8 +5,6 @@ module.exports = {
         'react-native/no-inline-styles': 'error',
         'react-native/no-color-literals': 'error',
         'react-native/no-single-element-style-arrays': 'error',
-        'react-native/split-platform-components': 'off',
-        'react-native/no-raw-text': 'off',
         '@typescript-eslint/no-use-before-define': 'off',
         '@typescript-eslint/no-require-imports': 'off',
     },

configs/react-native.js

@@ -1,3 +1,3 @@
 module.exports = {
-    extends: ['./configs/eslint', 'plugin:prettier/recommended'],
+    extends: ['./configs/eslint', 'prettier'],
 };

index.js

@@ -1,7 +1,3 @@
 module.exports = {
-    extends: [
-        './configs/eslint',
-        './configs/typescript',
-        'plugin:prettier/recommended',
-    ],
+    extends: ['./configs/eslint', './configs/typescript', 'prettier'],
 };

node-javascript.js

@@ -5,7 +5,6 @@
     "engines": {
         "node": "^16.13"
     },
-    "main": "index.js",
     "repository": "https://github.com/MobileReality/eslint-config",
     "author": "Mobile Reality <biuro@mobilereality.pl> (https://mobilereality.pl)",
     "contributors": [
@@ -35,25 +34,24 @@
         "mobile reality"
     ],
     "scripts": {
-        "test": "echo \"Error: no test specified\" && exit 1",
         "release": "release-it",
         "release:beta": "release-it --preRelease=beta --no-git.requireUpstream",
         "prepare": "husky install"
     },
     "peerDependencies": {
+        "@typescript-eslint/eslint-plugin": "~5.31.0",
+        "@typescript-eslint/parser": "~5.31.0",
         "eslint": "~8.20.0",
-        "prettier": "^2.6.2",
-        "@typescript-eslint/eslint-plugin": "^5.17.0",
-        "@typescript-eslint/parser": "^5.17.0",
         "eslint-config-prettier": "^8.5.0",
         "eslint-plugin-jest": "^26.1.5",
         "eslint-plugin-jsx-a11y": "^6.5.1",
-        "eslint-plugin-prettier": "^4.0.0",
+        "eslint-plugin-prettier": "^4.2.0",
         "eslint-plugin-react": "^7.29.4",
         "eslint-plugin-react-hooks": "^4.4.0",
         "eslint-plugin-react-native": "^4.0.0",
         "eslint-plugin-simple-import-sort": "^7.0.0",
-        "eslint-plugin-unicorn": "^42.0.0"
+        "eslint-plugin-unicorn": "^42.0.0",
+        "prettier": "^2.7.0"
     },
     "peerDependenciesMeta": {
         "@typescript-eslint/eslint-plugin": {
@@ -88,10 +86,10 @@
         "@release-it/conventional-changelog": "^5.0.0",
         "husky": "^8.0.1",
         "lint-staged": "^12.3.7",
-        "prettier": "^2.6.2",
+        "prettier": "^2.7.1",
         "release-it": "^15.0.0"
     },
     "lint-staged": {
-        "*.js": "prettier --write ."
+        "*.{md,json,js}": "prettier --write ."
     }
 }

node-typescript.js

@@ -3,6 +3,6 @@ module.exports = {
         './configs/eslint',
         './configs/unicorn',
         './configs/react',
-        'plugin:prettier/recommended',
+        'prettier',
     ],
 };

package.json

@@ -8,6 +8,6 @@ module.exports = {
         './configs/unicorn',
         './configs/react',
         './configs/react-native',
-        'plugin:prettier/recommended',
+        'prettier',
     ],
 };

react-javascript.js

@@ -4,6 +4,6 @@ module.exports = {
         './configs/typescript',
         './configs/unicorn',
         './configs/react',
-        'plugin:prettier/recommended',
+        'prettier',
     ],
 };