[MOB-9138] Add ESLint + Prettier (#802)

* Add ESLint + Prettier

* Fix Format

* Remove ESLint from Example

* Fix Automatic Lint Issues

* Fix Equality Issues

* Fix Undefined Variables

* Fix Duplicate Tests Description

* Remove Unused Vars

* Fix New Function Error

* Fix Shadowing

* Remove Inline Styles

* Fix Nested Components

* Enforce `const`

* Add Lint CI Job

* Scope `env` to test files

* Extract `TabBarIcon` to its own Component

* Separate Jest and Detox Overrides

* Enforce Sorted Imports

* Update Scripts

* Format All Files

* Fix More Formatting Issues

Author: TheBuggedYRN

.circleci/config.yml

@@ -9,6 +9,23 @@ jobs:
     steps:
       - checkout
       - run: danger
+
+  lint:
+    working_directory: ~/project
+    docker:
+      - image: cimg/node:16.17.1
+    steps:
+      - checkout
+      - run:
+          name: Install Node Packages
+          command: yarn
+      - run:
+          name: Check Format
+          command: yarn format
+      - run:
+          name: Check Lint
+          command: yarn lint:ci
+
   test_module:
     working_directory: ~/project
     docker:
@@ -28,7 +45,7 @@ jobs:
             yarn run test
           environment:
             JEST_JUNIT_OUTPUT: test-results/jest/junit.xml
-      
+
       - codecov/upload:
           flags: javascript
 
@@ -46,7 +63,7 @@ jobs:
   test_android:
     executor:
       name: android/android-machine
-      tag: "2022.03.1"
+      tag: '2022.03.1'
     working_directory: ~/project
     steps:
       - checkout:
@@ -80,7 +97,7 @@ jobs:
           command: bash -n ios/upload_sourcemap.sh
 
   # Make sure that files like yarn.lock and project.pbxproj
-  # are in sync with the latest changes in package.json and 
+  # are in sync with the latest changes in package.json and
   # ios/upload_sourcemap.sh files respectively.
   sync_generated_files:
     macos:
@@ -120,7 +137,7 @@ jobs:
   e2e_ios:
     macos:
       xcode: 13.4.1
-    resource_class: large  
+    resource_class: large
     working_directory: ~/project
     environment:
       FL_OUTPUT_DIR: output
@@ -164,12 +181,12 @@ jobs:
   e2e_android:
     executor:
       name: android/android-machine
-      tag: "2022.03.1"
+      tag: 2022.03.1
       resource-class: large
     working_directory: ~/project
     steps:
       - checkout
-      - run: 
+      - run:
           name: Install Yarn
           command: npm install --global yarn
       - run:
@@ -194,18 +211,18 @@ jobs:
           no-window: true
           memory: 2048
           post-emulator-launch-assemble-command: |
-              rm -rf ~/.gradle/caches
-              cd ~/project/example/android && ./gradlew androidDependencies
-              cd .. && detox build -c android.emu.release
+            rm -rf ~/.gradle/caches
+            cd ~/project/example/android && ./gradlew androidDependencies
+            cd .. && detox build -c android.emu.release
       - run:
           name: Detox - Run E2E Tests
           working_directory: example
           command: detox test -c android.emu.release
 
   publish:
     macos:
-      xcode: "13.4.1"
-    working_directory: "~"
+      xcode: 13.4.1
+    working_directory: ~
     steps:
       - checkout:
           path: ~/project
@@ -219,6 +236,7 @@ workflows:
   publish:
     jobs:
       - danger
+      - lint
       - test_module
       - test_android
       - validate_shell_files
@@ -228,6 +246,8 @@ workflows:
       - e2e_android
       - hold:
           requires:
+            - danger
+            - lint
             - test_module
             - test_android
             - validate_shell_files

.eslintrc.js

@@ -0,0 +1,33 @@
+/** @type {import('eslint').ESLint.ConfigData} */
+module.exports = {
+  extends: '@react-native-community',
+  plugins: ['prettier', 'jest'],
+  overrides: [
+    {
+      // Jest Overrides
+      files: ['tests/**'],
+      env: {
+        node: true,
+        browser: true,
+        'jest/globals': true,
+      },
+    },
+    {
+      // Detox Overrides
+      files: ['example/e2e/**.js'],
+      env: {
+        'jest/globals': true,
+      },
+      globals: {
+        device: false,
+        waitFor: false,
+        element: false,
+        by: false,
+      },
+    },
+  ],
+  rules: {
+    'prettier/prettier': 'error',
+    'prefer-const': 'error',
+  },
+};

.github/dependabot.yml

@@ -1,10 +1,10 @@
 version: 2
 
 updates:
-  - package-ecosystem: "npm"
-    directory: "/"
+  - package-ecosystem: npm
+    directory: /
     schedule:
-      interval: "weekly"
+      interval: weekly
     ignore:
-      - dependency-name: "*"
-        update-types: ["version-update:semver-major"]
+      - dependency-name: '*'
+        update-types: [version-update:semver-major]

.github/issue_template.md

@@ -1,8 +1,8 @@
 <!--
-Please fill in the template below when creating an issue 
+Please fill in the template below when creating an issue
 to help us reproduce it and fix it faster.
 
-While not required, including a sample project that reproduces 
+While not required, including a sample project that reproduces
 your issue will help us a lot.
 -->
 
@@ -13,15 +13,19 @@ your issue will help us a lot.
 ### Actual Behavior
 
 ### Instabug integration code
+
 <!--Make sure to remove your app token.-->
 
 ### SDK Version
+
 <!--Which version of Instabug React Native are you on?.-->
 
 ### React Native, iOS and Android Versions
 
 ### Device Model
+
 <!--If this issue is happening on specific devices, please mention them.-->
 
 ### [Optional] Project That Reproduces the Issue
+
 <!--While not required, providing a sample project that reproduces the issue you're having will help us solve it much faster.-->

.github/pull_request_template.md

@@ -1,15 +1,25 @@
 ## Description of the change
+
 > Description goes here
+
 ## Type of change
+
 - [ ] Bug fix (non-breaking change that fixes an issue)
 - [ ] New feature (non-breaking change that adds functionality)
 - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+
 ## Related issues
+
 > Issue links go here
+
 ## Checklists
+
 ### Development
+
 - [ ] Lint rules pass locally
 - [ ] The code changed/added as part of this pull request has been covered with tests
-### Code review 
+
+### Code review
+
 - [ ] This pull request has a descriptive title and information useful to a reviewer
-- [ ] Issue from task tracker has a link to this pull request 
+- [ ] Issue from task tracker has a link to this pull request

.prettierrc.js

@@ -1,8 +1,14 @@
+/** @type {import('prettier').Config} */
 module.exports = {
-  arrowParens : 'avoid',
-  bracketSameLine : true,
-  printWidth : 100,
-  singleQuote : true,
-  trailingComma : 'all',
+  semi: true,
+  singleQuote: true,
+  bracketSameLine: true,
+  useTabs: false,
+  tabWidth: 2,
+  trailingComma: 'all',
+  endOfLine: 'auto',
+  printWidth: 100,
+  importOrder: ['mocks', '^react(-native)?(/.*)?$', '<THIRD_PARTY_MODULES>', '^[./]'],
+  importOrderSeparation: true,
+  importOrderSortSpecifiers: true,
 };
-