Updated linting for project. (#107)

Author: errc-lee

.eslintrc.js

@@ -4,24 +4,64 @@ module.exports = {
     commonjs: true,
     es2021: true,
     node: true,
+    'jest/globals': true,
   },
-  extends: ['eslint:recommended', 'plugin:react/recommended'],
+  extends: [
+    'eslint:recommended',
+    'plugin:react/recommended', // Uses the recommended rules from @eslint-plugin-react
+    'plugin:@typescript-eslint/recommended', // Uses the recommended rules from the @typescript-eslint/eslint-plugin
+    'plugin:prettier/recommended', // Enables eslint-plugin-prettier and eslint-config-prettier. This will display prettier errors as ESLint errors. Make sure this is always the last configuration in the extends array.
+  ],
+  plugins: ['react', '@typescript-eslint', 'jest', 'prettier'],
+  parser: '@typescript-eslint/parser', // Specifies the ESLint parser
   parserOptions: {
+    ecmaVersion: 2020,
+    sourceType: 'module',
     ecmaFeatures: {
-      jsx: true,
+      jsx: true, // Allows for the parsing of JSX
+    },
+  },
+  settings: {
+    react: {
+      // Tells eslint-plugin-react to automatically detect the version of React to use
+      version: 'detect',
     },
-    ecmaVersion: 12,
-    sourceType: 'module',
   },
-  plugins: ['react'],
+  // any directories/files to ignore goes here; node_modules ignore by default
+  ignorePatterns: [],
   rules: {
-    indent: ['warn', 2],
-    'no-unused-vars': ['off', { vars: 'local' }],
+    /**
+     * Place to specify ESLint rules. Can be used to overwrite rules specified from the extended configs
+     * e.g. "@typescript-eslint/explicit-function-return-type": "off",
+     *
+     *  "off" or 0 - turn the rule off
+     * "warn" or 1 - turn the rule on as a warning(doesn’ t affect exit code)
+     * "error" or 2 - turn the rule on as an error(exit code is 1 when triggered)
+     **/
+
+    indent: 0, // set to 0 as eslint and prettier will conflict
     'prefer-const': 'warn',
-    quotes: ['warn', 'single'],
-    semi: ['warn', 'always'],
+    quotes: [
+      2,
+      'single',
+      {
+        avoidEscape: true,
+        allowTemplateLiterals: true,
+      },
+    ],
+    semi: 2,
     'space-infix-ops': 'warn',
     'no-console': 'off',
+    // ----- REACT ----- //
+    'react/prop-types': 0, // remove with TS usage
+
+    // ----- TYPESCRIPT ----- //
+    '@typescript-eslint/no-var-requires': 0,
+
+    // ----- PRETTIER ----- //
+    'prettier/prettier': ['error', { singleQuote: true }],
+
+    // ----- MISC ----- //
     'no-restricted-syntax': [
       'error',
       {

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,17 +1,17 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
+title: ""
+labels: ""
+assignees: ""
 ---
 
 **Describe the bug**
 A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
@@ -24,15 +24,17 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
+
+- OS: [e.g. iOS]
+- Browser [e.g. chrome, safari]
+- Version [e.g. 22]
 
 **Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
+
+- Device: [e.g. iPhone6]
+- OS: [e.g. iOS8.1]
+- Browser [e.g. stock browser, safari]
+- Version [e.g. 22]
 
 **Additional context**
 Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,10 +1,9 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
-
+title: ""
+labels: ""
+assignees: ""
 ---
 
 **Is your feature request related to a problem? Please describe.**

.gitignore

@@ -1,16 +1,12 @@
-.DS_Store
+node_modules/
 build/
+coverage
+.DS_Store
+.env
+.idea/
+thumbs.db
 dist/
-node_modules/
 security/
-thumbs.db
-.idea/
-package-lock.json
-.webpack.config.js.icloud
-src/.index.js.icloud
-src/.store.js.icloud
-src/components/display/.RunningContainers.js.icloud
-src/components/display/.StoppedContainers.js.icloud
 src/database/docketeerdb
-.env
+package-lock.json
 yarn.lock

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npm run test

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx lint-staged

.prettierrc.js

@@ -0,0 +1,9 @@
+module.exports = {
+  printWidth: 80,
+  tabWidth: 2,
+  singleQuote: true,
+  trailingComma: "es5",
+  bracketSpacing: true,
+  semi: true,
+  useTabs: false,
+};

.travis.yml

@@ -2,7 +2,7 @@ language: node_js
 
 node_js:
   - 16
-  
+
 env:
   global: PATH=/opt/python/3.7.1/bin:$PATH
 

.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+  "editor.formatOnPaste": true,
+  "editor.formatOnSave": true,
+  "editor.formatOnType": true,
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": true
+  }
+}

CODE_OF_CONDUCT.md

@@ -14,22 +14,22 @@ appearance, race, religion, or sexual identity and orientation.
 Examples of behavior that contributes to creating a positive environment
 include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
- advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
- address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
- professional setting
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
 
 ## Our Responsibilities