support nix and nixos

Author: donn

.gitignore

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

CMakeLists.txt

@@ -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")
@@ -22,11 +18,11 @@ set(BUILD_SHARED_LIBS FALSE)
 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()
 
 # Dependencies
@@ -37,57 +33,64 @@ 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)
 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 fmt)
+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)
+target_link_libraries(nudelta-cli PUBLIC nd)
 if (CMAKE_SYSTEM_NAME STREQUAL "Linux")
-        target_link_libraries(nudelta hidapi::hidraw)
+    target_link_libraries(nudelta-cli PUBLIC hidapi::hidraw)
 else()
-        target_link_libraries(nudelta hidapi)
+    target_link_libraries(nudelta-cli PUBLIC 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 PRIVATE ssco)
+
 
 
-install(TARGETS nudelta)
+install(TARGETS nudelta-cli)

Dockerfile

@@ -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 . .

Readme.md

@@ -49,13 +49,14 @@ Contributions are super appreciated for all of these.
 * macOS 11.3+ or higher (Intel or Apple Silicon)
 * Linux 2.6.39 or higher with glibc 2.17 or higher.
 
-### Build Requirements
+### Build/Development Requirements
 
 * C++17 Compiler
     * Clang recommended for macOS/Linux
     * MSVC recommended for Windows
 * CMake
 * Node 22+ with Yarn
+* Ruby 2.0.0+ (glue scripts)
 
 ## Build
 
@@ -65,15 +66,31 @@ cd nudelta
 git submodule update --init --recursive
 rm -rf build
 yarn
-yarn build-native # CLI / Library
+yarn build_native # CLI / Library
 yarn build # GUI
 ```
 
 The Linux AppImage will be found under ./dist, and the Mac app will be found under ./dist/mac.
 
+### Nix
+
+If you have Nix on either macOS or Linux, you can build and run nudelta
+using `nix run github:donn/nudelta`.
+
+On NixOS, you will need to add the requisite udev rule as follows:
+
+```nix
+services.udev.extraRules = ''
+  # Hidraw for Seated Users (This rule requires a reboot)
+  KERNEL=="hidraw*", SUBSYSTEM=="hidraw", TAG+="uaccess"
+'';
+```
+
 ## Using the CLI
 
-You will need to use **sudo** on Linux. On macOS, you will need to grant Input Monitoring permissions to whichever Terminal host you're using to run Nudelta, likely Terminal.app.
+You may need to use **sudo** on Linux. On macOS, you will need to grant Input
+Monitoring permissions to whichever Terminal host you're using to run Nudelta,
+likely Terminal.app.
 
 No special permissions are required on Windows as far as I can tell.
 

default.nix

@@ -1,20 +1,22 @@
 {
   src ? ./.,
   lib,
-  nodejs,
-  electron,
   yarnConfigHook,
   yarnBuildHook,
   fetchYarnDeps,
   fetchFromGitHub,
   cmake,
-  clangStdenv,
-  zip,
   pkg-config,
-  udev,
+  ruby,
+  makeWrapper,
+  clangStdenv,
+  nodejs,
+  electron,
   fmt_11,
   yaml-cpp,
   hidapi,
+  ssco,
+  scope_guard,
 }:
 clangStdenv.mkDerivation {
   name = "nudelta";
@@ -23,12 +25,13 @@ clangStdenv.mkDerivation {
 
   nativeBuildInputs = [
     yarnConfigHook
-    yarnBuildHook
     cmake
     pkg-config
+    ruby
+    makeWrapper
   ];
-  
-  buildInputs = [fmt_11 yaml-cpp hidapi] ++ lib.optionals clangStdenv.isLinux [udev];
+
+  buildInputs = [fmt_11 yaml-cpp hidapi ssco scope_guard];
 
   dontUseCmakeConfigure = true;
 
@@ -41,22 +44,25 @@ clangStdenv.mkDerivation {
   };
 
   env = {
-    ELECTRON_SKIP_BINARY_DOWNLOAD = "1";
     NIX_CFLAGS_COMPILE = "-I${nodejs.dev}/include/node";
   };
 
-  preBuild = ''
+  buildPhase = ''
+    runHook preBuild
+
     substituteInPlace node_modules/cmake-js/lib/dist.js \
         --replace-fail '!this.downloaded' 'false'
     cp -R ${electron.dist} electron_dist
     chmod -R u+w electron_dist
-  '';
 
-  buildPhase = ''
-    runHook preBuild
-    yarn build-native
-    yarn build-ui
-    yarn electron-builder \
+    substituteInPlace  node_modules/.bin/rollup \
+      --replace-fail "#!/usr/bin/env node" "#!${nodejs}/bin/node"
+    substituteInPlace  node_modules/.bin/electron-builder \
+      --replace-fail "#!/usr/bin/env node" "#!${nodejs}/bin/node"
+
+    yarn build_native
+    yarn run rollup -c
+    yarn run electron-builder \
         --dir \
         -c.electronDist=electron_dist \
         -c.electronVersion=${electron.version}
@@ -67,7 +73,7 @@ clangStdenv.mkDerivation {
     ''
       runHook preInstall
       mkdir -p $out/bin
-      cp -r build/nudelta $out/bin/nudelta-cli
+      cp -r build/nudelta-cli $out/bin/nudelta-cli
     ''
     + lib.optionalString clangStdenv.isDarwin ''
       mkdir -p $out/Applications
@@ -76,13 +82,7 @@ clangStdenv.mkDerivation {
     ''
     + lib.optionalString clangStdenv.isLinux ''
       mkdir -p "$out/share/nudelta"
-      cp -r pack/*-unpacked/{locales,resources{,.pak}} "$out/share/nudelta"
-
-      pushd assets/generated/icons/png
-      for file in *.png; do
-        install -Dm0644 $file $out/share/icons/hicolor/''${file//.png}/apps/nudelta.png
-      done
-      popd
+      cp -r dist/*-unpacked/{locales,resources{,.pak}} "$out/share/nudelta"
     '';
 
   postFixup = lib.optionalString clangStdenv.isLinux ''

flake.nix

@@ -15,6 +15,8 @@
       default = pkgs': pkgs: let
         callPackage = lib.callPackageWith pkgs';
       in {
+        scope_guard = callPackage ./nix/scope_guard.nix {};
+        ssco = callPackage ./nix/ssco.nix {};
         nudelta = callPackage ./default.nix {src = self;};
       };
     };

nix/scope_guard.nix

@@ -0,0 +1,27 @@
+{
+  lib,
+  stdenv,
+  fetchFromGitHub,
+  cmake,
+}:
+stdenv.mkDerivation (finalAttrs: {
+  pname = "scope_guard";
+  version = "0.9.1";
+
+  src = fetchFromGitHub {
+    owner = "Neargye";
+    repo = "scope_guard";
+    rev = "v${finalAttrs.version}";
+    sha256 = "sha256-Bs8dr5t9LQ6FyM6btpDBAEvyiKoCF2H99RRFAQfx7/I=";
+  };
+
+  nativeBuildInputs = [cmake];
+
+  meta = {
+    homepage = "https://github.com/neargye/scope_guard";
+    description = "Scope Guard & Defer C++11 Library";
+    license = lib.licenses.mit;
+    # maintainers = [ lib.maintainers.donn ];
+    platforms = lib.platforms.all;
+  };
+})

nix/ssco.nix

@@ -0,0 +1,27 @@
+{
+  lib,
+  stdenv,
+  fetchFromGitHub,
+  cmake,
+}:
+stdenv.mkDerivation (attrs': {
+  pname = "ssco";
+  version = "3.0.0";
+
+  src = fetchFromGitHub {
+    owner = "donn";
+    repo = "ssco";
+    rev = "v${attrs'.version}";
+    sha256 = "sha256-qEKMoBRj6jp3x/MIij+Je5QNFm66WueebNzDdWu37iY=";
+  };
+
+  nativeBuildInputs = [cmake];
+
+  meta = {
+    homepage = "https://github.com/donn/ssco";
+    description = "Tiny Commandline Processing Library for C++17";
+    license = lib.licenses.mit;
+    # maintainers = [ lib.maintainers.donn ];
+    platforms = lib.platforms.all;
+  };
+})

package.json

@@ -1,7 +1,7 @@
 {
     "name": "nudelta",
     "author": "Mohamed Gaber <me@donn.website>",
-    "version": "0.9.0",
+    "version": "0.10.0",
     "license": "GPL-3.0-or-later",
     "homepage": "https://github.com/donn/nudelta#readme",
     "description": "An open-source alternative to the NuPhy Console",
@@ -11,11 +11,11 @@
         "yaml": "^2.1.3"
     },
     "scripts": {
-        "build": "yarn build-native && yarn build-ui && electron-builder --publish never",
-        "build-native": "node util/build-native.js",
-        "build-ui": "rollup -c",
-        "watch": "nodemon --ext .js,.mjs,.cjs,.css --ignore ui/app-dist/ --exec sh -c \"yarn build-ui && electron .\"",
-        "watch-win": "nodemon --ext .js,.mjs,.cjs,.css --ignore ui/app-dist/ --exec cmd /c \"yarn build-ui && electron .\"",
+        "build": "yarn build_native && yarn build_ui && electron-builder --publish never",
+        "build_native": "node util/build_native.js",
+        "build_ui": "rollup -c",
+        "watch": "nodemon --ext .js,.mjs,.cjs,.css --ignore ui/app-dist/ --exec sh -c \"yarn build_ui && electron .\"",
+        "watch_win": "nodemon --ext .js,.mjs,.cjs,.css --ignore ui/app-dist/ --exec cmd /c \"yarn build_ui && electron .\"",
         "format": "prettier --write . && clang-format -i include/*.hpp lib/*.cpp src/*.cpp",
         "lint": "prettier --check . && clang-format --dry-run --Werror include/*.hpp lib/*.cpp src/*.cpp",
         "compile_licenses": "node util/compile_licenses.js"