BirdeeHub
diff --git a/‎.github/workflows/deploy-website.yml‎
Lines changed: 42 additions & 0 deletions b/‎.github/workflows/deploy-website.yml‎
Lines changed: 42 additions & 0 deletions
diff --git a/‎.github/workflows/test.yml‎
Lines changed: 13 additions & 0 deletions b/‎.github/workflows/test.yml‎
Lines changed: 13 additions & 0 deletions
diff --git a/‎.gitignore‎
Lines changed: 3 additions & 0 deletions b/‎.gitignore‎
Lines changed: 3 additions & 0 deletions
diff --git a/‎CONTRIBUTING.md‎
Lines changed: 139 additions & 0 deletions b/‎CONTRIBUTING.md‎
Lines changed: 139 additions & 0 deletions
@@ -0,0 +1,42 @@
+name: update-website
+on:
+  workflow_dispatch: # allows manual triggering
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v5
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Install Nix
+        uses: DeterminateSystems/nix-installer-action@main
+      - name: Update Site
+        run: |
+          mkdir -p ./_site
+          nix run --show-trace ./docs -- ./_site
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v4
+        with:
+          path: ./_site
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
+        with:
+          token: ${{ secrets.PAT }}
@@ -14,6 +14,19 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Merge main into PR branch
+        if: github.event_name == 'pull_request'
+        run: |
+          git config user.name "GitHub Actions"
+          git config user.email "actions@github.com"
+          git fetch origin main
+          if ! git merge origin/main; then
+            echo "Merge failed due to conflicts. Please rebase your branch on main."
+            exit 1
+          fi
 
       - name: Install Nix
         uses: DeterminateSystems/nix-installer-action@main
 
@@ -0,0 +1,3 @@
+**/result
+**/result-*
+**/repl-result-*
@@ -0,0 +1,139 @@
+# Adding modules!
+
+Please add some modules to the `modules/` directory to help everyone out!
+
+That way, your module can be available for others to enjoy as well!
+
+When making one, you must define a `modules/<first_letter>/<your_package_name>/module.nix` file
+
+It must contain a single, unevaluated module.
+
+All options must have descriptions, so that documentation can be generated and people can know how to use it!
+
+All modules must have a `meta.maintainers = [];` entry.
+
+## Guidelines:
+
+When making options for your module, if you are able, please provide both nix-generated, and `wlib.types.file` or `lib.types.lines` options
+
+If you are not able to provide both, default to `wlib.types.file` unless it is `JSON` or something else which does not append nicely, but do try to provide both options.
+
+When you provide a `wlib.types.file` option, you should try to name it as close to the filename as possible, if that makes sense.
+
+Example:
+
+```nix
+{
+  config,
+  lib,
+  wlib,
+  ...
+}:
+{
+  imports = [ wlib.modules.default ];
+  options = {
+    "wezterm.lua" = lib.mkOption {
+      type = wlib.types.file config.pkgs;
+      default.content = "return require('nix-info')";
+      description = "The wezterm config file. provide `.content`, or `.path`";
+    };
+    luaInfo = lib.mkOption {
+      type = lib.types.attrsOf lib.types.raw;
+      default = { };
+      description = ''
+        anything other than uncalled nix functions can be put into this option, 
+        within your `"wezterm.lua"`, you will be able to call `require('nix-info')`
+        and get the values as lua values
+
+        the default `"wezterm.lua"` value is `return require('nix-info')`
+
+        This means, by default, this will act like your wezterm config file, unless you want to add some lua in between there.
+      '';
+    };
+  };
+
+  config.flagSeparator = "=";
+  config.flags = {
+    "--config-file" = config.pkgs.writeText "wezterm.lua" ''
+      local wezterm = require 'wezterm'
+      package.preload["nix-info"] = function() return ${
+        lib.generators.toLua { } config.luaInfo
+      } end
+      return dofile(${builtins.toJSON config."wezterm.lua".path})
+    '';
+  };
+
+  config.package = lib.mkDefault config.pkgs.wezterm;
+
+  config.meta.maintainers = [ lib.maintainers.birdee ];
+}
+```
+
+# Formatting
+
+`nix fmt`
+
+# Tests
+
+`nix flake check -Lv .`
+
+# Writing tests
+
+You may also include a `check.nix` file in your module's directory.
+
+It will be provided with the flake `self` value and `pkgs`
+
+Example:
+
+```nix
+{
+  pkgs,
+  self,
+}:
+let
+  weztermWrapped = self.wrapperModules.wezterm.wrap (
+    { lib, ... }:
+    {
+      inherit pkgs;
+      luaInfo = {
+        keys = [
+          {
+            key = "F12";
+            mods = "SUPER|CTRL|ALT|SHIFT";
+            action = lib.generators.mkLuaInline "wezterm.action.Nop";
+          }
+        ];
+      };
+      "wezterm.lua".content = # lua
+        ''
+          local wezterm = require 'wezterm'
+          local config = require 'nix-info'
+          config.keys[2] = {
+            key = 'F13',
+            mods = 'SUPER|CTRL|ALT|SHIFT',
+            action = wezterm.action.Nop,
+          }
+          return config
+        '';
+    }
+  );
+in
+pkgs.runCommand "wezterm-test" { } ''
+  res=$("${weztermWrapped}/bin/wezterm" show-keys)
+  if ! echo "$res" | grep -q "SHIFT | ALT | CTRL | SUPER   F12"; then
+    echo "Wezterm doesn't see custom keybind 1"
+    touch $out
+    exit 1
+  fi
+  if ! echo "$res" | grep -q "SHIFT | ALT | CTRL | SUPER   F13"; then
+    echo "Wezterm doesn't see custom keybind 2"
+    touch $out
+    exit 1
+  fi
+  touch $out
+''
+```
+
+# Questions?
+
+The github discussions board is open and a great place to find help!
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+**/result`
	`2`	`+*/result-`
	`3`	`+*/repl-result-`