Add JSON description file

This allows to fetch the available documentations.

Author: tintou

.github/workflows/ci.yml

@@ -61,6 +61,7 @@ jobs:
         libgee-0.8-dev \
         git \
         libguestfs-gobject-dev \
+        libjson-glib-dev \
         libvaladoc-0.58-dev \
         php \
         php-curl \

.github/workflows/publish.yml

@@ -34,6 +34,7 @@ jobs:
           libgee-0.8-dev \
           git \
           libguestfs-gobject-dev \
+          libjson-glib-dev \
           libvaladoc-0.58-dev \
           php \
           php-curl \

Makefile

@@ -52,7 +52,7 @@ libdoclet.so: src/doclet.vala src/linkhelper.vala
 	$(RM) $(patsubst %.vala,%.c,$^)
 
 
-GENERATOR_DEPS = gee-0.8 valadoc-$(VALAC_VERSION) gio-2.0
+GENERATOR_DEPS = gee-0.8 valadoc-$(VALAC_VERSION) gio-2.0 json-glib-1.0
 GENERATOR_VALAFLAGS := $(patsubst %,--pkg=%,$(GENERATOR_DEPS)) --enable-experimental
 
 generator: src/doclet.vala src/linkhelper.vala src/generator.vala

README.md

@@ -18,7 +18,7 @@ On elementary OS or Ubuntu run:
 ```bash
 sudo add-apt-repository ppa:vala-team
 sudo apt update
-sudo apt install valac valadoc libvaladoc-dev unzip php php-curl
+sudo apt install valac valadoc libvaladoc-dev libjson-glib-dev unzip php php-curl 
 ```
 
 Arch or derivatives run:

src/generator.vala

@@ -723,6 +723,45 @@ public class Valadoc.IndexGenerator : Valadoc.ValadocOrgDoclet {
 		generate_index (path + ".content.tpl");
 	}
 
+	public void generate_json (string path) {
+		stdout.printf ("generate JSON ...\n");
+
+		string json_path = Path.build_filename (path, "packages.json");
+
+		var builder = new Json.Builder ();
+
+		builder.begin_object ();
+		builder.set_member_name ("books");
+		builder.begin_array ();
+		Gee.ArrayList<Package> packages = get_sorted_package_list ();
+		foreach (Package pkg in packages) {
+			if (!pkg.is_local || regenerate_all_packages || pkg.name in requested_packages) {
+				builder.begin_object ();
+				builder.set_member_name ("name");
+				builder.add_string_value (pkg.name);
+				builder.set_member_name ("description");
+				builder.add_string_value (string.joinv ("\n", pkg.description));
+				if (pkg.devhelp_link != null) {
+					builder.set_member_name ("book_path");
+					builder.add_string_value (pkg.devhelp_link);
+				}
+				builder.end_object ();
+			}
+		}
+		builder.end_array ();
+		builder.end_object ();
+
+		var generator = new Json.Generator ();
+		Json.Node root = builder.get_root ();
+		generator.set_root (root);
+		try {
+			generator.to_file (json_path);
+		} catch (Error e) {
+			stderr.printf ("%s\n", e.message);
+			has_error = true;
+		}
+	}
+
 	public void regenerate_all_known_packages () throws Error {
 		foreach (var pkg in packages_per_name.values) {
 			if (pkg is ExternalPackage == false) {
@@ -1362,8 +1401,8 @@ public class Valadoc.IndexGenerator : Valadoc.ValadocOrgDoclet {
 
 			string index = Path.build_path (Path.DIR_SEPARATOR_S, output_directory, "index.htm");
 			generator.generate (index);
-
 			generator.generate_configs (output_directory);
+			generator.generate_json (output_directory);
 
 			if (reporter.errors > 0) {
 				return -1;