visualify/flake.nix at main · freelock/visualify · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
{
  description = "Visualify - Visual Regression Testing Tool";

  inputs = {
    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
    flake-utils.url = "github:numtide/flake-utils";
  };

  outputs = { self, nixpkgs, flake-utils }:
    flake-utils.lib.eachDefaultSystem (system:
      let
        pkgs = nixpkgs.legacyPackages.${system};

        # Proper Node.js package
        visualify-package = pkgs.buildNpmPackage {
          pname = "visualify";
          version = "1.0.0";
          src = ./.;

          npmDepsHash = "sha256-pnBazJI3DnJ25BCv1vqPkpghrRxjr8GcYa0GYnvQKRY=";

          # Skip download of Puppeteer's Chromium
          PUPPETEER_SKIP_CHROMIUM_DOWNLOAD = "1";
          PUPPETEER_SKIP_DOWNLOAD = "1";

          # Skip npm build since there's no build script
          dontNpmBuild = true;

          # Build dependencies for sharp
          nativeBuildInputs = with pkgs; [
            pkg-config
            python3
            makeWrapper
          ];

          buildInputs = with pkgs; [
            vips
            glib
            libgsf
            fftw
            orc
            lcms2
            imagemagick
          ];

          # Configure sharp to use system libvips
          preBuild = ''
            export SHARP_IGNORE_GLOBAL_LIBVIPS=0
            export PKG_CONFIG_PATH="${pkgs.vips}/lib/pkgconfig:$PKG_CONFIG_PATH"
          '';

          postInstall = ''
            # Create wrapper script
            makeWrapper ${pkgs.nodejs_20}/bin/node $out/bin/visualify \
              --add-flags "$out/lib/node_modules/visualify/index.js" \
              --set PUPPETEER_SKIP_CHROMIUM_DOWNLOAD 1 \
              --run 'export VISUALIFY_ORIGINAL_CWD="$PWD"'
          '';
        };

        # Simple Node.js script wrapper for development
        visualify-dev = pkgs.writeShellScriptBin "visualify" ''
          export PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=1
          export VISUALIFY_ORIGINAL_CWD="$PWD"
          cd ${toString ./.}
          exec ${pkgs.nodejs_20}/bin/node index.js "$@"
        '';

      in {
        packages = {
          default = visualify-package;
          visualify = visualify-package;
          visualify-dev = visualify-dev;
        };

        # Override for nix-shell -p usage
        legacyPackages = {
          visualify = visualify-package;
        };

        # Development shell with visualify command available
        devShells.default = pkgs.mkShell {
          buildInputs = with pkgs; [
            nodejs_20
            visualify-package
          ];

          shellHook = ''
            echo "Visualify development environment"
            echo "Available commands:"
            echo ""
            echo "URL-based workflow:"
            echo "  visualify capture   - Take screenshots of websites"
            echo "  visualify compare   - Compare captured screenshots"
            echo "  visualify thumbnail - Generate thumbnails"
            echo "  visualify gallery   - Create HTML result gallery"
            echo "  visualify all       - Run all URL-based steps"
            echo ""
            echo "Directory-based workflow (for Behat/existing screenshots):"
            echo "  visualify compare-dirs   - Compare two directories of screenshots"
            echo "  visualify thumbnail-dirs - Generate thumbnails from directories"
            echo "  visualify gallery-dirs   - Create HTML gallery from directories"
            echo ""
            echo "Testing:"
            echo "  npm test            - Run unit tests"
            echo "  npm run test:watch  - Run tests in watch mode"
            echo ""
            echo "Using system Chrome/Chromium browser"
            echo "Make sure Chrome or Chromium is installed on your system"

            # Install dependencies if needed
            if [ ! -d "node_modules" ]; then
              echo "Installing npm dependencies..."
              npm install
            fi
          '';

          # Environment variables for Puppeteer to use system Chrome
          PUPPETEER_SKIP_CHROMIUM_DOWNLOAD = "1";
        };

        # Application for nix run
        apps.default = {
          type = "app";
          program = "${visualify-package}/bin/visualify";
        };
      }
    );
}