chore: add nix derivation, update dependencies, readme (#82)

- add nix derivation
- update readme to reflect support status and new nuphy keyboards
- nodejs no longer required to build CLI
- remove all submodules and replace with `find_package` invocations in
CMake with `FetchContent` fallbacks

Author: donn

.github/workflows/ci.yml

@@ -39,7 +39,7 @@ jobs:
           path: ./nudelta-x64.exe.zip
   linux:
     name: Build (Linux)
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
       - name: Check out Git repository
         uses: actions/checkout@v4
@@ -113,7 +113,7 @@ jobs:
           path: ./nudelta-${{ matrix.os.arch }}.app.dmg
   publish:
     name: Publish
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
     needs: [macos, linux, windows]
     steps:
       - name: Check out Git repository

.gitignore

@@ -27,4 +27,5 @@ yarn-error.log
 !OSAcknowledgements.txt
 
 # Python
-venv
+venv
+result

.gitmodules

@@ -6,10 +6,6 @@ cmake_policy(SET CMP0042 NEW)
 
 project(nudelta)
 
-if(NOT DEFINED NODE_RUNTIME)
-        message( FATAL_ERROR "NODE_RUNTIME is not defined. Use `cmake-js` from the root of the repo." )
-endif()
-
 # Get version from package.json
 file(READ ${CMAKE_CURRENT_SOURCE_DIR}/package.json PACKAGE_JSON)
 string(JSON NUDELTA_VERSION GET ${PACKAGE_JSON} "version")
@@ -19,86 +15,78 @@ set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED True)
 set(CMAKE_POSITION_INDEPENDENT_CODE ON)
 set(BUILD_SHARED_LIBS FALSE)
-set(CMAKE_OSX_DEPLOYMENT_TARGET "11")
+set(CMAKE_OSX_DEPLOYMENT_TARGET "11.3")
 
 if(APPLE)
-        set(CMAKE_THREAD_LIBS_INIT "-lpthread")
-        set(CMAKE_HAVE_THREADS_LIBRARY 1)
-        set(CMAKE_USE_WIN32_THREADS_INIT 0)
-        set(CMAKE_USE_PTHREADS_INIT 1)
-        set(THREADS_PREFER_PTHREAD_FLAG ON)
+    set(CMAKE_THREAD_LIBS_INIT "-lpthread")
+    set(CMAKE_HAVE_THREADS_LIBRARY 1)
+    set(CMAKE_USE_WIN32_THREADS_INIT 0)
+    set(CMAKE_USE_PTHREADS_INIT 1)
+    set(THREADS_PREFER_PTHREAD_FLAG ON)
 endif()
 
-# Hidapi does not use `option`
-set(HIDAPI_WITH_LIBUSB FALSE)
-set(HIDAPI_WITH_HIDRAW TRUE)
-add_subdirectory(submodules/hidapi)
-
-option(YAML_CPP_BUILD_TOOLS OFF)
-add_subdirectory(submodules/yaml-cpp)
-
-add_subdirectory(submodules/scope_guard)
-
-add_subdirectory(submodules/fmt)
-
-add_subdirectory(submodules/ssco)
+# Dependencies
+include(third_party/CMakeLists.txt)
 
 # Common
 include_directories(include)
 
 # YAML Data
 file (GLOB_RECURSE yml_files "res/**/*.yml")
+find_program(RUBY_EXECUTABLE ruby)
+if(RUBY_EXECUTABLE)
+    message(STATUS "ruby found at: ${RUBY_EXECUTABLE}")
+else()
+    message(FATAL_ERROR "ruby not found in PATH and is required for an intermediate build step.")
+endif()
 add_custom_command(
-     OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/res.cpp
-     COMMAND node ${CMAKE_CURRENT_LIST_DIR}/util/res_to_cpp.js ${CMAKE_CURRENT_LIST_DIR}/res > ${CMAKE_CURRENT_BINARY_DIR}/res.cpp
-     DEPENDS ${yml_files} util/res_to_cpp.js
+    OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/res.cpp
+    COMMAND ${RUBY_EXECUTABLE} ${CMAKE_CURRENT_LIST_DIR}/util/res2cxx.rb ${CMAKE_CURRENT_LIST_DIR}/res > ${CMAKE_CURRENT_BINARY_DIR}/res.cpp
+    DEPENDS ${yml_files} util/res2cxx.rb
 )
 add_custom_target(res_file ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/res.cpp)
 
 include_directories(res)
 
 # libnd
+include_directories(${CMAKE_JS_INC})
 file(GLOB nudelta_lib_src "lib/*.cpp")
 add_library(nd ${nudelta_lib_src} ${CMAKE_CURRENT_BINARY_DIR}/res.cpp)
 add_dependencies(nd res_file)
+target_link_libraries(nd PUBLIC fmt)
 if (CMAKE_SYSTEM_NAME STREQUAL "Linux")
-        target_link_libraries(nd hidapi::hidraw)
+        target_link_libraries(nd PUBLIC hidapi::hidraw)
 else()
-        target_link_libraries(nd hidapi)
+        target_link_libraries(nd PUBLIC hidapi)
 endif()
-target_link_libraries(nd yaml-cpp)
-target_link_libraries(nd fmt)
-target_link_libraries(nd scope_guard)
+target_link_libraries(nd PRIVATE yaml-cpp)
+target_link_libraries(nd PRIVATE $<COMPILE_ONLY:scope_guard>)
 
 if(!MSVC)
   target_compile_options(nd -Wall -Wextra -Wpedantic -Werror)
 endif()
 
+if(DEFINED NODE_RUNTIME)
+    # node-libnd
+    add_definitions(-DNAPI_VERSION=4)
+    include_directories(${CMAKE_JS_INC})
+    include_directories(${CMAKE_SOURCE_DIR}/node_modules/node-addon-api)
+    include_directories(${CMAKE_SOURCE_DIR}/node_modules/node-api-headers/include)
 
-# node-libnd
-add_definitions(-DNAPI_VERSION=4)
-include_directories(${CMAKE_JS_INC})
-include_directories(${CMAKE_SOURCE_DIR}/node_modules/node-addon-api)
-include_directories(${CMAKE_SOURCE_DIR}/node_modules/node-api-headers/include)
-add_library(node-libnd SHARED src/node.cpp ${CMAKE_JS_SRC})
-target_link_libraries(node-libnd nd)
-target_link_libraries(node-libnd ${CMAKE_JS_LIB})
+    add_library(node-libnd SHARED src/node.cpp ${CMAKE_JS_SRC})
+    target_link_libraries(node-libnd nd)
+    target_link_libraries(node-libnd ${CMAKE_JS_LIB})
 
-set_target_properties(node-libnd PROPERTIES PREFIX "" SUFFIX ".node")
+    set_target_properties(node-libnd PROPERTIES PREFIX "" SUFFIX ".node")
+endif()
 
 # nudelta
-add_executable(nudelta src/main.cpp)
+add_executable(nudelta-cli src/main.cpp)
 add_compile_definitions(NUDELTA_VERSION="${CMAKE_PROJECT_VERSION}")
-target_link_libraries(nudelta nd)
-if (CMAKE_SYSTEM_NAME STREQUAL "Linux")
-        target_link_libraries(nudelta hidapi::hidraw)
-else()
-        target_link_libraries(nudelta hidapi)
-endif()
-target_link_libraries(nudelta yaml-cpp)
-target_link_libraries(nudelta fmt)
-target_link_libraries(nudelta ssco)
-target_link_libraries(nudelta scope_guard)
+target_link_libraries(nudelta-cli PUBLIC nd)
+target_link_libraries(nudelta-cli PRIVATE $<COMPILE_ONLY:scope_guard>)
+target_link_libraries(nudelta-cli PRIVATE ssco)
+
 
 
-install(TARGETS nudelta)
+install(TARGETS nudelta-cli)

CMakeLists.txt

@@ -1,3 +1,13 @@
+# 0.9.0
+
+This update has no functional changes to Nudelta itself.
+
+- Add Nix derivation
+- Update readme to reflect support status and status of new NuPhy keyboards
+- Nodejs no longer required to build CLI
+- Remove all submodules and replace with `find_package` invocations in CMake
+  with `FetchContent` fallbacks
+
 # 0.8.0
 - Build macOS architectures independently using both Intel and Apple Silicon Mac
   free GitHub Actions runners, rectifying a long-standing issue where writing

Changelog.md

@@ -1,7 +1,7 @@
 FROM quay.io/pypa/manylinux_2_28_x86_64
 
 # Dependencies
-## Python
+## CMake (pip is the most reliable option)
 RUN python3 -m ensurepip
 RUN python3 -m pip install --upgrade pip wheel
 RUN python3 -m pip install cmake
@@ -15,6 +15,9 @@ RUN npm i -g yarn
 ## LibUSB
 RUN yum install -y libudev-devel
 
+## Ruby
+RUN yum install -y ruby
+
 ##
 WORKDIR /nudelta
 COPY . .