chore: add editorconfig (#5)

Author: idleberg

.editorconfig

@@ -0,0 +1,16 @@
+# EditorConfig is awesome: https://EditorConfig.org
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = tab
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.yml]
+indent_style = space
+
+[*.md]
+trim_trailing_whitespace = false

.github/workflows/build.yml

@@ -13,21 +13,29 @@ jobs:
 
     strategy:
       matrix:
-        java: [ '8', '11', '17', '21' ] # all the LTS versions
+        # all the LTS versions
+        java: [ '8', '11', '17', '21' ]
       fail-fast: false
 
     steps:
     - name: Checkout code
       uses: actions/checkout@v4
 
-    - name: Set up JDK ${{ matrix.java }}
+    - name: Set up JDK 17 (for Gradle/Spotless)
       uses: actions/setup-java@v4
       with:
-        java-version: ${{ matrix.java }}
+        java-version: '17'
         distribution: 'temurin'
 
     - name: Setup Gradle
-      uses: gradle/gradle-build-action@v3
+      uses: gradle/actions/setup-gradle@v5
 
-    - name: Build with Gradle
-      run: ./gradlew build --no-daemon
+    - name: Check code formatting
+      # older versions are incompatible with our spotless version
+      if: matrix.java == '17' || matrix.java == '21'
+      run: ./gradlew spotlessCheck --no-daemon
+
+    - name: Build and test with JDK ${{ matrix.java }}
+      run: ./gradlew build --no-daemon -PjavaToolchain=${{ matrix.java }}
+      env:
+        GRADLE_OPTS: -Dorg.gradle.java.installations.auto-download=true

.vscode/extensions.json

@@ -0,0 +1,6 @@
+{
+	"recommendations": [
+		"editorconfig.editorconfig",
+		"richardwillis.vscode-spotless-gradle"
+	]
+}

.vscode/settings.json

@@ -0,0 +1,16 @@
+{
+	"java.format.enabled": false,
+	"files.trimTrailingWhitespace": false,
+	"spotlessGradle.diagnostics.enable": true,
+	"spotlessGradle.format.enable": true,
+	"editor.codeActionsOnSave": {
+		"source.fixAll.spotlessGradle": "explicit"
+	},
+	"[java]": {
+		"editor.defaultFormatter": "richardwillis.vscode-spotless-gradle"
+	},
+	"[gradle]": {
+		"editor.defaultFormatter": "richardwillis.vscode-spotless-gradle"
+	},
+	"java.configuration.updateBuildConfiguration": "automatic"
+}

build.gradle

@@ -1,58 +1,80 @@
 plugins {
-    id 'java'
-    id 'application'
+	id 'java'
+	id 'application'
+	id 'com.diffplug.spotless' version '6.25.0'
 }
 
 group = 'nsl'
 version = '1.0-SNAPSHOT'
 
 java {
-    sourceCompatibility = JavaVersion.VERSION_1_8
-    targetCompatibility = JavaVersion.VERSION_1_8
+	// Use toolchain to compile with specified Java version
+	// This allows Gradle to run with Java 11+ (for Spotless) while compiling for target version
+	toolchain {
+		// Default to Java 8, but can be overridden via -PjavaToolchain=X
+		def toolchainVersion = project.hasProperty('javaToolchain') ? project.property('javaToolchain') : '8'
+		languageVersion = JavaLanguageVersion.of(toolchainVersion)
+	}
 }
 
 application {
-    mainClass = 'nsl.Main'
+	mainClass = 'nsl.Main'
 }
 
 repositories {
-    mavenCentral()
+	mavenCentral()
 }
 
 dependencies {
-    testImplementation 'junit:junit:4.12'
-    testImplementation 'org.hamcrest:hamcrest-core:1.3'
+	testImplementation 'junit:junit:4.12'
+	testImplementation 'org.hamcrest:hamcrest-core:1.3'
 }
 
 // Configure JAR manifest
 jar {
-    manifest {
-        attributes(
-            'Main-Class': 'nsl.Main'
-        )
-    }
-    archiveFileName = 'nsL.jar'
+	manifest {
+		attributes(
+			'Main-Class': 'nsl.Main'
+		)
+	}
+	archiveFileName = 'nsL.jar'
 }
 
 // Configure source and test directories to match existing structure
 sourceSets {
-    main {
-        java {
-            srcDir 'src'
-        }
-    }
-    test {
-        java {
-            srcDir 'test'
-        }
-    }
+	main {
+		java {
+			srcDir 'src'
+		}
+	}
+	test {
+		java {
+			srcDir 'test'
+		}
+	}
 }
 
 // Configure test output
 test {
-    testLogging {
-        events "passed", "skipped", "failed"
-        exceptionFormat "full"
-        showStandardStreams = true
-    }
+	testLogging {
+		events "passed", "skipped", "failed"
+		exceptionFormat "full"
+		showStandardStreams = true
+	}
+}
+
+// Configure code formatting with Spotless
+spotless {
+	java {
+		target 'src/**/*.java', 'test/**/*.java'
+
+		// Use Google Java Format with explicit version for Java 21 compatibility
+		googleJavaFormat('1.22.0')
+
+		// Additional formatting
+		removeUnusedImports()
+		indentWithTabs(2)
+		trimTrailingWhitespace()
+		endWithNewline()
+	}
 }

settings.gradle

@@ -0,0 +1,6 @@
+// Configure toolchain resolver to auto-download JDKs
+plugins {
+	id 'org.gradle.toolchains.foojay-resolver-convention' version '0.8.0'
+}
+
+rootProject.name = 'nsl-assembler'

src/nsl/CodeInfo.java

@@ -7,102 +7,98 @@
 import java.util.HashMap;
 
 /**
- *
  * @author Stuart
  */
-public abstract class CodeInfo
-{
-  protected static CodeInfo current = null;
+public abstract class CodeInfo {
+	protected static CodeInfo current = null;
 
-  protected final HashMap<Integer, Register> usedVars;
+	protected final HashMap<Integer, Register> usedVars;
 
-  private Label labelBreak;
-  private Label labelContinue;
+	private Label labelBreak;
+	private Label labelContinue;
 
-  protected CodeInfo()
-  {
-    this.usedVars = new HashMap<Integer, Register>();
-    this.labelBreak = null;
-    this.labelContinue = null;
-  }
+	protected CodeInfo() {
+		this.usedVars = new HashMap<Integer, Register>();
+		this.labelBreak = null;
+		this.labelContinue = null;
+	}
 
-  /**
-   * Gets the variables used in the function.
-   * @return the variables used in the function
-   */
-  public HashMap<Integer, Register> getUsedVars()
-  {
-    return this.usedVars;
-  }
+	/**
+	 * Gets the variables used in the function.
+	 *
+	 * @return the variables used in the function
+	 */
+	public HashMap<Integer, Register> getUsedVars() {
+		return this.usedVars;
+	}
 
-  /**
-   * Gets the current go-to label for a "break" instruction.
-   * @return the current go-to label for a "break" instruction
-   */
-  public Label getBreakLabel()
-  {
-    return this.labelBreak;
-  }
+	/**
+	 * Gets the current go-to label for a "break" instruction.
+	 *
+	 * @return the current go-to label for a "break" instruction
+	 */
+	public Label getBreakLabel() {
+		return this.labelBreak;
+	}
 
-  /**
-   * Sets the current go-to label for a "break" instruction.
-   * @param labelBreak the current go-to label for a "break" instruction
-   * @return the original value
-   */
-  public Label setBreakLabel(Label labelBreak)
-  {
-    Label old = this.labelBreak;
-    this.labelBreak = labelBreak;
-    return old;
-  }
+	/**
+	 * Sets the current go-to label for a "break" instruction.
+	 *
+	 * @param labelBreak the current go-to label for a "break" instruction
+	 * @return the original value
+	 */
+	public Label setBreakLabel(Label labelBreak) {
+		Label old = this.labelBreak;
+		this.labelBreak = labelBreak;
+		return old;
+	}
 
-  /**
-   * Gets the current go-to label for a "continue" instruction.
-   * @return the current go-to label for a "continue" instruction
-   */
-  public Label getContinueLabel()
-  {
-    return this.labelContinue;
-  }
+	/**
+	 * Gets the current go-to label for a "continue" instruction.
+	 *
+	 * @return the current go-to label for a "continue" instruction
+	 */
+	public Label getContinueLabel() {
+		return this.labelContinue;
+	}
 
-  /**
-   * Sets the current go-to label for a "continue" instruction.
-   * @param labelBreak the current go-to label for a "continue" instruction
-   * @return the original value
-   */
-  public Label setContinueLabel(Label labelContinue)
-  {
-    Label old = this.labelContinue;
-    this.labelContinue = labelContinue;
-    return old;
-  }
+	/**
+	 * Sets the current go-to label for a "continue" instruction.
+	 *
+	 * @param labelBreak the current go-to label for a "continue" instruction
+	 * @return the original value
+	 */
+	public Label setContinueLabel(Label labelContinue) {
+		Label old = this.labelContinue;
+		this.labelContinue = labelContinue;
+		return old;
+	}
 
-  /**
-   * Adds a variable to the used variables list.
-   * @param var the variable to add
-   */
-  public void addUsedVar(Register var)
-  {
-    Integer key = Integer.valueOf(var.getIntegerValue());
-    if (this.usedVars.get(key) == null)
-      this.usedVars.put(key, var);
-  }
+	/**
+	 * Adds a variable to the used variables list.
+	 *
+	 * @param var the variable to add
+	 */
+	public void addUsedVar(Register var) {
+		Integer key = Integer.valueOf(var.getIntegerValue());
+		if (this.usedVars.get(key) == null) this.usedVars.put(key, var);
+	}
 
-  /**
-   * Gets the current code info.
-   * @return the current code info
-   */
-  public static CodeInfo getCurrent()
-  {
-    return current;
-  }
+	/**
+	 * Gets the current code info.
+	 *
+	 * @return the current code info
+	 */
+	public static CodeInfo getCurrent() {
+		return current;
+	}
 
-  /**
-   * Sets the current code info.
-   * @param codeInfo the current code info
-   */
-  public static void setCurrent(CodeInfo codeInfo)
-  {
-    current = codeInfo;
-  }
+	/**
+	 * Sets the current code info.
+	 *
+	 * @param codeInfo the current code info
+	 */
+	public static void setCurrent(CodeInfo codeInfo) {
+		current = codeInfo;
+	}
 }