feat!: auto-generate from palette.json (#3)

This commit rewrites the library to be generated from
the palette.json which acts as a source of truth.

The project is now a multi-module maven project, with
the "processing" module responsible for generating the
code used in the "palette" module. Both modules will be
published to Maven Central and available as separate
JARs.

Co-authored-by: sgoudham <[email protected]>

Author: nullishamy

.envrc

@@ -0,0 +1 @@
+use flake;

.github/workflows/build.yml

@@ -18,12 +18,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup Java
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4
         with:
-          distribution: 'temurin'
+          distribution: 'adopt'
           java-version: '8'
           cache: 'maven'
 
@@ -33,25 +33,14 @@ jobs:
       - name: Test
         run: mvn test
 
-      - name: Retrieve Name & Version
-        run: |
-          echo "VERSION=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout)" >> $GITHUB_ENV
-          echo "NAME=$(mvn help:evaluate -Dexpression=project.name -q -DforceStdout)" >> $GITHUB_ENV
-
-      - name: Archive Jar
-        uses: actions/upload-artifact@v3
-        with:
-          name: ${{ env.NAME }}-${{ env.VERSION }}.jar
-          path: ./target/${{ env.NAME }}-${{ env.VERSION }}.jar
-
-      - name: Archive Javadoc
-        uses: actions/upload-artifact@v3
+      - name: Archive Palette Artifacts
+        uses: actions/upload-artifact@v4
         with:
-          name: ${{ env.NAME }}-${{ env.VERSION }}-javadoc.jar
-          path: ./target/${{ env.NAME }}-${{ env.VERSION }}-javadoc.jar
+          name: palette-jars
+          path: ./palette/target/*.jar
 
-      - name: Archive Sources
-        uses: actions/upload-artifact@v3
+      - name: Archive Processing Artifacts
+        uses: actions/upload-artifact@v4
         with:
-          name: ${{ env.NAME }}-${{ env.VERSION }}-sources.jar
-          path: ./target/${{ env.NAME }}-${{ env.VERSION }}-sources.jar
+          name: processing-jars
+          path: ./processing/target/*.jar

.github/workflows/deploy.yml

@@ -10,12 +10,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup Java
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4
         with:
-          distribution: 'temurin'
+          distribution: 'adopt'
           java-version: '8'
           cache: 'maven'
           server-id: ossrh
@@ -34,33 +34,10 @@ jobs:
           MAVEN_GPG_PASSPHRASE: ${{ secrets.MAVEN_GPG_PASSPHRASE }}
         run: mvn -B -DskipTests deploy
 
-      - name: Get Name & Version
-        run: |
-          echo "VERSION=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout)" >> $GITHUB_ENV
-          echo "NAME=$(mvn help:evaluate -Dexpression=project.name -q -DforceStdout)" >> $GITHUB_ENV
-
-      - name: Archive Jar
-        uses: actions/upload-artifact@v3
-        with:
-          name: ${{ env.NAME }}-${{ env.VERSION }}.jar
-          path: ./target/${{ env.NAME }}-${{ env.VERSION }}.jar
-
-      - name: Archive Javadoc
-        uses: actions/upload-artifact@v3
-        with:
-          name: ${{ env.NAME }}-${{ env.VERSION }}-javadoc.jar
-          path: ./target/${{ env.NAME }}-${{ env.VERSION }}-javadoc.jar
-
-      - name: Archive Sources
-        uses: actions/upload-artifact@v3
-        with:
-          name: ${{ env.NAME }}-${{ env.VERSION }}-sources.jar
-          path: ./target/${{ env.NAME }}-${{ env.VERSION }}-sources.jar
-
       - name: Create Release
         uses: ncipollo/release-action@v1
         with:
-          artifacts: target/*.jar
+          artifacts: "palette/target/*.jar,processing/target/*.jar"
           generateReleaseNotes: true
           makeLatest: true
           draft: true

.gitignore

@@ -33,3 +33,5 @@ build/
 
 ### Mac OS ###
 .DS_Store
+
+.direnv/

CONTRIBUTING.md

@@ -0,0 +1,9 @@
+## Project layout
+
+This project uses the Maven Multi Module system to build the various modules. There is the main module, the palette,
+which depends on the secondary module 'processing', to do the code generation based on our `palette.json`.
+The multi module system is used as it is the easiest way to get our processing module to build at the same time, and then get used
+by, the palette module. This also has the benefit of allowing us to publish the processing module independently.
+
+The `palette.json` is vendored for simplicity, and must be manually updated if/when it changes.
+

README.md

@@ -53,24 +53,24 @@ package com.catppuccin;
 
 public class Main {
   public static void main(String[] args) {
-    String mocha = Palette.MOCHA.getName(); // mocha
-    String mochaBaseHex = Palette.MOCHA.getBase().getHex(); // 1e1e2e
-    int[] mochaBaseRGB = Palette.MOCHA.getBase().getRGBComponents(); // [30, 30, 46]
+    String mocha = Palette.MOCHA.name(); // mocha
+    String mochaBaseHex = Palette.MOCHA.base().hex(); // 1e1e2e
+    int[] mochaBaseRGB = Palette.MOCHA.base().components(); // [30, 30, 46]
 
     // loop through just frappé
     for (Pair<String, Color> colourPair : Palette.FRAPPE.toList()) {
-      String name = colourPair.getKey();
-      Color colour = colourPair.getValue();
-      System.out.println(name + ": " + colour.getHex());
+      String name = colourPair.key();
+      Color colour = colourPair.value();
+      System.out.println(name + ": " + colour.hex());
     }
 
     // loop through every colour
     for (Flavour flavour : Palette.toList()) {
-      System.out.println("Flavour: " + flavour.getName());
+      System.out.println("Flavour: " + flavour.name());
       for (Pair<String, Color> colourPair : flavour.toList()) {
-        String name = colourPair.getKey();
-        Color colour = colourPair.getValue();
-        System.out.println(name + ": " + colour.getHex());
+        String name = colourPair.key();
+        Color colour = colourPair.value();
+        System.out.println(name + ": " + colour.hex());
       }
     }
   }
@@ -82,35 +82,10 @@ public class Main {
 If you are looking to contribute, please read through our
 [CONTRIBUTING.md](https://github.com/catppuccin/.github/blob/main/CONTRIBUTING.md) first!
 
-### Development
-
-This project uses the build tool [Maven](https://maven.apache.org/) from the java ecosystem. It is *highly* recommended
-to develop using [Intellij IDEA](https://www.jetbrains.com/idea/) as it will allow you to take advantage of its
-integration with maven tooling.
-
-The project can be built using the command:
-
-```shell
-./mvnw clean package
-```
-
-and running tests is as simple as:
-
-```shell
-./mvnw test
-```
-
-A great 5-minute introduction to Maven can be
-found [here](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html).
-
-### CI / CD
-
-This project has a GitHub actions workflow to automatically build binaries and deploy to maven central. The workflows
-are stored at [.github/workflows](.github/workflows)
-
 ## 💝 Thanks to
 
 - [Hamothy](https://github.com/sgoudham)
+- [nullishamy](https://github.com/nullishamy)
 
 &nbsp;
 

assets/.gitkeep

@@ -0,0 +1,27 @@
+{
+  description = "A devShell example";
+
+  inputs = {
+    nixpkgs.url      = "github:NixOS/nixpkgs/nixos-unstable";
+    rust-overlay.url = "github:oxalica/rust-overlay";
+    flake-utils.url  = "github:numtide/flake-utils";
+  };
+
+  outputs = { self, nixpkgs, rust-overlay, flake-utils, ... }:
+    flake-utils.lib.eachDefaultSystem (system:
+      let
+        overlays = [ (import rust-overlay) ];
+        pkgs = import nixpkgs {
+          inherit system overlays;
+        };
+      in
+      with pkgs;
+      {
+        devShell = mkShell {
+          buildInputs = [
+            openjdk11-bootstrap
+          ];
+        };
+      }
+    );
+}