Merge pull request #53 from gadhagod/main

Add formatter

Author: CMEONE

.prettierignore

@@ -0,0 +1 @@
+*.min.*

README.md

@@ -1,25 +1,35 @@
-const mongoose = require('mongoose');
-const config = require('./config.json');
+const mongoose = require("mongoose");
+const config = require("./config.json");
 
 mongoose.Promise = global.Promise;
 
-mongoose.connect(`mongodb://${config.database.auth ? config.database.auth.username + ":"+config.database.auth.password + "@" : ""}localhost:${config.database.port}/${config.database.databaseName}`, {
- config: {
-   autoIndex: false,
- },
- useNewUrlParser:true,
- useUnifiedTopology: true
-});
+mongoose.connect(
+    `mongodb://${
+        config.database.auth
+            ? config.database.auth.username +
+              ":" +
+              config.database.auth.password +
+              "@"
+            : ""
+    }localhost:${config.database.port}/${config.database.databaseName}`,
+    {
+        config: {
+            autoIndex: false,
+        },
+        useNewUrlParser: true,
+        useUnifiedTopology: true,
+    }
+);
 
 const db = mongoose.connection;
 
-db.on('error', () => {
- console.error('MongoDB connection error');
- process.exit(1);
+db.on("error", () => {
+    console.error("MongoDB connection error");
+    process.exit(1);
 });
 
-db.once('open', () => {
- console.log('Successfully connected to MongoDB');
+db.once("open", () => {
+    console.log("Successfully connected to MongoDB");
 });
 
 module.exports = mongoose;

db.js

@@ -1,3 +1,3 @@
 # Home
 
-Welcome to Harker Robotics' software documentation! To get started, visit the [introduction](introduction/) page.
+Welcome to Harker Robotics' software documentation! To get started, visit the [introduction](introduction/) page.

docs/index.md

@@ -1,22 +1,21 @@
 # Git
 
-Git is a source control tool that we use to manage changes in our code. It allows us to map out the progress of our code over time, and also makes it easy to revert to a previous version if necessary. At its core, Git works not by storing the code but instead by tracking *commits*, which is a change in the code. Whenever make a major change or implement an important feature, we create a commit, which stores how the code was changed from the previous commit. To fetch the latest version, it runs through the previous commits and reconstructs the code. To speed things up, git creates checkpoints that reocrds the codebase at that commit, so it doesn't have to jump all the way back to the start. 
+Git is a source control tool that we use to manage changes in our code. It allows us to map out the progress of our code over time, and also makes it easy to revert to a previous version if necessary. At its core, Git works not by storing the code but instead by tracking _commits_, which is a change in the code. Whenever make a major change or implement an important feature, we create a commit, which stores how the code was changed from the previous commit. To fetch the latest version, it runs through the previous commits and reconstructs the code. To speed things up, git creates checkpoints that reocrds the codebase at that commit, so it doesn't have to jump all the way back to the start.
 
-To store our code online we use GitHub. GitHub stores Git projects online, and is referred to as a *remote*, a server where your project is stored (think of Git as email, while GitHub is Gmail).
+To store our code online we use GitHub. GitHub stores Git projects online, and is referred to as a _remote_, a server where your project is stored (think of Git as email, while GitHub is Gmail).
 
 ### Tutorials
 
-There are tons of Git tutorials online that are really great. To learn the basics, go to <https://backlog.com/git-tutorial/what-is-git/> and complete the **Learn Git Basics** section (except the *Rewriting History* lesson, that is very bad practice) and the **Learn Git Collboration** section, stopping after you complete the *Branching Workflows* lesson. Keep in mind that the sample workflow in that lesson is typical in larger scopes, our team normally onlt uses two branches, dev and master.
+There are tons of Git tutorials online that are really great. To learn the basics, go to <https://backlog.com/git-tutorial/what-is-git/> and complete the **Learn Git Basics** section (except the _Rewriting History_ lesson, that is very bad practice) and the **Learn Git Collboration** section, stopping after you complete the _Branching Workflows_ lesson. Keep in mind that the sample workflow in that lesson is typical in larger scopes, our team normally onlt uses two branches, dev and master.
 
 Git is very complex and it can be difficult to remember all the commands. Our team has a cheatsheet available at <https://robotics.harker.org/github> that contains all the commands you should need in robotics that you can consult if you forget something.
 
 ### Commit Messages
 
-Commit messages summarize a group of changes into a sentence, so writing them well makes the development process much easier. Our team has a standard format for commit messages: they should start with a capitalized, present tense verb. A valid commit message forms a sentence if you put "This commit will ..." before it (ignoring capitalization). 
+Commit messages summarize a group of changes into a sentence, so writing them well makes the development process much easier. Our team has a standard format for commit messages: they should start with a capitalized, present tense verb. A valid commit message forms a sentence if you put "This commit will ..." before it (ignoring capitalization).
 
 > This commit will **Begin tuning auton paths**.
 
-Multiple phrases should be separated by a comma (without *and*), which does break this structure, but the individual parts should still follow it. Here is a sample set of commits from our 2020 codebase:
+Multiple phrases should be separated by a comma (without _and_), which does break this structure, but the individual parts should still follow it. Here is a sample set of commits from our 2020 codebase:
 
 ![image of commits](https://i.imgur.com/ZhsBEtP.png)
-

docs/introduction/git.md

@@ -1,10 +1,11 @@
 # Introduction
-The software docs are designed to act both as training material as well as a quick refrerence for those looking to refresh their knowledge or learn a little about how software works. It's divided into three sections: Introduction, Basic Concepts, and Advanced Concepts. 
 
-- The [Introduction](.) section is designed to be a "Week 1" training set, which goes over how to get set up to write software and some of the fundamental concepts that we use.
-- The [Basic Concepts](../basic/) include those that are used in every codebase, and make up the vast majority of the code we write. Any software member looking to make significant contributions should master these concepts, as a thorough understanding of them will allow you to quickly write code and provide a foundation to learn the more advanced concepts.
--  The [Advanced Concepts](../advanced/) are those that may not be used every year or ones that are complicated enough that we use an external library to provide their functionality. These should only be tackled if you are very comfortable with the basic conepts.
+The software docs are designed to act both as training material as well as a quick refrerence for those looking to refresh their knowledge or learn a little about how software works. It's divided into three sections: Introduction, Basic Concepts, and Advanced Concepts.
 
-It's important to know that the docs are intended as a supplement to normal training presentations and projects. Reading these pages alone will not help you learn, you need to actually open an editor and write some original code. Copying from the docs won't help you learn, even if it writing code feels challenging at first. 
+-   The [Introduction](.) section is designed to be a "Week 1" training set, which goes over how to get set up to write software and some of the fundamental concepts that we use.
+-   The [Basic Concepts](../basic/) include those that are used in every codebase, and make up the vast majority of the code we write. Any software member looking to make significant contributions should master these concepts, as a thorough understanding of them will allow you to quickly write code and provide a foundation to learn the more advanced concepts.
+-   The [Advanced Concepts](../advanced/) are those that may not be used every year or ones that are complicated enough that we use an external library to provide their functionality. These should only be tackled if you are very comfortable with the basic conepts.
 
-If you have any extra questions or comments about any of the material, feel free to send a message in #software.
+It's important to know that the docs are intended as a supplement to normal training presentations and projects. Reading these pages alone will not help you learn, you need to actually open an editor and write some original code. Copying from the docs won't help you learn, even if it writing code feels challenging at first.
+
+If you have any extra questions or comments about any of the material, feel free to send a message in #software.

docs/introduction/index.md

@@ -2,15 +2,15 @@
 
 In order to start coding, you'll need to the right apps to allow you to write robot code. The software can be divided into two groups: those needed to write and deploy code, and those needed to enable and run the robot. Since all the programs needed to run the code are already installed on the software laptop, you only need to install the ones for coding. These include:
 
- - Visual Studio Code, an IDE for writing code
- - Java JDK 11, to compile the project
- - Gradle, a program to build and deploy code
- - VS Code extentions, to streamline development
- - Git, to manage our code over time 
- - WPILib, a library that interfaces with the robot
+-   Visual Studio Code, an IDE for writing code
+-   Java JDK 11, to compile the project
+-   Gradle, a program to build and deploy code
+-   VS Code extentions, to streamline development
+-   Git, to manage our code over time
+-   WPILib, a library that interfaces with the robot
 
 Fortunately, almost all of these are included with an installer that WPILib provides, which installs a custom version of VS Code (which will be separate from an existing version of VS Code). Follow the following link to go through the installation process: <https://docs.wpilib.org/en/stable/docs/zero-to-robot/step-2/wpilib-setup.html>
 
-Make sure to select **Download VS Code for Single Install** as the installation option. You can leave all the installation options checked, technically our team doesn't use C++ or the Tools and Utilities, but its still nice to have them available. 
+Make sure to select **Download VS Code for Single Install** as the installation option. You can leave all the installation options checked, technically our team doesn't use C++ or the Tools and Utilities, but its still nice to have them available.
 
-Once the installation process finishes, first check the name of the VS Code application that it created. If it has the name "Visual Studio Code," I recommend you rename it to something like FRC VS Code 2021 (or the correct year), so you can keep track of multiple versions over time and avoid conflicts with the actual non-WPILib VS Code. Also, you'll have to install Live Share, an extension that isn't included in the installer. Open VS Code and click on the bottom most icon on the left side (looks 3 squares with 1 more detached), then search for "Live Share" and install the one by Microsoft. Live Share is essentially Google Docs for coding and makes collaboration very easy.
+Once the installation process finishes, first check the name of the VS Code application that it created. If it has the name "Visual Studio Code," I recommend you rename it to something like FRC VS Code 2021 (or the correct year), so you can keep track of multiple versions over time and avoid conflicts with the actual non-WPILib VS Code. Also, you'll have to install Live Share, an extension that isn't included in the installer. Open VS Code and click on the bottom most icon on the left side (looks 3 squares with 1 more detached), then search for "Live Share" and install the one by Microsoft. Live Share is essentially Google Docs for coding and makes collaboration very easy.

docs/introduction/installation.md

@@ -1,24 +1,27 @@
 # Java Resources
 
-Our team uses Java to code the robot, primarily because Harker also teaches Java in CS classes. Other langauges that are common among other teams are C++, LabView, and Python. 
+Our team uses Java to code the robot, primarily because Harker also teaches Java in CS classes. Other langauges that are common among other teams are C++, LabView, and Python.
 
-A working knowledge of Java is important in learning FRC programming, especially once the program constructs are introduced. Concepts like the command-based system and robot lifecycle are much easier to understand if you have a programming background. However, in general the curriculum is designed to be useful to those even without programming experience. If you've completed Advanced Programming or higher you should be fine, otherwise if you haven't learned Java or know another language, it is highly recommended to learn or refresh yourself in Java syntax. Below are a list of resoucres, tutorials, and videos that can assist your learning. 
+A working knowledge of Java is important in learning FRC programming, especially once the program constructs are introduced. Concepts like the command-based system and robot lifecycle are much easier to understand if you have a programming background. However, in general the curriculum is designed to be useful to those even without programming experience. If you've completed Advanced Programming or higher you should be fine, otherwise if you haven't learned Java or know another language, it is highly recommended to learn or refresh yourself in Java syntax. Below are a list of resoucres, tutorials, and videos that can assist your learning.
 
 ### Learning Java
- - [Codecademy course](https://www.codecademy.com/learn/learn-java)  
- - [Youtube tutorial](https://www.youtube.com/watcH?v=GoXwIVyNvX0)  
- - [Java syntax review](https://learnxinyminutes.com/docs/java)
+
+-   [Codecademy course](https://www.codecademy.com/learn/learn-java)
+-   [Youtube tutorial](https://www.youtube.com/watcH?v=GoXwIVyNvX0)
+-   [Java syntax review](https://learnxinyminutes.com/docs/java)
 
 ### Practice
- - [CodingBat](https://codingbat.com/java)  
- - <https://practiceit.cs.washington.edu/>
+
+-   [CodingBat](https://codingbat.com/java)
+-   <https://practiceit.cs.washington.edu/>
 
 ### Extras
-These are concepts that might not be emphasized in normal courses but you should definitely know for robot programming.  
-
- - [Object Oriented Programming Review](https://stackify.com/oops-concepts-in-java/)
- - [Static vs. Non-static 1](https://www.programiz.com/java-programming/static-keyword)
- - [Static vs. Non-static 2](https://beginnersbook.com/2013/05/static-vs-non-static-methods/)
- - [Static vs. Non-static 3](https://www.tutorialspoint.com/differences-between-static-and-non-static-methods-in-java)
- - [Singletons](https://www.programiz.com/java-programming/singleton)
- - [Enums](https://www.programiz.com/java-programming/enums)
+
+These are concepts that might not be emphasized in normal courses but you should definitely know for robot programming.
+
+-   [Object Oriented Programming Review](https://stackify.com/oops-concepts-in-java/)
+-   [Static vs. Non-static 1](https://www.programiz.com/java-programming/static-keyword)
+-   [Static vs. Non-static 2](https://beginnersbook.com/2013/05/static-vs-non-static-methods/)
+-   [Static vs. Non-static 3](https://www.tutorialspoint.com/differences-between-static-and-non-static-methods-in-java)
+-   [Singletons](https://www.programiz.com/java-programming/singleton)
+-   [Enums](https://www.programiz.com/java-programming/enums)

docs/introduction/java-resources.md

@@ -2,6 +2,6 @@
     --md-primary-fg-color: #1e3155;
 }
 
-:root>* {
-    --md-typeset-a-color:  #557cc3 !important;
-}
+:root > * {
+    --md-typeset-a-color: #557cc3 !important;
+}

docs/stylesheets/extra.css

@@ -1,10 +1,12 @@
 module.exports = {
-    apps : [{
-      name: "_github",
-      script: "./index.js",
-      env_hook: {
-        command: 'git pull && pm2 restart robo',
-        cwd: '/home/djm/robotics-website'
-    }
-    }]
-  }
+    apps: [
+        {
+            name: "_github",
+            script: "./index.js",
+            env_hook: {
+                command: "git pull && pm2 restart robo",
+                cwd: "/home/djm/robotics-website",
+            },
+        },
+    ],
+};

ecosystem.config.js

@@ -1,4 +1,4 @@
-  {
+{
     "contacturl": "https://hooks.slack.com/services/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",
     "google": {
         "clientIDs": ["GoogleClientID"],
@@ -41,8 +41,16 @@
         "apiKey": "key"
     },
     "users": {
-        "admins": ["22angiej@students.harker.org", "22ethanc@students.harker.org", "22gloriaz@students.harker.org"],
+        "admins": [
+            "22angiej@students.harker.org",
+            "22ethanc@students.harker.org",
+            "22gloriaz@students.harker.org"
+        ],
         "mentor": "robotics@harker.org",
-        "superadmins": [ "22arjund@students.harker.org", "22chiragk@students.harker.org", "24kabirr@students.harker.org"]
+        "superadmins": [
+            "22arjund@students.harker.org",
+            "22chiragk@students.harker.org",
+            "24kabirr@students.harker.org"
+        ]
     }
 }

exampleconfig.json

@@ -1,33 +1,41 @@
 const sessionAuth = (req, res, next) => {
-  req.auth = req.session.auth
-  if (!req.auth) req.auth = { loggedin: false }
-  res.locals.auth = req.auth
-  next()
-}
+    req.auth = req.session.auth;
+    if (!req.auth) req.auth = { loggedin: false };
+    res.locals.auth = req.auth;
+    next();
+};
 
 const verifyLogin = (req, res, next) => {
-  sessionAuth(req, res, () => {
-    if (req.auth.loggedin) {
-      console.log(`[REQ: ${req.request_id}] Authed as: ${req.auth.info.name} (${req.auth.info.email})`)
-      console.log(`[REQ: ${req.request_id}] Auth level: ${req.auth.level}`)
-      next()
-    } else {
-      res.render('pages/member/login')
-    }
-  })
-}
+    sessionAuth(req, res, () => {
+        if (req.auth.loggedin) {
+            console.log(
+                `[REQ: ${req.request_id}] Authed as: ${req.auth.info.name} (${req.auth.info.email})`
+            );
+            console.log(
+                `[REQ: ${req.request_id}] Auth level: ${req.auth.level}`
+            );
+            next();
+        } else {
+            res.render("pages/member/login");
+        }
+    });
+};
 
-const verifyRank = rank => {
-  return (req, res, next) => {
-    verifyLogin(req, res, () => {
-      if (req.auth.level >= rank) next()
-      else res.render('pages/member/error', { statusCode: 401, error: "You must have higher authorization to reach this page."})
-    })
-  }
-}
+const verifyRank = (rank) => {
+    return (req, res, next) => {
+        verifyLogin(req, res, () => {
+            if (req.auth.level >= rank) next();
+            else
+                res.render("pages/member/error", {
+                    statusCode: 401,
+                    error: "You must have higher authorization to reach this page.",
+                });
+        });
+    };
+};
 
 module.exports = {
-  sessionAuth,
-  verifyLogin,
-  verifyRank,
-}
+    sessionAuth,
+    verifyLogin,
+    verifyRank,
+};