[PORT TG][TOOLS][UNIT-TEST] Ports AutoWiki. coding cataloging the redux esquire

.github/workflows/autowiki.yml

@@ -0,0 +1,49 @@
+name: Autowiki
+on:
+  schedule:
+  - cron: "5 4 * * *"
+  workflow_dispatch:
+permissions:
+  contents: read
+
+jobs:
+  autowiki:
+    runs-on: ubuntu-20.04
+    steps:
+    - name: "Check for AUTOWIKI_USERNAME"
+      id: secrets_set
+      env:
+        ENABLER_SECRET: ${{ secrets.AUTOWIKI_USERNAME }}
+      run: |
+        unset SECRET_EXISTS
+        if [ -n "$ENABLER_SECRET" ]; then SECRET_EXISTS=true ; fi
+        echo "SECRETS_ENABLED=$SECRET_EXISTS" >> $GITHUB_OUTPUT
+    - name: Checkout
+      if: steps.secrets_set.outputs.SECRETS_ENABLED
+      uses: actions/checkout@v4
+    - name: Restore BYOND cache
+      if: steps.secrets_set.outputs.SECRETS_ENABLED
+      uses: actions/cache@v4
+      with:
+        path: ~/BYOND
+        key: ${{ runner.os }}-byond-${{ hashFiles('dependencies.sh') }}
+    - name: Install rust-g
+      if: steps.secrets_set.outputs.SECRETS_ENABLED
+      run: |
+        bash tools/ci/install_rust_g.sh
+    - name: Compile and generate Autowiki files
+      if: steps.secrets_set.outputs.SECRETS_ENABLED
+      run: |
+        bash tools/ci/install_byond.sh
+        source $HOME/BYOND/byond/bin/byondsetup
+        tools/build/build --ci autowiki
+    - name: Run Autowiki
+      if: steps.secrets_set.outputs.SECRETS_ENABLED
+      env:
+        USERNAME: ${{ secrets.AUTOWIKI_USERNAME }}
+        PASSWORD: ${{ secrets.AUTOWIKI_PASSWORD }}
+      run: |
+        cd tools/autowiki
+        npm install
+        cd ../..
+        node tools/autowiki/autowiki.js data/autowiki_edits.txt data/autowiki_files/

.gitignore

@@ -225,3 +225,6 @@ tools/MapAtmosFixer/MapAtmosFixer/bin/*
 
 # Running OpenDream locally
 tgstation.json
+
+# Autowiki
+/tools/autowiki/node_modules

code/_compile_options.dm

@@ -23,6 +23,10 @@
 // If this is uncommented, we do a single run though of the game setup and tear down process with unit tests in between
 //#define UNIT_TESTS
 
+/// If this is uncommented, Autowiki will generate edits and shut down the server.
+/// Prefer the autowiki build target instead.
+// #define AUTOWIKI
+
 // If defined, we will NOT defer asset generation till later in the game, and will instead do it all at once, during initiialize
 //#define DO_NOT_DEFER_ASSETS
 

code/controllers/configuration/config_entry.dm

@@ -14,7 +14,6 @@
 	var/modified = FALSE	//set to TRUE if the default has been overridden by a config entry
 
 	var/deprecated_by	//the /datum/config_entry type that supercedes this one
-
 	var/protection = NONE
 	var/abstract_type = /datum/config_entry	//do not instantiate if type matches this
 

code/controllers/subsystem/processing/station.dm

@@ -19,7 +19,8 @@ PROCESSING_SUBSYSTEM_DEF(station)
 /datum/controller/subsystem/processing/station/Initialize(timeofday)
 
 	//If doing unit tests we don't do none of that trait shit ya know?
-	#ifndef UNIT_TESTS
+	// Autowiki also wants consistent outputs, for example making sure the vending machine page always reports the normal products
+	#if !defined(UNIT_TESTS) && !defined(AUTOWIKI)
 	SetupTraits()
 	PrepareReport()
 	#endif

code/game/mecha/mech_fabricator.dm

@@ -258,7 +258,7 @@
 
 	var/list/part = list(
 		"name" = D.name,
-		"desc" = initial(built_item.desc),
+		"desc" = D.get_description(),
 		"printTime" = get_construction_time_w_coeff(initial(D.construction_time))/10,
 		"cost" = cost,
 		"id" = D.id,
@@ -272,7 +272,7 @@
 /**
   * Generates a list of resources / materials available to this Exosuit Fab
   *
-  * Returns null if there is no material container available.
+  * Returns null if there is no material container available.B
   * List format is list(material_name = list(amount = ..., ref = ..., etc.))
   */
 /obj/machinery/mecha_part_fabricator/proc/output_available_resources()

code/game/world.dm

@@ -87,6 +87,10 @@ GLOBAL_VAR(restart_counter)
 	HandleTestRun()
 #endif
 
+#ifdef AUTOWIKI
+	setup_autowiki()
+#endif
+
 /world/proc/HandleTestRun()
 	//trigger things to run the whole process
 	Master.sleep_offline_after_initializations = FALSE

code/modules/autowiki/autowiki.dm

@@ -0,0 +1,33 @@
+/// When the `AUTOWIKI` define is enabled, will generate an output file for tools/autowiki/autowiki.js to consume.
+/// Autowiki code intentionally still *exists* even without the define, to ensure developers notice
+/// when they break it immediately, rather than until CI or worse, call time.
+#if defined(AUTOWIKI) || defined(UNIT_TESTS)
+/proc/setup_autowiki()
+	Master.sleep_offline_after_initializations = FALSE
+	SSticker.OnRoundstart(CALLBACK(GLOBAL_PROC, GLOBAL_PROC_REF(generate_autowiki)))
+	SSticker.start_immediately = TRUE
+	CONFIG_SET(number/round_end_countdown, 0)
+
+/proc/generate_autowiki()
+	var/output = generate_autowiki_output()
+	rustg_file_write(output, "data/autowiki_edits.txt")
+	qdel(world)
+#endif
+
+/// Returns a string of the autowiki output file
+/proc/generate_autowiki_output()
+	var/total_output = ""
+
+	for (var/datum/autowiki/autowiki_type as anything in subtypesof(/datum/autowiki))
+		var/datum/autowiki/autowiki = new autowiki_type
+		var/output = autowiki.generate()
+
+		if (!istext(output))
+			CRASH("[autowiki_type] does not generate a proper output!")
+
+		total_output += json_encode(list(
+			"title" = autowiki.page,
+			"text" = output,
+		)) + "\n"
+
+	return total_output

code/modules/autowiki/pages/base.dm

@@ -0,0 +1,54 @@
+/// A representation of an automated wiki page.
+/datum/autowiki
+	/// The page on the wiki to be replaced.
+	/// This should never be a user-facing page, like "Guide to circuits".
+	/// It should always be a template that only Autowiki should touch.
+	/// For example: "Template:Autowiki/CircuitInfo".
+	var/page
+
+/// Override and return the new text of the page.
+/// This proc can be impure, usually to call `upload_file`.
+/datum/autowiki/proc/generate()
+	SHOULD_CALL_PARENT(FALSE)
+	CRASH("[type] does not implement generate()!")
+
+/// Generates an auto formatted template user.
+/// Your autowiki should ideally be a *lot* of these.
+/// It lets wiki editors edit it much easier later, without having to enter repo.
+/// Parameters will be passed in by name. That means your template should expect
+/// something that looks like `{{ Autowiki_Circuit|name=Combiner|description=This combines }}`
+/// Lists, which must be array-like (no keys), will be turned into a flat list with their key and a number,
+/// such that list("food" = list("fruit", "candy")) -> food1=fruit|food2=candy
+/datum/autowiki/proc/include_template(name, parameters)
+	var/template_text = "{{[name]"
+
+	var/list/prepared_parameters = list()
+	for (var/key in parameters)
+		var/value = parameters[key]
+		if (islist(value))
+			for (var/index in 1 to length(value))
+				prepared_parameters["[key][index]"] = "[value[index]]"
+		else
+			prepared_parameters[key] = value
+
+	for (var/parameter_name in prepared_parameters)
+		template_text += "|[parameter_name]="
+		template_text += "[prepared_parameters[parameter_name]]"
+
+	template_text += "}}"
+
+	return template_text
+
+/// Takes an icon and uploads it to Autowiki-name.png.
+/// Do your best to make sure this is unique, so it doesn't clash with other autowiki icons.
+/datum/autowiki/proc/upload_icon(icon/icon, name)
+	// Fuck you
+	if (IsAdminAdvancedProcCall())
+		return
+
+	fcopy(icon, "data/autowiki_files/[name].png")
+
+/// Escape a parameter such that it can be correctly put inside a wiki output
+/datum/autowiki/proc/escape_value(parameter)
+	// | is a special character in MediaWiki, and must be escaped by...using another template.
+	return replacetextEx(parameter, "|", "{{!}}")

code/modules/autowiki/pages/vending.dm

@@ -0,0 +1,56 @@
+/datum/autowiki/vending
+	page = "Template:Autowiki/Content/VendingMachines"
+
+/datum/autowiki/vending/generate()
+	var/output = ""
+
+	var/list/cached_products = list()
+
+	// `powered()` checks if its in a null loc to say it's not powered.
+	// So we put it inside, something
+	var/obj/parent = new
+
+	for (var/vending_type in sort_list(subtypesof(/obj/machinery/vending), GLOBAL_PROC_REF(cmp_typepaths_asc)))
+		var/obj/machinery/vending/vending_machine = new vending_type(parent)
+		vending_machine.use_power = FALSE
+		vending_machine.update_icon(UPDATE_ICON_STATE)
+
+		// Technically won't match if product amounts change, but this isn't likely
+		var/products_cache_key = vending_machine.products.Join("-") + "&" + vending_machine.contraband.Join("-") + "&" + vending_machine.premium.Join("-")
+
+		// In the future, this should show all vending machines that have the same products
+		if (products_cache_key in cached_products)
+			qdel(vending_machine)
+			continue
+
+		cached_products += products_cache_key
+
+		var/filename = SANITIZE_FILENAME(escape_value(format_text(vending_machine.name)))
+
+		output += include_template("Autowiki/VendingMachine", list(
+			"icon" = escape_value(filename),
+			"name" = escape_value(format_text(vending_machine.name)),
+			"products" = format_product_list(vending_machine.products),
+			"contraband" = format_product_list(vending_machine.contraband),
+			"premium" = format_product_list(vending_machine.premium),
+		))
+
+		// It would be cool to make this support gifs someday, but not now
+		upload_icon(getFlatIcon(vending_machine, no_anim = TRUE), filename)
+
+		qdel(vending_machine)
+
+	qdel(parent)
+
+	return output
+
+/datum/autowiki/vending/proc/format_product_list(list/product_list)
+	var/output = ""
+
+	for (var/obj/product_path as anything in product_list)
+		output += include_template("Autowiki/VendingMachineProduct", list(
+			"name" = escape_value(capitalize(format_text(initial(product_path.name)))),
+			"amount" = product_list[product_path],
+		))
+
+	return output

code/modules/research/designs.dm

@@ -22,7 +22,7 @@ other types of metals and chemistry for reagents).
 
 /datum/design						//Datum for object designs, used in construction
 	var/name = "Name"					//Name of the created object.
-	var/desc = "Desc"					//Description of the created object.
+	var/desc = null					//Description of the created object.
 	var/id = DESIGN_ID_IGNORE						//ID of the created object for easy refernece. Alphanumeric, lower-case, no symbols
 	var/build_type = null				//Flag as to what kind machine the design is built in. See defines.
 	var/list/materials = list()			//List of materials. Format: "id" = amount.
@@ -67,6 +67,12 @@ other types of metals and chemistry for reagents).
 	sheet.send(user)
 	return sheet.icon_tag(id)
 
+/// Returns the description of the design
+/datum/design/proc/get_description()
+	var/obj/object_build_item_path = build_path
+
+	return isnull(desc) ? initial(object_build_item_path.desc) : desc
+
 ////////////////////////////////////////
 //Disks for transporting design datums//
 ////////////////////////////////////////

code/modules/research/stock_parts.dm

@@ -14,6 +14,7 @@ If you create T5+ please take a pass at gene_modder.dm [L40]. Max_values MUST fi
 	var/pshoom_or_beepboopblorpzingshadashwoosh = 'sound/items/rped.ogg'
 	var/alt_sound = null
 
+
 /obj/item/storage/part_replacer/pre_attack(obj/machinery/T, mob/living/user, params)
 	if(!istype(T) || (!T.component_parts && !T.works_with_rped_anyways))
 		return ..()
@@ -125,6 +126,8 @@ If you create T5+ please take a pass at gene_modder.dm [L40]. Max_values MUST fi
 	icon = 'icons/obj/stock_parts.dmi'
 	w_class = WEIGHT_CLASS_SMALL
 	var/rating = 1
+	///The generic category type that the stock part belongs to.  Generic objects that should not be instantiated should have the same type and abstract_type
+	var/abstract_type = /obj/item/stock_parts
 
 /obj/item/stock_parts/Initialize(mapload)
 	. = ..()
@@ -290,6 +293,11 @@ If you create T5+ please take a pass at gene_modder.dm [L40]. Max_values MUST fi
 
 // Subspace stock parts
 
+/obj/item/stock_parts/subspace
+	name = "subspace stock part"
+	desc = "What?"
+	abstract_type = /obj/item/stock_parts/subspace
+
 /obj/item/stock_parts/subspace/ansible
 	name = "subspace ansible"
 	icon_state = "subspace_ansible"

code/modules/research/techweb/_techweb_node.dm

@@ -18,11 +18,15 @@
 	var/ui_x = 805 // It's location - override this in techweb_layout.dm
 	var/ui_y = 805
 
+	/// Whether or not this node should show on the wiki
+	var/show_on_wiki = TRUE
+
 /datum/techweb_node/error_node
 	id = "ERROR"
 	display_name = "ERROR"
 	description = "This usually means something in the database has corrupted. If it doesn't go away automatically, inform Central Command for their techs to fix it ASAP(tm)"
-
+	show_on_wiki = FALSE
+
 /datum/techweb_node/proc/Initialize()
 	//Make lists associative for lookup
 	for(var/id in prereq_ids)

code/modules/unit_tests/_unit_tests.dm

@@ -89,6 +89,7 @@
 #include "timer_sanity.dm"
 #include "trait_addition_and_removal.dm"
 #include "unit_test.dm"
+#include "autowiki.dm"
 
 #undef TEST_ASSERT
 #undef TEST_ASSERT_EQUAL

code/modules/unit_tests/autowiki.dm

@@ -0,0 +1,35 @@
+/// Tests that all autowikis generate something without runtiming
+/datum/unit_test/autowiki
+
+/datum/unit_test/autowiki/Run()
+	TEST_ASSERT(istext(generate_autowiki_output()), "generate_autowiki_output() did not finish successfully!")
+
+/// Test that `include_template` produces reasonable results
+/datum/unit_test/autowiki_include_template
+
+/datum/unit_test/autowiki_include_template/Run()
+	var/datum/autowiki/autowiki_api = new
+
+	TEST_ASSERT_EQUAL( \
+		autowiki_api.include_template("Template"), \
+		"{{Template}}", \
+		"Basic template did not format correctly" \
+	)
+
+	TEST_ASSERT_EQUAL( \
+		autowiki_api.include_template("Template", list("name" = "Mothblocks")), \
+		"{{Template|name=Mothblocks}}", \
+		"Template with basic arguments did not format correctly" \
+	)
+
+	TEST_ASSERT_EQUAL( \
+		autowiki_api.include_template("Template", list("name" = autowiki_api.escape_value("P|peline"))), \
+		"{{Template|name=P{{!}}peline}}", \
+		"Template with escaped arguments did not format correctly" \
+	)
+
+	TEST_ASSERT_EQUAL( \
+		autowiki_api.include_template("Template", list("food" = list("fruit", "candy"))), \
+		"{{Template|food1=fruit|food2=candy}}", \
+		"Template with array arguments did not format correctly" \
+	)