template: add zig project

Author: smoothprogrammer

template/zig/.editorconfig

@@ -0,0 +1,26 @@
+; https://editorconfig.org
+root = true
+
+; default configuration
+[*]
+charset = utf-8
+end_of_line = lf
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = unset
+
+[{*.nix,flake.lock}]
+indent_style = space
+indent_size = 2
+
+[*.{yml,yaml}]
+indent_style = space
+indent_size = 2
+
+[*.md]
+indent_style = space
+indent_size = 2
+
+[*.zig]
+indent_style = space
+indent_size = 4

template/zig/.envrc

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

template/zig/.github/workflows/main.yaml

@@ -0,0 +1,27 @@
+name: main
+on:
+  pull_request:
+    branches: [main]
+  push:
+    branches: [main]
+env:
+  CI_NIX_STORE: ~/nix
+  CI_NIX_FLAKE: .#default
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup Nix
+        uses: cachix/install-nix-action@v26
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Cache Nix
+        uses: actions/cache@v4
+        with:
+          path: ${{ env.CI_NIX_STORE }}
+          key: ${{ runner.os }}-nix-${{ hashFiles('flake.nix', 'flake.lock') }}
+      - name: Lint
+        run: |
+          nix --store ${{ env.CI_NIX_STORE }} \
+            develop ${{ env.CI_NIX_FLAKE }} --command \
+            editorconfig-checker && echo "ok"

template/zig/.gitignore

@@ -0,0 +1,4 @@
+# https://github.com/github/gitignore/blob/main/Zig.gitignore
+
+.zig-cache/
+zig-out/

template/zig/Makefile

@@ -0,0 +1,4 @@
+test:
+	@zig build test
+run:
+	@zig build run

template/zig/README.md

@@ -0,0 +1 @@
+# Zig Project

template/zig/build.zig

@@ -0,0 +1,29 @@
+const std = @import("std");
+
+pub fn build(b: *std.Build) void {
+    const target = b.standardTargetOptions(.{});
+    const optimize = b.standardOptimizeOption(.{});
+
+    const exe = b.addExecutable(.{
+        .name = "zigproject",
+        .root_source_file = b.path("src/main.zig"),
+        .target = target,
+        .optimize = optimize,
+    });
+
+    b.installArtifact(exe);
+
+    const run_exe = b.addRunArtifact(exe);
+    const run_step = b.step("run", "Run the application");
+    run_step.dependOn(&run_exe.step);
+
+    const unit_tests = b.addTest(.{
+        .root_source_file = b.path("src/main.zig"),
+        .target = target,
+        .optimize = optimize,
+    });
+
+    const run_unit_tests = b.addRunArtifact(unit_tests);
+    const test_step = b.step("test", "Run unit tests");
+    test_step.dependOn(&run_unit_tests.step);
+}

template/zig/flake.lock

@@ -0,0 +1,32 @@
+{
+  description = "Zig Project";
+
+  inputs.nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";
+
+  outputs =
+    { nixpkgs, ... }:
+    let
+      forAllSystems = nixpkgs.lib.genAttrs nixpkgs.lib.systems.flakeExposed;
+    in
+    {
+      devShells = forAllSystems (
+        system:
+        let
+          pkgs = nixpkgs.legacyPackages.${system};
+        in
+        {
+          default = pkgs.mkShell {
+            name = "zig-project";
+            shellHook = ''
+              git config pull.rebase true
+              ${pkgs.neo-cowsay}/bin/cowsay -f sage "Zig Project"
+            '';
+            buildInputs = with pkgs; [
+              editorconfig-checker
+              zig
+            ];
+          };
+        }
+      );
+    };
+}

template/zig/flake.nix

@@ -0,0 +1,13 @@
+const std = @import("std");
+
+fn greet() []const u8 {
+    return "Hello, World!";
+}
+
+pub fn main() !void {
+    std.debug.print("{s}\n", .{greet()});
+}
+
+test "greet" {
+    try std.testing.expectEqualStrings("Hello, World!", greet());
+}