From 071babf14824aee035dd6c3ddff1957662aa7c98 Mon Sep 17 00:00:00 2001
From: Vincent Ambo <tazjin@google.com>
Date: Sun, 24 Nov 2019 20:34:30 +0000
Subject: feat(example): Add an example for how to use buildGo builders

---
 example/default.nix | 43 +++++++++++++++++++++++++++++++++++++++++++
 example/lib.go      |  9 +++++++++
 example/main.go     | 22 ++++++++++++++++++++++
 example/thing.proto | 10 ++++++++++
 4 files changed, 84 insertions(+)
 create mode 100644 example/default.nix
 create mode 100644 example/lib.go
 create mode 100644 example/main.go
 create mode 100644 example/thing.proto

(limited to 'example')

diff --git a/example/default.nix b/example/default.nix
new file mode 100644
index 0000000000..407f550793
--- /dev/null
+++ b/example/default.nix
@@ -0,0 +1,43 @@
+# Copyright 2019 Google LLC.
+# SPDX-License-Identifier: Apache-2.0
+
+# This file provides examples for how to use the various builder
+# functions provided by `buildGo`.
+#
+# The features used in the example are not exhaustive, but should give
+# users a quick introduction to how to use buildGo.
+
+let
+  buildGo = import ../buildGo.nix {};
+
+  # Example use of buildGo.package, which creates an importable Go
+  # package from the specified source files.
+  examplePackage = buildGo.package {
+    name = "example";
+    srcs = [
+      ./lib.go
+    ];
+  };
+
+  # Example use of buildGo.proto, which generates a Go library from a
+  # Protobuf definition file.
+  exampleProto = buildGo.proto {
+    name = "exampleproto";
+    proto = ./thing.proto;
+  };
+
+  # Example use of buildGo.program, which builds an executable using
+  # the specified name and dependencies (which in turn must have been
+  # created via buildGo.package etc.)
+in buildGo.program {
+  name = "example";
+
+  srcs = [
+    ./main.go
+  ];
+
+  deps = [
+    examplePackage
+    exampleProto
+  ];
+}
diff --git a/example/lib.go b/example/lib.go
new file mode 100644
index 0000000000..8a61370e99
--- /dev/null
+++ b/example/lib.go
@@ -0,0 +1,9 @@
+// Copyright 2019 Google LLC.
+// SPDX-License-Identifier: Apache-2.0
+
+package example
+
+// UUID returns a totally random, carefully chosen UUID
+func UUID() string {
+	return "3640932f-ad40-4bc9-b45d-f504a0f5910a"
+}
diff --git a/example/main.go b/example/main.go
new file mode 100644
index 0000000000..1db1bb9e23
--- /dev/null
+++ b/example/main.go
@@ -0,0 +1,22 @@
+// Copyright 2019 Google LLC.
+// SPDX-License-Identifier: Apache-2.0
+//
+// Package main provides a tiny example program for the Bazel-style
+// Nix build system for Go.
+
+package main
+
+import (
+	"example"
+	"exampleproto"
+	"fmt"
+)
+
+func main() {
+	thing := exampleproto.Thing{
+		Id:          example.UUID(),
+		KindOfThing: "test thing",
+	}
+
+	fmt.Printf("The thing is a %s with ID %q\n", thing.Id, thing.KindOfThing)
+}
diff --git a/example/thing.proto b/example/thing.proto
new file mode 100644
index 0000000000..0cb34124df
--- /dev/null
+++ b/example/thing.proto
@@ -0,0 +1,10 @@
+// Copyright 2019 Google LLC.
+// SPDX-License-Identifier: Apache-2.0
+
+syntax = "proto3";
+package exampleProto;
+
+message Thing {
+  string id = 1;
+  string kind_of_thing = 2;
+}
-- 
cgit 1.4.1