From 08cc320d34b68c279288eee82fb729b2157a0c04 Mon Sep 17 00:00:00 2001
From: Jeremy Ruston <jeremy@jermolene.com>
Date: Tue, 21 May 2024 11:21:36 +0100
Subject: [PATCH] Add tests that the core plugins all have a valid stability
 field

---
 core/modules/commands/makelibrary.js         | 27 +----------
 core/modules/utils/repository.js             | 48 ++++++++++++++++++++
 editions/test/tiddlers/tests/test-plugins.js | 44 ++++++++++++++++++
 plugins/tiddlywiki/tw5.com-docs/plugin.info  |  2 +-
 plugins/tiddlywiki/tw5.com-docs/readme.tid   |  7 +++
 5 files changed, 101 insertions(+), 27 deletions(-)
 create mode 100644 core/modules/utils/repository.js
 create mode 100644 editions/test/tiddlers/tests/test-plugins.js
 create mode 100644 plugins/tiddlywiki/tw5.com-docs/readme.tid

diff --git a/core/modules/commands/makelibrary.js b/core/modules/commands/makelibrary.js
index 36a1399a2..3af2e4943 100644
--- a/core/modules/commands/makelibrary.js
+++ b/core/modules/commands/makelibrary.js
@@ -27,33 +27,8 @@ var Command = function(params,commander,callback) {
 
 Command.prototype.execute = function() {
 	var wiki = this.commander.wiki,
-		fs = require("fs"),
-		path = require("path"),
 		upgradeLibraryTitle = this.params[0] || UPGRADE_LIBRARY_TITLE,
-		tiddlers = {};
-	// Collect up the library plugins
-	var collectPlugins = function(folder) {
-			var pluginFolders = $tw.utils.getSubdirectories(folder) || [];
-			for(var p=0; p<pluginFolders.length; p++) {
-				if(!$tw.boot.excludeRegExp.test(pluginFolders[p])) {
-					pluginFields = $tw.loadPluginFolder(path.resolve(folder,"./" + pluginFolders[p]));
-					if(pluginFields && pluginFields.title) {
-						tiddlers[pluginFields.title] = pluginFields;
-					}
-				}
-			}
-		},
-		collectPublisherPlugins = function(folder) {
-			var publisherFolders = $tw.utils.getSubdirectories(folder) || [];
-			for(var t=0; t<publisherFolders.length; t++) {
-				if(!$tw.boot.excludeRegExp.test(publisherFolders[t])) {
-					collectPlugins(path.resolve(folder,"./" + publisherFolders[t]));
-				}
-			}
-		};
-	$tw.utils.each($tw.getLibraryItemSearchPaths($tw.config.pluginsPath,$tw.config.pluginsEnvVar),collectPublisherPlugins);
-	$tw.utils.each($tw.getLibraryItemSearchPaths($tw.config.themesPath,$tw.config.themesEnvVar),collectPublisherPlugins);
-	$tw.utils.each($tw.getLibraryItemSearchPaths($tw.config.languagesPath,$tw.config.languagesEnvVar),collectPlugins);
+		tiddlers = $tw.utils.getAllPlugins();
 	// Save the upgrade library tiddler
 	var pluginFields = {
 		title: upgradeLibraryTitle,
diff --git a/core/modules/utils/repository.js b/core/modules/utils/repository.js
new file mode 100644
index 000000000..643f3f483
--- /dev/null
+++ b/core/modules/utils/repository.js
@@ -0,0 +1,48 @@
+/*\
+title: $:/core/modules/utils/repository.js
+type: application/javascript
+module-type: utils
+
+Utilities for working with the TiddlyWiki repository file structure
+
+\*/
+(function(){
+
+/*jslint node: true, browser: true */
+/*global $tw: false */
+"use strict";
+
+/*
+Get an object containing all the plugins as a hashmap by title of the JSON representation of the plugin
+*/
+exports.getAllPlugins = function() {
+	var fs = require("fs"),
+		path = require("path"),
+		tiddlers = {};
+	// Collect up the library plugins
+	var collectPlugins = function(folder) {
+			var pluginFolders = $tw.utils.getSubdirectories(folder) || [];
+			for(var p=0; p<pluginFolders.length; p++) {
+				if(!$tw.boot.excludeRegExp.test(pluginFolders[p])) {
+					var pluginFields = $tw.loadPluginFolder(path.resolve(folder,"./" + pluginFolders[p]));
+					if(pluginFields && pluginFields.title) {
+						tiddlers[pluginFields.title] = pluginFields;
+					}
+				}
+			}
+		},
+		collectPublisherPlugins = function(folder) {
+			var publisherFolders = $tw.utils.getSubdirectories(folder) || [];
+			for(var t=0; t<publisherFolders.length; t++) {
+				if(!$tw.boot.excludeRegExp.test(publisherFolders[t])) {
+					collectPlugins(path.resolve(folder,"./" + publisherFolders[t]));
+				}
+			}
+		};
+	$tw.utils.each($tw.getLibraryItemSearchPaths($tw.config.pluginsPath,$tw.config.pluginsEnvVar),collectPublisherPlugins);
+	$tw.utils.each($tw.getLibraryItemSearchPaths($tw.config.themesPath,$tw.config.themesEnvVar),collectPublisherPlugins);
+	$tw.utils.each($tw.getLibraryItemSearchPaths($tw.config.languagesPath,$tw.config.languagesEnvVar),collectPlugins);
+	return tiddlers;
+};
+
+})();
diff --git a/editions/test/tiddlers/tests/test-plugins.js b/editions/test/tiddlers/tests/test-plugins.js
new file mode 100644
index 000000000..e045e8928
--- /dev/null
+++ b/editions/test/tiddlers/tests/test-plugins.js
@@ -0,0 +1,44 @@
+/*\
+title: test-plugins.js
+type: application/javascript
+tags: [[$:/tags/test-spec]]
+
+Tests for integrity of the core plugins, languages, themes and editions
+
+\*/
+(function(){
+
+/*jslint node: true, browser: true */
+/*global $tw: false */
+"use strict";
+
+describe("Plugin tests", function() {
+
+	// Get all the plugins as a hashmap by title of a JSON string with the plugin content
+	var tiddlers = $tw.utils.getAllPlugins();
+	// console.log(JSON.stringify(Object.keys(tiddlers),null,4));
+	describe("every plugin should have the required standard fields", function() {
+		var titles = Object.keys(tiddlers);
+		$tw.utils.each(titles,function(title) {
+			it("plugin " + title + " should have the required standard fields",function() {
+				var fields = tiddlers[title];
+				expect(fields["plugin-type"]).toMatch(/^(?:plugin|language|theme)$/);
+				switch(fields["plugin-type"]) {
+					case "plugin":
+						expect(!!(fields.name && fields.description && fields.list)).toEqual(true);
+						expect(fields.stability).toMatch(/^(?:STABILITY_0_DEPRECATED|STABILITY_1_EXPERIMENTAL|STABILITY_2_STABLE|STABILITY_3_LEGACY)$/);
+						break;
+					case "language":
+						expect(!!(fields.name && fields.description)).toEqual(true);
+						break;
+					case "theme":
+						expect(!!(fields.name && fields.description)).toEqual(true);
+						break;
+					}
+			});
+		});
+	});
+
+});
+
+})();
diff --git a/plugins/tiddlywiki/tw5.com-docs/plugin.info b/plugins/tiddlywiki/tw5.com-docs/plugin.info
index 98f558646..e81d70592 100644
--- a/plugins/tiddlywiki/tw5.com-docs/plugin.info
+++ b/plugins/tiddlywiki/tw5.com-docs/plugin.info
@@ -2,6 +2,6 @@
 	"title": "$:/plugins/tiddlywiki/tw5.com-docs",
 	"name": "TW5.com Docs",
 	"description": "Documentation from tiddlywiki.com",
-	"list": "",
+	"list": "readme",
 	"stability": "STABILITY_1_EXPERIMENTAL"
 }
diff --git a/plugins/tiddlywiki/tw5.com-docs/readme.tid b/plugins/tiddlywiki/tw5.com-docs/readme.tid
new file mode 100644
index 000000000..044ac24c0
--- /dev/null
+++ b/plugins/tiddlywiki/tw5.com-docs/readme.tid
@@ -0,0 +1,7 @@
+title $:/plugins/tiddlywiki/tw5.com-docs/readme
+
+This is an experimental packaging of the documentation from tiddlywiki.com into a plugin.
+
+It is currently not fully functional:
+
+* Listings of tiddlers don't always work because the docs tiddlers are now shadow tiddlers