Merge pull request #1 from WTMCRobotics/nstringham/prettier

add prettier to format code

.github/workflows/ci.yml

@@ -0,0 +1,13 @@
+name: CI
+on:
+    - push
+    - workflow_dispatch
+
+jobs:
+    lint:
+        name: Prettier
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+            - run: npm ci
+            - run: npx prettier -c .

.gitignore

@@ -176,3 +176,6 @@ logs/
 
 # Folder that has CTRE Phoenix Sim device config storage
 ctre_sim/
+
+# Node.js
+node_modules/

.prettierrc.yaml

@@ -0,0 +1,5 @@
+plugins:
+    - prettier-plugin-java
+
+printWidth: 120
+tabWidth: 4

.vscode/launch.json

@@ -1,21 +1,20 @@
 {
-  // Use IntelliSense to learn about possible attributes.
-  // Hover to view descriptions of existing attributes.
-  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-  "version": "0.2.0",
-  "configurations": [
-
-    {
-      "type": "wpilib",
-      "name": "WPILib Desktop Debug",
-      "request": "launch",
-      "desktop": true,
-    },
-    {
-      "type": "wpilib",
-      "name": "WPILib roboRIO Debug",
-      "request": "launch",
-      "desktop": false,
-    }
-  ]
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "wpilib",
+            "name": "WPILib Desktop Debug",
+            "request": "launch",
+            "desktop": true
+        },
+        {
+            "type": "wpilib",
+            "name": "WPILib roboRIO Debug",
+            "request": "launch",
+            "desktop": false
+        }
+    ]
 }

.vscode/settings.json

@@ -1,29 +1,32 @@
 {
-  "java.configuration.updateBuildConfiguration": "automatic",
-  "java.server.launchMode": "Standard",
-  "files.exclude": {
-    "**/.git": true,
-    "**/.svn": true,
-    "**/.hg": true,
-    "**/CVS": true,
-    "**/.DS_Store": true,
-    "bin/": true,
-    "**/.classpath": true,
-    "**/.project": true,
-    "**/.settings": true,
-    "**/.factorypath": true,
-    "**/*~": true
-  },
-  "java.test.config": [
-    {
-      "name": "WPIlibUnitTests",
-      "workingDirectory": "${workspaceFolder}/build/jni/release",
-      "vmargs": [ "-Djava.library.path=${workspaceFolder}/build/jni/release" ],
-      "env": {
-        "LD_LIBRARY_PATH": "${workspaceFolder}/build/jni/release" ,
-        "DYLD_LIBRARY_PATH": "${workspaceFolder}/build/jni/release"
-      }
+    "java.configuration.updateBuildConfiguration": "automatic",
+    "java.server.launchMode": "Standard",
+    "files.exclude": {
+        "**/.git": true,
+        "**/.svn": true,
+        "**/.hg": true,
+        "**/CVS": true,
+        "**/.DS_Store": true,
+        "bin/": true,
+        "**/.classpath": true,
+        "**/.project": true,
+        "**/.settings": true,
+        "**/.factorypath": true,
+        "**/*~": true
     },
-  ],
-  "java.test.defaultConfig": "WPIlibUnitTests"
+    "java.test.config": [
+        {
+            "name": "WPIlibUnitTests",
+            "workingDirectory": "${workspaceFolder}/build/jni/release",
+            "vmargs": ["-Djava.library.path=${workspaceFolder}/build/jni/release"],
+            "env": {
+                "LD_LIBRARY_PATH": "${workspaceFolder}/build/jni/release",
+                "DYLD_LIBRARY_PATH": "${workspaceFolder}/build/jni/release"
+            }
+        }
+    ],
+    "java.test.defaultConfig": "WPIlibUnitTests",
+    "editor.formatOnSave": true,
+    "prettier.documentSelectors": ["**/*.java"],
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
 }

.wpilib/wpilib_preferences.json

@@ -3,4 +3,4 @@
     "currentLanguage": "java",
     "projectYear": "2024",
     "teamNumber": 6101
-}
+}

WPILib-License.md

@@ -3,14 +3,15 @@ All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
-   * Redistributions of source code must retain the above copyright
-     notice, this list of conditions and the following disclaimer.
-   * Redistributions in binary form must reproduce the above copyright
-     notice, this list of conditions and the following disclaimer in the
-     documentation and/or other materials provided with the distribution.
-   * Neither the name of FIRST, WPILib, nor the names of other WPILib
-     contributors may be used to endorse or promote products derived from
-     this software without specific prior written permission.
+
+-   Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+-   Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in the
+    documentation and/or other materials provided with the distribution.
+-   Neither the name of FIRST, WPILib, nor the names of other WPILib
+    contributors may be used to endorse or promote products derived from
+    this software without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY FIRST AND OTHER WPILIB CONTRIBUTORS "AS IS" AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

package.json

@@ -0,0 +1,6 @@
+{
+    "devDependencies": {
+        "prettier": "^3.2.1",
+        "prettier-plugin-java": "^2.5.0"
+    }
+}

src/main/java/frc/robot/Main.java

@@ -12,14 +12,15 @@
  * call.
  */
 public final class Main {
-  private Main() {}
 
-  /**
-   * Main initialization function. Do not perform any initialization here.
-   *
-   * <p>If you change your main robot class, change the parameter type.
-   */
-  public static void main(String... args) {
-    RobotBase.startRobot(Robot::new);
-  }
+    private Main() {}
+
+    /**
+     * Main initialization function. Do not perform any initialization here.
+     *
+     * <p>If you change your main robot class, change the parameter type.
+     */
+    public static void main(String... args) {
+        RobotBase.startRobot(Robot::new);
+    }
 }